SpringBoot 构建 WebSocket

项目中有需要使用到 WebSocket，这里记录一下：

添加依赖坐标，除了基本的 spring-boot-starter-web依赖之外，还需要添加一个 websocket相关的依赖：

<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>

添加 Configurer配置类，将 websocket 访问路径入口与 handler绑定：

// 添加 @EnableWebSocket 启用
@Configuration
@EnableWebSocket
public class CmdWebSocketConfigurer implements WebSocketConfigurer {
    @Autowired
    ConsoleWebSocketHandler webSocketHandler;
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry webSocketHandlerRegistry) {
        // 我这里将自定义的 Handler 绑定到了/console 路径上了
        webSocketHandlerRegistry.addHandler(webSocketHandler, "/console");
    }
}

创建上面配置的自定义的 ConsoleWebSocketHandler，实现业务逻辑的编写：

@Component
public class ConsoleWebSocketHandler extends TextWebSocketHandler {
      // 在连接建立后会调用该方法
      public void afterConnectionEstablished(WebSocketSession session);
      // 将传入的消息当做 text 文本进行处理
      protected void handleTextMessage(WebSocketSession session, TextMessage message);
      // 处理 ping 值消息
      protected void handlePongMessage(WebSocketSession session, PongMessage message);
      // 处理传输错误
      public void handleTransportError(WebSocketSession session, Throwable exception);
      // 在连接关闭后调用该方法
      public void afterConnectionClosed(WebSocketSession session, CloseStatus status);
}

我们可以将 WebSocketSession 保存下来，在之后通过这个对象给用户主动推送一些消息：

public interface WebSocketSession;
// 调用该方法主动推送消息
void sendMessage(WebSocketMessage<?> message);
// 调用该方法关闭连接 
void close() throws IOException;

在前端连接时，我们可以通过下面的代码建立连接：

//建立webSocket连接
websocket = new WebSocket("ws://" + window.location.host + "/console");
//打开webSokcet连接时，回调该函数
websocket.onopen = () => console.log("连接建立");
//关闭webSocket连接时，回调该函数
websocket.onclose = () => console.log("连接关闭");
//接收信息
websocket.onmessage = function(res) {
    console.log("接收到消息");
}

参考资料

SpringBoot 实现 Websocket 通信详解
WebSocket-SockJS