SpringBoot3集成WebSocket

标签：WebSocket，Session，Postman。

一、简介

WebSocket通过一个TCP连接在客户端和服务器之间创建一个全双工、双向的通信通道，使得客户端和服务器之间的数据互换变得更加简单，允许服务端主动向客户端推送数据，在WebSocket的API中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建长期性的连接，并进行双向数据传输。
【基于Postman工具的WebSocket交互】

1. Connected to ws://127.0.0.1:8088/web/socket/msg
3. Handshake Details
4. Request URL: http://127.0.0.1:8088/web/socket/msg
5. Request Method: GET
6. Status Code: 101
8. Request Headers
9. Sec-WebSocket-Version: 13
10. Sec-WebSocket-Key: 5Qrs8JeRLsiY9G/PRJUocQ==
11. Connection: Upgrade
12. Upgrade: websocket
13. Sec-WebSocket-Extensions: permessage-deflate; client_max_window_bits
14. Host: 127.0.0.1:8088
16. Response Headers
17. Upgrade: websocket
18. Connection: upgrade
19. Sec-WebSocket-Accept: E3aFw2bBzxByPCynmQ7lZ+7BgsU=
20. Sec-WebSocket-Extensions: permessage-deflate;client_max_window_bits=15

复制代码

二、工程搭建

1、工程结构

2、依赖管理

在starter-websocket的依赖中，涉及到spring框架中两个关系较为密切的组件，分别是websocket和messaging组件。

1. <dependency>
2.     <groupId>org.springframework.boot</groupId>
3.     <artifactId>spring-boot-starter-websocket</artifactId>
4.     <version>${spring-boot.version}</version>
5. </dependency>

复制代码

三、WebSocket用法

1、示意图

在下面的案例中，大致模拟这样一个流程，三个客户端分别和服务端创建连接，然后进行客户端之间的会话通信。

2、API参考

这里通过4个焦点的方法注解，分别处分析话的差别动作，比如连接的创建和关闭，通信交互和错误处理；在实际的应用场景中，需要在通信方法中设计更多的指令来应对差别的业务场景。

1. @ServerEndpoint("/web/socket/msg")
2. public class MsgWebSocket {
4.     private static final  ConcurrentHashMap<String,Session> sessions = new ConcurrentHashMap<>();
6.     private static final AtomicInteger onlineCount = new AtomicInteger(0);
8.     /**
9.      * 建立连接调用的方法
10.      */
11.     @OnOpen
12.     public void onOpen(Session session) {
13.         String userId = session.getRequestParameterMap().get("userId").get(0);
14.         // 加入Set中
15.         sessions.put(userId,session);
16.         // 在线数增加
17.         onlineCount.getAndIncrement();
18.         log.info("session-{},online-count-{}",session.getId(),onlineCount.get());
19.     }
21.     /**
22.      * 客户端消息处理的方法
23.      */
24.     @OnMessage
25.     public void sendMsg(Session sender,String message) throws Exception {
26.         MsgDTO dto = JSONUtil.toBean(message, MsgDTO.class);
27.         Session receiver = sessions.get(dto.getUserId());
28.         if (receiver != null) {
29.             receiver.getBasicRemote().sendText(dto.getMsg());
30.         }
31.     }
33.     /**
34.      * 关闭连接调用的方法
35.      */
36.     @OnClose
37.     public void onClose(Session session) {
38.         String userId = session.getRequestParameterMap().get("userId").get(0);
39.         // 从Set中删除
40.         sessions.remove(userId);
41.         // 在线数减少
42.         onlineCount.getAndDecrement();
43.         log.info("session-{},down-line-count-{}",session.getId(),onlineCount.get());
44.     }
46.     /**
47.      * 发生错误调用的方法
48.      */
49.     @OnError
50.     public void onError(Session session, Throwable throwable) throws Exception {
51.         log.error("Web Stock Error", throwable);
52.         session.getBasicRemote().sendText(throwable.getMessage());
53.     }
54. }

复制代码

测试效果图：留意这里使用的是postman最新版本。

四、源码参考

1. 文档仓库：
2. https://gitee.com/cicadasmile/butte-java-note
4. 源码仓库：
5. https://gitee.com/cicadasmile/butte-spring-parent

复制代码

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