学习条记053——实现WebSocket

1、Java原生实现

1.1、导入紧张依靠

1. <!-- Java原生代码实现websocket依赖 -->
2. <dependency>
3.     <groupId>org.java-websocket</groupId>
4.     <artifactId>Java-WebSocket</artifactId>
5.     <version>1.5.3</version>
6. </dependency>

复制代码

1.2、继承WebSocketServer

1. import java.net.InetSocketAddress;
2. import java.net.UnknownHostException;
4. import org.java_websocket.WebSocket;
5. import org.java_websocket.handshake.ClientHandshake;
6. import org.java_websocket.server.WebSocketServer;
8. /**
9. * @author HTL
10. * @version 2024-7-8  008
11. * @since JDK8
12. */
13. public class SocketServer extends WebSocketServer {
15.     public SocketServer(int port) throws UnknownHostException {
16.         super(new InetSocketAddress(port));
17.     }
19.     public SocketServer(InetSocketAddress address) {
20.         super(address);
21.     }
23.     @Override
24.     public void onOpen(WebSocket conn, ClientHandshake handshake) {
25.         conn.send("Welcome to the server!"); // This method sends a message to the new client
26.         broadcast("new connection: " + handshake
27.                 .getResourceDescriptor()); // This method sends a message to all clients connected
28.         System.out.println(
29.                 conn.getRemoteSocketAddress().getAddress().getHostAddress() + " entered the room!");
31.     }
33.     @Override
34.     public void onClose(WebSocket conn, int code, String reason, boolean remote) {
35.         broadcast(conn + " has left the room!");
36.         System.out.println(conn + " has left the room!");
37.     }
38.    
40.     @Override
41.     public void onMessage(WebSocket conn, String message) {
42.         broadcast(message);
43.         System.out.println(conn + " 发送数据: " + message);
44.     }
47.     @Override
48.     public void onError(WebSocket conn, Exception ex) {
49.         ex.printStackTrace();
50.         if (conn != null) {
51.             // some errors like port binding failed may not be assignable to a specific
52.             // websocket
53.         }
55.     }
57.     @Override
58.     public void onStart() {
59.         System.out.println("Server started!");
60.         setConnectionLostTimeout(0);
61.         setConnectionLostTimeout(100);
63.     }
65. }

复制代码

1.3、测试

1. import java.io.BufferedReader;
2. import java.io.IOException;
3. import java.io.InputStreamReader;
5. /**
6. * @author HTL
7. * @version 2024-7-8  008
8. * @since JDK8
9. */
10. public class SocketTest {
12.     public static void main(String[] args) throws InterruptedException, IOException {
13.         int port = 8887; // 端口
15.         SocketServer s = new SocketServer(port);
16.         s.start();
17.         System.out.println("ChatServer started on port: " + s.getPort());
19.         BufferedReader sysin = new BufferedReader(new InputStreamReader(System.in));
20.         while (true) {
21.             String in = sysin.readLine();
22.             s.broadcast(in);
23.             if (in.equals("exit")) {
24.                 s.stop(1000);
25.                 break;
26.             }
27.         }
28.     }
30. }

复制代码

1. # 请求地址
2. ws://127.0.0.1:8887

复制代码

2、SpringBoot实现

2.1、导入依靠

1. <!-- 2、SpringBoot实现websocket 依赖 -->
2. <dependency>
3.     <groupId>org.springframework.boot</groupId>
4.     <artifactId>spring-boot-starter-websocket</artifactId>
5. </dependency>

复制代码

2.2、编写配置类

1. import org.springframework.web.socket.WebSocketSession;
2. import java.io.IOException;
3. import java.util.concurrent.ConcurrentHashMap;
5. /**
6. * @author HTL
7. * @version 2024-7-4  004
8. * @since JDK8
9. */
10. public class WsSessionManager {
11.     /**
12.      * 保存连接 session 的地方
13.      */
14.     private static ConcurrentHashMap<String, WebSocketSession> SESSION_POOL = new ConcurrentHashMap<>();
16.     /**
17.      * 添加 session
18.      *
19.      * @param key
20.      */
21.     public static void add(String key, WebSocketSession session) {
22.         // 添加 session
23.         SESSION_POOL.put(key, session);
24.     }
26.     /**
27.      * 删除 session,会返回删除的 session
28.      *
29.      * @param key
30.      * @return
31.      */
32.     public static WebSocketSession remove(String key) {
33.         // 删除 session
34.         return SESSION_POOL.remove(key);
35.     }
37.     /**
38.      * 删除并同步关闭连接
39.      *
40.      * @param key
41.      */
42.     public static void removeAndClose(String key) {
43.         WebSocketSession session = remove(key);
44.         if (session != null) {
45.             try {
46.                 // 关闭连接
47.                 session.close();
48.             } catch (IOException e) {
49.                 // todo: 关闭出现异常处理
50.                 e.printStackTrace();
51.             }
52.         }
53.     }
55.     /**
56.      * 获得 session
57.      *
58.      * @param key
59.      * @return
60.      */
61.     public static WebSocketSession get(String key) {
62.         // 获得 session
63.         return SESSION_POOL.get(key);
64.     }
65. }

复制代码

继承TextWebSocketHandler

1. import org.springframework.stereotype.Component;
2. import org.springframework.web.socket.CloseStatus;
3. import org.springframework.web.socket.TextMessage;
4. import org.springframework.web.socket.WebSocketSession;
5. import org.springframework.web.socket.handler.TextWebSocketHandler;
7. import java.text.SimpleDateFormat;
8. import java.time.LocalDateTime;
9. import java.util.Date;
11. /**
12. * @author HTL
13. * @version 2024-7-4  004
14. * @since JDK8
15. */
16. @Component
17. public class HttpAuthHandler extends TextWebSocketHandler {
19.     /**
20.      * socket 建立成功事件
21.      *
22.      * @param session
23.      * @throws Exception
24.      */
25.     @Override
26.     public void afterConnectionEstablished(WebSocketSession session) throws Exception {
27.         Object sessionId = session.getAttributes().get("session_id");
28.         if (sessionId != null) {
29.             // 用户连接成功，放入在线用户缓存
30.             WsSessionManager.add(sessionId.toString(), session);
31.         } else {
32.             throw new RuntimeException("用户登录已经失效!");
33.         }
34.     }
36.     /**
37.      * 接收消息事件
38.      *
39.      * @param session
40.      * @param message
41.      * @throws Exception
42.      */
43.     @Override
44.     protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
45.         // 获得客户端传来的消息
46.         String payload = message.getPayload();
47.         Object sessionId = session.getAttributes().get("session_id");
48.         SimpleDateFormat myFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
49.         myFormat.format(new Date());
50.         System.out.println(myFormat.format(new Date()) + " ——> server 接收到：" + sessionId + " 发送的内容：" + payload);
51.         session.sendMessage(new TextMessage(myFormat.format(new Date()) + " ——> server 返回给：" + sessionId + " 的消息：" + payload));
52.     }
54.     /**
55.      * socket 断开连接时
56.      *
57.      * @param session
58.      * @param status
59.      * @throws Exception
60.      */
61.     @Override
62.     public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
63.         Object sessionId = session.getAttributes().get("session_id");
64.         if (sessionId != null) {
65.             // 用户退出，移除缓存
66.             WsSessionManager.remove(sessionId.toString());
67.         }
68.     }
71. }

复制代码

实现HandshakeInterceptor

1. import java.util.Map;
3. import org.apache.logging.log4j.util.Strings;
4. import org.springframework.http.server.ServerHttpRequest;
5. import org.springframework.http.server.ServerHttpResponse;
6. import org.springframework.stereotype.Component;
7. import org.springframework.web.socket.WebSocketHandler;
8. import org.springframework.web.socket.server.HandshakeInterceptor;
10. /**
11. * @author HTL
12. * @version 2024-7-4  004
13. * @since JDK8
14. */
15. @Component
16. public class MyInterceptor implements HandshakeInterceptor {
18.     /**
19.      * 握手前
20.      */
21.     @Override
22.     public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String, Object> attributes) throws Exception {
23.         System.out.println("握手开始");
24.         String hostName = request.getRemoteAddress().getHostName();
25.         String sessionId = hostName+String.valueOf((int)(Math.random()*1000));
26.         if (Strings.isNotBlank(sessionId)) {
27.             // 放入属性域
28.             attributes.put("session_id", sessionId);
29.             System.out.println("用户 session_id：" + sessionId + " 握手成功！");
30.             return true;
31.         }
32.         System.out.println("用户登录已失效");
33.         return false;
34.     }
36.     /**
37.      * 握手后
38.      */
39.     @Override
40.     public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception exception) {
41.         System.out.println("握手完成");
42.     }
44. }

复制代码

1. import org.springframework.beans.factory.annotation.Autowired;
2. import org.springframework.context.annotation.Configuration;
3. import org.springframework.web.socket.config.annotation.EnableWebSocket;
4. import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
5. import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
7. /**
8. * @author HTL
9. * @version 2024-7-4  004
10. * @since JDK8
11. */
12. @Configuration
13. @EnableWebSocket
14. public class WebsocketConfig implements WebSocketConfigurer {
16.     @Autowired
17.     private HttpAuthHandler httpAuthHandler;
19.     @Autowired
20.     private MyInterceptor myInterceptor;
22.     @Override
23.     public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
24.         registry
25.                 .addHandler(httpAuthHandler, "myWS")//请求地址前缀
26.                 .addInterceptors(myInterceptor)
27.                 .setAllowedOrigins("*");
28.     }
30. }

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。