詳解spring boot Websocket使用筆記
本文只作為個人筆記,大部分代碼是引用其他人的文章的。
在springboot項目中使用websocket做推送,雖然挺簡單的,但初學也踩過幾個坑,特此記錄。
使用websocket有兩種方式:1是使用sockjs,2是使用h5的標準。使用Html5標準自然更方便簡單,所以記錄的是配合h5的使用方法。
1、pom
核心是@ServerEndpoint這個注解。這個注解是Javaee標準里的注解,tomcat7以上已經(jīng)對其進行了實現(xiàn),如果是用傳統(tǒng)方法使用tomcat發(fā)布項目,只要在pom文件中引入javaee標準即可使用。
<dependency> <groupId>javax</groupId> <artifactId>javaee-api</artifactId> <version>7.0</version> <scope>provided</scope> </dependency>
但使用springboot的內(nèi)置tomcat時,就不需要引入javaee-api了,spring-boot已經(jīng)包含了。使用springboot的websocket功能首先引入springboot組件。
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> <version>1.3.5.RELEASE</version> </dependency>
順便說一句,springboot的高級組件會自動引用基礎的組件,像spring-boot-starter-websocket就引入了spring-boot-starter-web和spring-boot-starter,所以不要重復引入。
2、使用@ServerEndpoint創(chuàng)立websocket endpoint
首先要注入ServerEndpointExporter,這個bean會自動注冊使用了@ServerEndpoint注解聲明的Websocket endpoint。要注意,如果使用獨立的servlet容器,而不是直接使用springboot的內(nèi)置容器,就不要注入ServerEndpointExporter,因為它將由容器自己提供和管理。
@Configuration public class WebSocketConfig { @Bean public ServerEndpointExporter serverEndpointExporter() { return new ServerEndpointExporter(); } }
接下來就是寫websocket的具體實現(xiàn)類,很簡單,直接上代碼:
@ServerEndpoint(value = "/websocket") @Component public class MyWebSocket { //靜態(tài)變量,用來記錄當前在線連接數(shù)。應該把它設計成線程安全的。 private static int onlineCount = 0; //concurrent包的線程安全Set,用來存放每個客戶端對應的MyWebSocket對象。 private static CopyOnWriteArraySet<MyWebSocket> webSocketSet = new CopyOnWriteArraySet<MyWebSocket>(); //與某個客戶端的連接會話,需要通過它來給客戶端發(fā)送數(shù)據(jù) private Session session; /** * 連接建立成功調(diào)用的方法*/ @OnOpen public void onOpen(Session session) { this.session = session; webSocketSet.add(this); //加入set中 addOnlineCount(); //在線數(shù)加1 System.out.println("有新連接加入!當前在線人數(shù)為" + getOnlineCount()); try { sendMessage(CommonConstant.CURRENT_WANGING_NUMBER.toString()); } catch (IOException e) { System.out.println("IO異常"); } } /** * 連接關(guān)閉調(diào)用的方法 */ @OnClose public void onClose() { webSocketSet.remove(this); //從set中刪除 subOnlineCount(); //在線數(shù)減1 System.out.println("有一連接關(guān)閉!當前在線人數(shù)為" + getOnlineCount()); } /** * 收到客戶端消息后調(diào)用的方法 * * @param message 客戶端發(fā)送過來的消息*/ @OnMessage public void onMessage(String message, Session session) { System.out.println("來自客戶端的消息:" + message); //群發(fā)消息 for (MyWebSocket item : webSocketSet) { try { item.sendMessage(message); } catch (IOException e) { e.printStackTrace(); } } } /** * 發(fā)生錯誤時調(diào)用 @OnError public void onError(Session session, Throwable error) { System.out.println("發(fā)生錯誤"); error.printStackTrace(); } public void sendMessage(String message) throws IOException { this.session.getBasicRemote().sendText(message); //this.session.getAsyncRemote().sendText(message); } /** * 群發(fā)自定義消息 * */ public static void sendInfo(String message) throws IOException { for (MyWebSocket item : webSocketSet) { try { item.sendMessage(message); } catch (IOException e) { continue; } } } public static synchronized int getOnlineCount() { return onlineCount; } public static synchronized void addOnlineCount() { MyWebSocket.onlineCount++; } public static synchronized void subOnlineCount() { MyWebSocket.onlineCount--; } }
使用springboot的唯一區(qū)別是要@Component聲明下,而使用獨立容器是由容器自己管理websocket的,但在springboot中連容器都是spring管理的。
雖然@Component默認是單例模式的,但springboot還是會為每個websocket連接初始化一個bean,所以可以用一個靜態(tài)set保存起來。
3、前端代碼
<!DOCTYPE HTML> <html> <head> <title>My WebSocket</title> </head> <body> Welcome<br/> <input id="text" type="text" /><button onclick="send()">Send</button> <button onclick="closeWebSocket()">Close</button> <div id="message"> </div> </body> <script type="text/javascript"> var websocket = null; //判斷當前瀏覽器是否支持WebSocket if('WebSocket' in window){ websocket = new WebSocket("ws://localhost:8084/websocket"); } else{ alert('Not support websocket') } //連接發(fā)生錯誤的回調(diào)方法 websocket.onerror = function(){ setMessageInnerHTML("error"); }; //連接成功建立的回調(diào)方法 websocket.onopen = function(event){ setMessageInnerHTML("open"); } //接收到消息的回調(diào)方法 websocket.onmessage = function(event){ setMessageInnerHTML(event.data); } //連接關(guān)閉的回調(diào)方法 websocket.onclose = function(){ setMessageInnerHTML("close"); } //監(jiān)聽窗口關(guān)閉事件,當窗口關(guān)閉時,主動去關(guān)閉websocket連接,防止連接還沒斷開就關(guān)閉窗口,server端會拋異常。 window.onbeforeunload = function(){ websocket.close(); } //將消息顯示在網(wǎng)頁上 function setMessageInnerHTML(innerHTML){ document.getElementById('message').innerHTML += innerHTML + '<br/>'; } //關(guān)閉連接 function closeWebSocket(){ websocket.close(); } //發(fā)送消息 function send(){ var message = document.getElementById('text').value; websocket.send(message); } </script> </html>
4、總結(jié)
springboot已經(jīng)做了深度的集成和優(yōu)化,要注意是否添加了不需要的依賴、配置或聲明。由于很多講解組件使用的文章是和spring集成的,會有一些配置,在使用springboot時,由于springboot已經(jīng)有了自己的配置,再這些配置有可能導致各種各樣的異常。
以上就是本文的全部內(nèi)容,希望對大家的學習有所幫助,也希望大家多多支持腳本之家。
- Spring WebSocket 404錯誤的解決方法
- Spring和Websocket相結(jié)合實現(xiàn)消息的推送
- 完美解決spring websocket自動斷開連接再創(chuàng)建引發(fā)的問題
- java中實現(xiàn)兼容ie6 7 8 9的spring4+websocket
- 詳解WebSocket+spring示例demo(已使用sockJs庫)
- Spring整合WebSocket應用示例(上)
- 詳解在Spring Boot框架下使用WebSocket實現(xiàn)消息推送
- SpringBoot webSocket實現(xiàn)發(fā)送廣播、點對點消息和Android接收
- Spring整合websocket整合應用示例(下)
- Spring集成webSocket頁面訪問404問題的解決方法
相關(guān)文章
關(guān)于springboot的接口返回值統(tǒng)一標準格式
這篇文章主要介紹了關(guān)于springboot的接口返回值統(tǒng)一標準格式,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2022-05-05springMVC框架下JQuery傳遞并解析Json數(shù)據(jù)
json作為一種輕量級的數(shù)據(jù)交換格式,在前后臺數(shù)據(jù)交換中占據(jù)著非常重要的地位,這篇文章主要介紹了springMVC框架下JQuery傳遞并解析Json數(shù)據(jù),有興趣的可以了解一下。2017-01-01因Spring AOP導致@Autowired依賴注入失敗的解決方法
這篇文章主要給大家介紹了因Spring AOP導致@Autowired依賴注入失敗的解決方法,文中通過示例代碼給大家介紹的非常詳細,對大家具有一定的參考學習價值,需要的朋友們下面跟著小編來一起學習學習吧。2017-07-07