详解spring boot Websocket使用笔记
本文只作为个人笔记,大部分代码是引用其他人的文章的。
在springboot项目中使用websocket做推送,虽然挺简单的,但初学也踩过几个坑,特此记录。
使用websocket有两种方式:1是使用sockjs,2是使用h5的标准。使用Html5标准自然更方便简单,所以记录的是配合h5的使用方法。
1、pom
核心是@ServerEndpoint这个注解。这个注解是Javaee标准里的注解,tomcat7以上已经对其进行了实现,如果是用传统方法使用tomcat发布项目,只要在pom文件中引入javaee标准即可使用。
javax javaee-api 7.0 provided
但使用springboot的内置tomcat时,就不需要引入javaee-api了,spring-boot已经包含了。使用springboot的websocket功能首先引入springboot组件。
org.springframework.boot spring-boot-starter-websocket 1.3.5.RELEASE
顺便说一句,springboot的高级组件会自动引用基础的组件,像spring-boot-starter-websocket就引入了spring-boot-starter-web和spring-boot-starter,所以不要重复引入。
2、使用@ServerEndpoint创立websocketendpoint
首先要注入ServerEndpointExporter,这个bean会自动注册使用了@ServerEndpoint注解声明的Websocketendpoint。要注意,如果使用独立的servlet容器,而不是直接使用springboot的内置容器,就不要注入ServerEndpointExporter,因为它将由容器自己提供和管理。
@Configuration publicclassWebSocketConfig{ @Bean publicServerEndpointExporterserverEndpointExporter(){ returnnewServerEndpointExporter(); } }
接下来就是写websocket的具体实现类,很简单,直接上代码:
@ServerEndpoint(value="/websocket") @Component publicclassMyWebSocket{ //静态变量,用来记录当前在线连接数。应该把它设计成线程安全的。 privatestaticintonlineCount=0; //concurrent包的线程安全Set,用来存放每个客户端对应的MyWebSocket对象。 privatestaticCopyOnWriteArraySetwebSocketSet=newCopyOnWriteArraySet (); //与某个客户端的连接会话,需要通过它来给客户端发送数据 privateSessionsession; /** *连接建立成功调用的方法*/ @OnOpen publicvoidonOpen(Sessionsession){ this.session=session; webSocketSet.add(this);//加入set中 addOnlineCount();//在线数加1 System.out.println("有新连接加入!当前在线人数为"+getOnlineCount()); try{ sendMessage(CommonConstant.CURRENT_WANGING_NUMBER.toString()); }catch(IOExceptione){ System.out.println("IO异常"); } } /** *连接关闭调用的方法 */ @OnClose publicvoidonClose(){ webSocketSet.remove(this);//从set中删除 subOnlineCount();//在线数减1 System.out.println("有一连接关闭!当前在线人数为"+getOnlineCount()); } /** *收到客户端消息后调用的方法 * *@parammessage客户端发送过来的消息*/ @OnMessage publicvoidonMessage(Stringmessage,Sessionsession){ System.out.println("来自客户端的消息:"+message); //群发消息 for(MyWebSocketitem:webSocketSet){ try{ item.sendMessage(message); }catch(IOExceptione){ e.printStackTrace(); } } } /** *发生错误时调用 @OnError publicvoidonError(Sessionsession,Throwableerror){ System.out.println("发生错误"); error.printStackTrace(); } publicvoidsendMessage(Stringmessage)throwsIOException{ this.session.getBasicRemote().sendText(message); //this.session.getAsyncRemote().sendText(message); } /** *群发自定义消息 **/ publicstaticvoidsendInfo(Stringmessage)throwsIOException{ for(MyWebSocketitem:webSocketSet){ try{ item.sendMessage(message); }catch(IOExceptione){ continue; } } } publicstaticsynchronizedintgetOnlineCount(){ returnonlineCount; } publicstaticsynchronizedvoidaddOnlineCount(){ MyWebSocket.onlineCount++; } publicstaticsynchronizedvoidsubOnlineCount(){ MyWebSocket.onlineCount--; } }
使用springboot的唯一区别是要@Component声明下,而使用独立容器是由容器自己管理websocket的,但在springboot中连容器都是spring管理的。
虽然@Component默认是单例模式的,但springboot还是会为每个websocket连接初始化一个bean,所以可以用一个静态set保存起来。
3、前端代码
MyWebSocket Welcome
Send Close
'; } //关闭连接 functioncloseWebSocket(){ websocket.close(); } //发送消息 functionsend(){ varmessage=document.getElementById('text').value; websocket.send(message); }
4、总结
springboot已经做了深度的集成和优化,要注意是否添加了不需要的依赖、配置或声明。由于很多讲解组件使用的文章是和spring集成的,会有一些配置,在使用springboot时,由于springboot已经有了自己的配置,再这些配置有可能导致各种各样的异常。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持毛票票。