HoRain云--Java WebSocket全双工通信实战指南-育师

import jakarta.websocket.*; import jakarta.websocket.server.ServerEndpoint; import java.io.IOException; import java.util.Collections; import java.util.HashSet; import java.util.Set; @ServerEndpoint("/echo") // 指定客户端连接的端点 URI public class EchoServer { // 使用线程安全的Set来管理所有客户端会话，便于广播等操作 private static Set<Session> clientSessions = Collections.synchronizedSet(new HashSet<>()); @OnOpen public void onOpen(Session session) { clientSessions.add(session); System.out.println("有新客户端连接，会话ID: " + session.getId()); } @OnMessage public void onMessage(String receivedMessage, Session session) throws IOException { System.out.println("收到来自客户端 [" + session.getId() + "] 的消息: " + receivedMessage); // 构造回复消息 String reply = "服务器回声: " + receivedMessage; // 发送回复给发送此消息的客户端 session.getBasicRemote().sendText(reply); // 示例：广播消息给所有连接的客户端 // broadcastMessage("客户端 " + session.getId() + " 说: " + receivedMessage); } @OnClose public void onClose(Session session) { clientSessions.remove(session); System.out.println("客户端断开连接，会话ID: " + session.getId()); } @OnError public void onError(Session session, Throwable error) { System.err.println("与会话 [" + session.getId() + "] 通信时发生错误:"); error.printStackTrace(); } // 辅助方法：向所有连接的客户端广播消息 private void broadcastMessage(String message) { synchronized (clientSessions) { // 遍历时需要同步 for (Session s : clientSessions) { if (s.isOpen()) { try { s.getBasicRemote().sendText(message); } catch (IOException e) { e.printStackTrace(); } } } } } }

代码解读与关键点：

@ServerEndpoint("/echo")：将该类声明为一个 WebSocket 服务器端点，客户端通过ws://你的服务器地址/echo来连接。
@OnOpen：当客户端成功建立连接时调用。参数Session代表一个 WebSocket 连接，用于发送消息和管理连接。
@OnMessage：当服务器从客户端收到消息时调用。方法的String参数就是消息内容。
@OnClose：当连接关闭时调用。
@OnError：当通信发生错误时调用。
会话管理：示例中使用一个静态的Set<Session>来保存所有活跃的连接，这在广播消息或向特定客户端发送消息时非常有用。

2. 客户端开发（Java 示例）

除了浏览器中的 JavaScript 客户端，你也可以用 Java 编写客户端。

import jakarta.websocket.*; import java.net.URI; @ClientEndpoint public class JavaWebSocketClient { private Session session; @OnOpen public void onOpen(Session session) { this.session = session; System.out.println("已连接到服务器!"); } @OnMessage public void onMessage(String message) { System.out.println("收到服务器消息: " + message); } @OnClose public void onClose() { System.out.println("与服务器的连接已关闭。"); } // 用于主动发送消息的方法 public void sendMessage(String message) throws Exception { if (session != null && session.isOpen()) { session.getBasicRemote().sendText(message); } } public static void main(String[] args) throws Exception { // 创建WebSocket容器 WebSocketContainer container = ContainerProvider.getWebSocketContainer(); // 服务端端点地址 String serverUri = "ws://localhost:8080/your-app-context/echo"; // 连接到服务器 Session session = container.connectToServer(JavaWebSocketClient.class, URI.create(serverUri)); JavaWebSocketClient client = (JavaWebSocketClient) session.getUserProperties().get(JavaWebSocketClient.class.getName()); // 发送一条测试消息 client.sendMessage("你好，WebSocket服务器！"); // 等待一段时间以便接收回复，然后关闭连接 Thread.sleep(2000); session.close(); } }

🚀 进阶实战：心跳检测与安全

对于生产环境，还需要考虑连接的健壮性和安全性。

1. 实现心跳检测

心跳机制用于检查连接是否仍然有效，并及时清理僵死的连接。

import java.util.concurrent.Executors; import java.util.concurrent.ScheduledExecutorService; import java.util.concurrent.TimeUnit; @ServerEndpoint("/heartbeat-endpoint") public class HeartbeatServer { private Session session; private ScheduledExecutorService heartbeatScheduler = Executors.newSingleThreadScheduledService(); private static final long HEARTBEAT_INTERVAL = 30; // 心跳间隔30秒 @OnOpen public void onOpen(Session session) { this.session = session; startHeartbeat(); } private void startHeartbeat() { // 每隔一段时间发送一次Ping heartbeatScheduler.scheduleAtFixedRate(() -> { if (session != null && session.isOpen()) { try { session.getBasicRemote().sendPing(java.nio.ByteBuffer.wrap("PING".getBytes())); System.out.println("向客户端发送Ping"); } catch (IOException e) { System.err.println("发送Ping失败: " + e.getMessage()); heartbeatScheduler.shutdown(); } } }, HEARTBEAT_INTERVAL, HEARTBEAT_INTERVAL, TimeUnit.SECONDS); } // 客户端应响应Pong消息。也可以服务器端监听Pong，若超时未收到则判定连接失效。 // ... @OnMessage 等其他方法 }

2. 启用安全连接

在生产环境中，务必使用安全的 WebSocket 连接。

服务端配置：在 Tomcat 等服务器中配置 SSL/TLS 证书。
客户端连接：将连接地址中的ws://替换为wss://。
可能的身份验证：可以在@OnOpen方法中通过查询参数或 HTTP Header 进行简单的身份验证。

// 客户端连接安全WebSocket的示例 String secureServerUri = "wss://your-secure-domain.com/echo";

💡 部署、测试与常见问题

部署要点

将编写好的 WebSocket 端点类部署到支持 WebSocket 的 Servlet 容器中，例如Tomcat 8.5+、Jetty 9+ 或Undertow。确保项目的pom.xml（如果使用 Maven）包含了正确的依赖。

<!-- 对于 Jakarta EE 9+ --> <dependency> <groupId>jakarta.websocket</groupId> <artifactId>jakarta.websocket-api</artifactId> <version>2.1.0</version> <scope>provided</scope> </dependency>