Java 中如何实现 WebSocket 通信

WebSocket 是一种在单个 TCP 连接上进行全双工通信的协议，相较于传统的 HTTP 协议，它减少了通信开销，更适合需要实时数据传输的场景。在 Java 中，实现 WebSocket 通信可以通过各种库和框架来实现，为开发者提供了便捷的方式来构建实时应用。

使用场景

WebSocket 通信在以下场景中特别有用：

实时通知和消息推送： 适用于需要向客户端发送实时通知或消息推送的应用，如在线聊天、实时股票行情等。
在线协作： 在协作工具中，实时更新用户编辑的内容，确保所有参与者看到最新的更改。
在线游戏： 提供实时的游戏状态更新和多人游戏中的实时交互。

WebSocket 调试工具

要调试 WebSocket，那就需要一个好的调试工具，这里我比较推荐 Apifox。它支持调试 http（s）、WebSocket、Socket、gRPC、Dubbo 等多种协议的接口，这使得它成为了一个非常全面的接口测试工具！

立即体验 Apifox

基本语法

在 Java 中实现 WebSocket 通信通常涉及以下几个核心概念：

Endpoint： 表示 WebSocket 的端点，处理连接的打开、关闭和消息的收发。
Session： 表示与客户端的一次连接，通过它可以发送消息给客户端。
Decoder 和 Encoder： 用于将消息在 WebSocket 连接中进行编码和解码。

常用方法

在 Java 中实现 WebSocket 通信涉及到一些常用的方法，以下是这些方法的详细介绍以及示例代码。

方法 1：使用 Java API 实现 WebSocket

@ServerEndpoint 注解

@ServerEndpoint注解用于标识 WebSocket 的 Endpoint，指定客户端连接的 URL 路径。

@ServerEndpoint("/websocket")
public class MyWebSocket {

    @OnOpen
    public void onOpen(Session session) {
        // 处理连接建立逻辑
    }

    @OnMessage
    public void onMessage(String message, Session session) {
        // 处理收到消息的逻辑
    }

    @OnClose
    public void onClose(Session session) {
        // 处理连接关闭逻辑
    }
}

@ServerEndpoint("/websocket")：指定 WebSocket 连接的 URL 路径为/websocket。
@OnOpen：标识在连接建立时调用的方法，可以在这里执行连接建立后的逻辑。
@OnMessage：标识在接收到消息时调用的方法，可以在这里处理收到的消息。
@OnClose：标识在连接关闭时调用的方法，可以在这里执行连接关闭后的逻辑。

在 Java 中创建 WebSocket 客户端

你可以使用 Java 的Session对象来发送消息给客户端。下面是一个简单的例子：

@OnMessage
public void onMessage(String message, Session session) {
    // 处理收到消息的逻辑
    try {
        // 向客户端发送消息
        session.getBasicRemote().sendText("Server: " + message);
    } catch (IOException e) {
        e.printStackTrace();
    }
}

方法 2：使用 Spring 框架实现 WebSocket

WebSocketConfigurer 和 WebSocketHandlerRegistry

WebSocketConfigurer是 Spring 框架中用于配置 WebSocket 的接口，WebSocketHandlerRegistry用于注册 WebSocket 处理器。

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(new MyWebSocketHandler(), "/websocket")
                .setAllowedOrigins("*");
    }
}

@Configuration：表明这是一个配置类。
@EnableWebSocket：启用 WebSocket 支持。
registry.addHandler(new MyWebSocketHandler(), "/websocket")：注册 WebSocket 处理器MyWebSocketHandler，并指定连接的 URL 路径为/websocket。
.setAllowedOrigins("*")：允许所有来源的跨域请求。

MyWebSocketHandler

在MyWebSocketHandler中，你可以重写WebSocketHandler接口的方法来处理连接建立、消息接收和连接关闭等事件。

public class MyWebSocketHandler implements WebSocketHandler {

    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        // 处理连接建立逻辑
    }

    @Override
    public void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        // 处理收到文本消息的逻辑
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
        // 处理连接关闭逻辑
    }
}

方法 3：使用 Netty 框架实现 WebSocket

Netty 是一个强大的网络编程框架，也支持 WebSocket。以下是一个简化的 Netty 实现 WebSocket 的例子：

// Netty的WebSocket实现略

在实际项目中，你可以使用 Netty 提供的WebSocketServerHandler等类来处理 WebSocket 的相关事件，从而实现 WebSocket 通信。

在 Apifox 中调试 WebSocket

如果你要调试 WebSocket 接口，并确保你的应用程序能够正常工作。这时，一个强大的接口测试工具就会派上用场。

Apifox 是一个比 Postman 更强大的接口测试工具，Apifox = Postman + Swagger + Mock + JMeter。它支持调试 http（s）、WebSocket、Socket、gRPC、Dubbo 等多种协议的接口，这使得它成为了一个非常全面的接口测试工具，所以强烈推荐去下载体验！以下是在 Apifox 中调试 WebSocket 接口的示例。

首先在 Apifox 中新建一个 HTTP 项目，然后在项目中添加 WebSocket 接口。

立即体验 Apifox