SpringBoot集成WebSocket基于STOMP协议进行点对点[一对一]和广播[一对多]实时推送，内附简易聊天室demo

开通VIP，畅享免费电子书等14项超值服

首页

好书

留言交流

下载APP

联系客服

2019.04.07

最近项目来了新需求，需要做一个实时推送的功能，服务器主动推送消息给客户端，在网上经过一轮搜查之后，确定使用WebSocket来进行开发。以前经常听说WebSocket的神奇之处，如今终于可以尝试使用它了。

因为是根据项目的需求来的，所以这里我只介绍在SpringBoot下使用WebSocket的其中一种实现【STOMP协议】。因此整个工程涉及websocket使用的大致框架为SpringBoot+Maven+websocket，其他框架的基础搭建，我这里就不说了，相信各位也都很熟悉，我就直接集成websocket了。

在pox.xml加上对springBoot对WebSocket的支持：

这样SpringBoot就和WebSocket集成好了，我们就可以直接使用SpringBoot提供对WebSocket操作的API了

①在Spring上下文中添加对WebSocket的配置

1.@EnableWebSocketMessageBroker：开启使用STOMP协议来传输基于代理(messagebroker)的消息,这时控制器支持使用@MessageMapping,就像使用@RequestMapping一样。

3.registry.addEndpoint("/endpointOyzc").setAllowedOrigins("*").withSockJS();添加一个访问端点“/endpointGym”,客户端打开双通道时需要的url,允许所有的域名跨域访问，指定使用SockJS协议。

4.registry.enableSimpleBroker("/topic","/user");配置一个/topic广播消息代理和“/user”一对一消息代理

5.registry.setUserDestinationPrefix("/user");点对点使用的订阅前缀（客户端订阅路径上会体现出来），不设置的话，默认也是/user/

②实现服务器主动向客户端推送消息

SpringBoot封装得太好，webSocket用起来太简单（好处：用起来方便，坏处：你不知道底层实现）

1.一对多的实现：

先上后台java的代码

简单介绍一下

1.SimpMessagingTemplate：SpringBoot提供操作WebSocket的对象

2.@Scheduled(fixedRate=10000)：为了测试，定时10S执行这个方法，向客户端推送

3.template.convertAndSend("/topic/getResponse",newAricResponse("后台实时推送：,Oyzc!"));:直接向前端推送消息。

3.1参数一：客户端监听指定通道时，设定的访问服务器的URL

3.2参数二：发送的消息（可以是对象、字符串等等）

在上客户端的代码（PC现代浏览器）

html页面：

JS代码[webSocket.js]值得注意的是，只需要在连接服务器注册端点endPoint时，写访问服务器的全路径URL：

其他监听指定服务器广播的URL不需要写全路径

stompClient.subscribe('/topic/getResponse',function(response){showResponse(JSON.parse(response.body));

});

2.一对一的实现

简单介绍一下：

3.template.convertAndSendToUser(user.getUserId()+"","/queue/getResponse",user);:直接向前端推送消息。

3.1参数一：指定客户端接收的用户标识（一般用用户ID）

3.2参数二：客户端监听指定通道时，设定的访问服务器的URL（客户端访问URL跟广播有些许不同）

3.3参数三：向目标发送消息体（实体、字符串等等）

JS代码[webSocket.js]

与广播不同的是，在指定通道的URL加个用户标识：

stompClient.subscribe('/user/'+userId+'/queue/getResponse',function(response){varcode=JSON.parse(response.body);showResponse(code)

该标识userId必须与服务器推送消息时设置的用户标识一致

以上就是实现服务器实时向客户端推送消息，各位可以按照各自的需求进行配合使用。

③实现客户端与服务器之间的直接交互，聊天室demo[在②的基础上添加了一些代码]

1.在webSocket配置中，增加2个WebSocket的代理

"/mass"用以代理群发消息

"/alone"用以代码一对一聊天

2.java后台实现

简单介绍新的注解一下：

一.@MessageMapping("/massRequest")：类似与@RequestMapping，客户端请求服务器的URL，前提是双方端点已经打开

二.@SendTo("/mass/getResponse")：作用跟convertAndSend类似，广播发给与该通道相连的客户端

其他已经在前面解释过了。

3.html代码

JS代码[chatroom.js]：

chatroom.css

4.测试结果：

该聊天室用于测试，所以好友都是固定写死的，各位可以根据各自的需求进行修改

本来想弄个内网穿透，然后跟外网朋友玩玩的，弄了个NATAPP的免费的内网穿透，发现不知道为啥，webSocket访问不到，有哪位大神知道原因，跟我说说呗。