引言

在构建实时Web应用时，WebSocket提供了一种持久化、双向通信的通道，极大地提升了前后端交互的效率。Spring Boot 2.x版本为开发者提供了便捷的WebSocket支持，通过WebSocketHandlerRegistry类中的addHandler方法，我们可以轻松注册自定义的WebSocket处理器以处理客户端连接和消息。

本文将深入探讨Spring Boot 环境中如何正确使用WebSocketHandlerRegistry#addHandler方法来配置并管理WebSocket服务。

一、WebSocket基础与Spring Boot集成

在Spring Boot中启用WebSocket功能，首先需要在配置类上添加@EnableWebSocket注解，并实现WebSocketConfigurer接口。在实现该接口的过程中，我们将主要关注registerWebSocketHandlers(WebSocketHandlerRegistry registry)方法，它为我们提供了一个注册WebSocket处理器的入口。

import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        // 在这里注册WebSocket处理器
    }
}

二、WebSocketHandlerRegistry#addHandler方法详解

WebSocketHandlerRegistry#addHandler(WebSocketHandler handler, String mapping) 方法用于向服务器注册一个自定义的WebSocket处理器以及其对应的URL映射路径。

• WebSocketHandler参数： 这个参数是实现org.springframework.web.socket.WebSocketHandler接口的类实例，例如继承自TextWebSocketHandler或BinaryWebSocketHandler的自定义类。这个处理器负责处理WebSocket会话的生命周期事件（如打开、关闭）以及接收到的消息。

public class CustomWebSocketHandler extends TextWebSocketHandler {
    // 实现相关的方法以处理WebSocket连接及消息
}

• mapping参数： 这是一个字符串类型的参数，表示WebSocket客户端连接服务器时使用的URL路径。此路径应遵循HTTP URL的基本规则，并且对于同一服务器上的不同WebSocket处理器来说，应该保持唯一性。

registry.addHandler(new CustomWebSocketHandler(), "/custom-ws-endpoint");

在这个例子中，当前端创建WebSocket连接时，需要指向 /custom-ws-endpoint 路径，后端就会使用CustomWebSocketHandler来处理相关的连接和消息。

三、额外配置选项

WebSocketHandlerRegistry#addHandler方法还有其他可选参数，以便进行更精细的配置：

• setAllowedOrigins(String... origins)：设置允许跨域访问的源地址列表。
• setHandshakeHandler(...)：设置自定义的握手处理器，用于控制WebSocket连接建立过程中的行为。
• setInterceptors(...)：添加拦截器链，对WebSocket连接请求和响应进行预处理和后处理。
• setTransportHandler(...)：设置自定义的传输层处理器，用于特殊场景下的数据传输。

四、示例代码

结合上述内容，以下是一个完整的WebSocket配置示例：

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        // 注册自定义WebSocket处理器
        registry.addHandler(new CustomWebSocketHandler(), "/ws/custom")
                .setAllowedOrigins("*") // 允许所有来源发起的WebSocket连接
                .addInterceptors(new MyWebSocketInterceptor()); // 添加自定义拦截器
    }

    // 自定义WebSocket处理器
    public static class CustomWebSocketHandler extends TextWebSocketHandler {
        // ...
    }

    // 自定义WebSocket拦截器
    public static class MyWebSocketInterceptor implements HandshakeInterceptor {
        // ...
    }
}

小结

总结起来，在Spring Boot中利用WebSocketHandlerRegistry#addHandler方法可以方便地管理和配置WebSocket服务，确保其能够高效、安全地服务于实时Web应用程序。通过合理设置WebSocket处理器及其映射路径，我们可以在不同的业务场景下灵活部署和扩展WebSocket服务。