springboot中怎么整合WebSocket

  • 时间:
  • 浏览:172
  • 来源:恰卡网

导读今天就跟大家聊聊有关springboot中怎么整合WebSocket,可能很多人都不太了解,为了让大家更加了解,小编给大家总结了以下内容,希望大家根据这篇文章可以有所收获。 1、依赖引入 要使用 we...

今天就跟大家聊聊有关springboot中怎么整合WebSocket,可能很多人都不太了解,为了让大家更加了解,小编给大家总结了以下内容,希望大家根据这篇文章可以有所收获。

1、依赖引入

要使用 websocket 关键是@ServerEndpoint这个注解,该注解是 javaee 标准中的注解,tomcat7 及以上已经实现了,如果使用传统方法将 war 包部署到 tomcat 中,只需要引入如下 javaee 标准依赖即可:


javax
javaee-api
7.0
provided

如使用 springboot 内置容器,无需引入,springboot 已经做了包含。我们只需引入如下依赖即可:


org.springframework.boot
spring-boot-starter-websocket
1.5.3.RELEASE
pom

2、注入 Bean

首先注入一个ServerEndpointExporterBean,该 Bean 会自动注册使用@ServerEndpoint 注解申明的 websocket endpoint。代码如下:

@Configuration
publicclassWebSocketConfig{
@Bean
publicServerEndpointExporterserverEndpointExporter(){
returnnewServerEndpointExporter();
}
}

3、申明 endpoint

建立MyWebSocket.java类,在该类中处理 websocket 逻辑

@ServerEndpoint(value="/websocket")//接受websocket请求路径
@Component//注册到spring容器中
publicclassMyWebSocket{
//保存所有在线socket连接
privatestaticMapwebSocketMap=newLinkedHashMap<>();
//记录当前在线数目
privatestaticintcount=0;
//当前连接(每个websocket连入都会创建一个MyWebSocket实例
privateSessionsession;
privateLoggerlog=LoggerFactory.getLogger(this.getClass());
//处理连接建立
@OnOpen
publicvoidonOpen(Sessionsession){
this.session=session;
webSocketMap.put(session.getId(),this);
addCount();
log.info("新的连接加入:{}",session.getId());
}
//接受消息
@OnMessage
publicvoidonMessage(Stringmessage,Sessionsession){
log.info("收到客户端{}消息:{}",session.getId(),message);
try{
this.sendMessage("收到消息:"+message);
}catch(Exceptione){
e.printStackTrace();
}
}
//处理错误
@OnError
publicvoidonError(Throwableerror,Sessionsession){
log.info("发生错误{},{}",session.getId(),error.getMessage());
}
//处理连接关闭
@OnClose
publicvoidonClose(){
webSocketMap.remove(this.session.getId());
reduceCount();
log.info("连接关闭:{}",this.session.getId());
}
//群发消息
//发送消息
publicvoidsendMessage(Stringmessage)throwsIOException{
this.session.getBasicRemote().sendText(message);
}
//广播消息
publicstaticvoidbroadcast(){
MyWebSocket.webSocketMap.forEach((k,v)->{
try{
v.sendMessage("这是一条测试广播");
}catch(Exceptione){
}
});
}
//获取在线连接数目
publicstaticintgetCount(){
returncount;
}
//操作count,使用synchronized确保线程安全
publicstaticsynchronizedvoidaddCount(){
MyWebSocket.count++;
}
publicstaticsynchronizedvoidreduceCount(){
MyWebSocket.count--;
}
}

4、客户的实现

客户端使用 h6 原生 websocket,部分浏览器可能不支持。代码如下:



websocket测试



测试


三、测试

建立一个 controller 测试群发,代码如下:

@RestController
publicclassHomeController{
@GetMapping("/broadcast")
publicvoidbroadcast(){
MyWebSocket.broadcast();
}
}

然后打开上面的 html,可以看到浏览器和服务器都输出连接成功的信息:

浏览器:
Event{isTrusted:true,type:"open",target:WebSocket,currentTarget:WebSocket,eventPhase:2,…}
服务端:
2018-08-0114:05:34.727INFO12708---[nio-8080-exec-1]com.fxb.h6websocket.MyWebSocket:新的连接加入:0

点击测试按钮,可在服务端看到如下输出:

2018-08-0115:00:34.644INFO12708---[nio-8080-exec-6]com.fxb.h6websocket.MyWebSocket:收到客户端2消息:这是一个测试数据

再次打开 html 页面,这样就有两个 websocket 客户端,然后在浏览器访问localhost:8080/broadcast测试群发功能,每个客户端都会输出如下信息:

MessageEvent{isTrusted:true,data:"这是一条测试广播",origin:"ws://localhost:8080",lastEventId:"",source:null,…}

看完上述内容,你们对springboot中怎么整合WebSocket有进一步的了解吗?如果还想了解更多知识或者相关内容,请关注恰卡网行业资讯频道,感谢大家的支持。

猜你喜欢

accesstoken中怎么获取用户黑名单列表

这篇文章将为大家详细讲解有关accesstoken中怎么获取用户黑名单列表,文章内容质量较高,因此小编分享给大家做个参考,希望大家阅读完这篇文章后对相关知识有一定的了解。 公众号可登录

2021-07-29

Java中怎么利用轮询获取线程返回数据

Java中怎么利用轮询获取线程返回数据,相信很多没有经验的人对此束手无策,为此本文总结了问题出现的原因和解决方法,通过这篇文章希望你能解决这个问题。 1. 多线程的特点 一般程序中

2021-07-29

XamarinEssentials中怎么获取首选项的值

这期内容当中小编将会给大家带来有关XamarinEssentials中怎么获取首选项的值,文章内容丰富且以专业的角度为大家分析和叙述,阅读完这篇文章希望大家可以有所收获。 XamarinEssentials教程获取首

2021-07-29

jQuery中怎么获取内容和属性

这篇文章给大家介绍jQuery 中怎么获取内容和属性,内容非常详细,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。 jQuery - 获取内容和属性 jQuery 拥有可操作 HTML 元素和属性的强大方

2021-07-29