WebSocket整合SSM(Spring,Struts2,Maven)的實(shí)現(xiàn)示例
一、WebSocket與HTTP長(zhǎng)輪詢
WebSocket屬于HTML5 規(guī)范的一部分,提供的一種在單個(gè) TCP 連接上進(jìn)行全雙工通訊的協(xié)議。允許服務(wù)端主動(dòng)向客戶端推送數(shù)據(jù)。在 WebSocket API 中,瀏覽器和服務(wù)器只需要完成一次握手,兩者之間就直接可以創(chuàng)建持久性的連接,并進(jìn)行雙向數(shù)據(jù)傳輸。(Tomcat 8以上版本支持)
HTTP 協(xié)議是一種無狀態(tài)的、無連接的、單向的應(yīng)用層協(xié)議。它采用了請(qǐng)求/響應(yīng)模型。通信請(qǐng)求只能由客戶端發(fā)起,服務(wù)端對(duì)請(qǐng)求做出應(yīng)答處理。這種通信模型有一個(gè)弊端:HTTP 協(xié)議無法實(shí)現(xiàn)服務(wù)器主動(dòng)向客戶端發(fā)起消息。
HTTP長(zhǎng)輪詢:客戶端向服務(wù)器發(fā)送(http)Ajax請(qǐng)求,服務(wù)器接到請(qǐng)求后hold住連接,直到有新消息才返回響應(yīng)信息并關(guān)閉連接,客戶端處理完響應(yīng)信息后再向服務(wù)器發(fā)送新的請(qǐng)求。
WebSocket與HTTP長(zhǎng)輪詢的通信機(jī)制如下:
二、客戶端如何使用WebSocket
瀏覽器通過 JavaScript 向服務(wù)器發(fā)出建立 WebSocket 連接的請(qǐng)求,連接建立以后,客戶端和服務(wù)器端就可以通過 TCP 連接直接交換數(shù)據(jù)。
當(dāng)你獲取 Web Socket 連接后,你可以通過send()方法來向服務(wù)器發(fā)送數(shù)據(jù),并通過onmessage事件來接收服務(wù)器返回的數(shù)據(jù)。
1. 創(chuàng)建 WebSocket 對(duì)象API
//第一個(gè)參數(shù) url, 指定連接的 URL。第二個(gè)參數(shù) protocol 是可選的,指定了可接受的子協(xié)議。 API:var webSocket = new WebSocket(url, [protocol] );
2. WebSocket 屬性
以下是 WebSocket 對(duì)象的屬性。假定我們使用了以上代碼創(chuàng)建了 Socket 對(duì)象:
屬性 | 描述 |
---|---|
Socket.readyState |
只讀屬性 readyState 表示連接狀態(tài),可以是以下值:
|
Socket.bufferedAmount |
只讀屬性 bufferedAmount 已被 send() 放入正在隊(duì)列中等待傳輸,但是還沒有發(fā)出的 UTF-8 文本字節(jié)數(shù)。 |
3. WebSocket 事件
以下是 WebSocket 對(duì)象的相關(guān)事件。假定我們使用了以上代碼創(chuàng)建了 Socket 對(duì)象:
事件 | 事件處理程序 | 描述 |
---|---|---|
open | Socket.onopen | 連接建立時(shí)觸發(fā) |
message | Socket.onmessage | 客戶端接收服務(wù)端數(shù)據(jù)時(shí)觸發(fā) |
error | Socket.onerror | 通信發(fā)生錯(cuò)誤時(shí)觸發(fā) |
close | Socket.onclose | 連接關(guān)閉時(shí)觸發(fā) |
4. WebSocket 方法
以下是 WebSocket 對(duì)象的相關(guān)方法。假定我們使用了以上代碼創(chuàng)建了 Socket 對(duì)象:
方法 | 描述 |
---|---|
Socket.send() |
使用連接發(fā)送數(shù)據(jù) |
Socket.close() |
關(guān)閉連接 |
5. WebSocket 實(shí)例
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> <html> <head> <script type="text/javascript" src="../js/jquery.min.js"></script> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>Testing WebSocket</title> </head> <script type="text/javascript"> var webSocket; $(document).ready(function() { //var IP = window.location.host; var url = "ws://your IP/demo/ws/websocket"; //判斷當(dāng)前瀏覽器是否支持WebSocket if ('WebSocket' in window) { //建立客戶端websocket webSocket = new WebSocket(url); } else { console.log("您的瀏覽器不支持WebSocket"); } //封裝內(nèi)部監(jiān)聽事件 function init(){ //連接發(fā)生錯(cuò)誤的回調(diào)方法 webSocket.onerror = function(event) { console.log("webSocket連接發(fā)生錯(cuò)誤."); }; //連接成功建立的回調(diào)方法 webSocket.onopen = function(event) { console.log("webSocket連接成功."); //心跳檢測(cè)重置 heartCheck.start(); }; //接收到消息的回調(diào)方法 webSocket.onmessage = function(event) { //拿到任何消息都說明當(dāng)前連接是正常的 if(event.data=="&"){ console.log("收到心跳回復(fù)"+event.data); }else{ console.log("接收到消息="+event.data); onMessage(event); } heartCheck.start(); }; //連接關(guān)閉的回調(diào)方法 // 斷線重連 webSocket.onclose = function() { console.log("webSocket連接斷開"); } //監(jiān)聽窗口關(guān)閉事件,當(dāng)窗口關(guān)閉時(shí),主動(dòng)去關(guān)閉websocket連接,防止連接還沒斷開就關(guān)閉窗口,server端會(huì)拋異常。 window.onbeforeunload = function() { webSocket.close(); console.log("窗口關(guān)閉,webSocket斷開連接."); } } function onMessage(event) { setMessageInnerHTML(event.data); } function postToServer() { webSocket.send(document.getElementById("msg").value); console.log("向服務(wù)器發(fā)送消息="+document.getElementById("msg").value); document.getElementById("msg").value = ""; } //將消息顯示在網(wǎng)頁上 function setMessageInnerHTML(innerHTML) { document.getElementById('message').innerHTML += innerHTML + '<br/>'; } function onClose(){ webSocket.close(); } }); //心跳檢測(cè) var heartCheck = { timeout: 10000, timeoutObj: null, serverTimeoutObj: null, start: function(){ console.log("start heartCheck"); var self = this; this.timeoutObj && clearTimeout(this.timeoutObj); this.serverTimeoutObj && clearTimeout(this.serverTimeoutObj); this.timeoutObj = setTimeout(function(){ //這里發(fā)送一個(gè)心跳,后端收到后,返回一個(gè)心跳消息, console.log('發(fā)送心跳&'); webSocket.send("&"); self.serverTimeoutObj = setTimeout(function() { console.log(webSocket); console.log("服務(wù)器心跳回復(fù)超時(shí)"); webSocket.close(); }, self.timeout); }, this.timeout) } } </script> <body> <textarea id="message" readonly></textarea> <br /> <input id="msg" type="text" /> <button type="submit" id="sendButton" onClick="postToServer()">Send!</button> <button type="submit" id="sendButton" onClick="onClose()">End</button> <script type="text/javascript" src="../js/webSocket.js"></script> </body> </html>
三、服務(wù)器端如何使用WebSocket
1. pom.xml文件引入對(duì)應(yīng)的依賴包:
<!-- webSocket 開始--> <dependency> <groupId>javax.websocket</groupId> <artifactId>javax.websocket-api</artifactId> <version>1.1</version> <scope>provided</scope> </dependency> <dependency> <groupId>javax</groupId> <artifactId>javaee-api</artifactId> <version>7.0</version> <scope>provided</scope> </dependency> <!-- webSocket 結(jié)束-->
2. spring配置文件配置websocket服務(wù)類
<!-- websocket --> <bean id="webSocketService" class="minyuantec.tvwall.service.impl.WebSocketServiceImpl" scope="singleton"> </bean>
3. struts2配置文件過濾websocket請(qǐng)求
<!-- 過濾掉ws請(qǐng)求 --> <constant name="struts.action.excludePattern" value="/ws/.*,ws://.*"></constant>
4. 定義Websocket.java類
@ServerEndpoint("/ws/websocket") public class WebSocket { private static Logger logger = Logger.getLogger(WebSocket.class); @SuppressWarnings("static-access") private MessageHandler messageHandler = getWebSocketService().messageHandler; //靜態(tài)變量,用來記錄當(dāng)前在線連接數(shù)。應(yīng)該把它設(shè)計(jì)成線程安全的 public static int onlineCount = 0; //與某個(gè)客戶端的連接會(huì)話,需要通過它來給客戶端發(fā)送數(shù)據(jù) public Session session; /** * 連接建立成功調(diào)用的方法 * @param session 可選的參數(shù)。session為與某個(gè)客戶端的連接會(huì)話,需要通過它來給客戶端發(fā)送數(shù)據(jù) */ @OnOpen public void onOpen(Session session){ this.session = session; WebSocketMapUtil.put(session.getId(),this);//存入map addOnlineCount(); //在線數(shù)加1 messageHandler.onConnect(session.getId()); System.out.println("有新連接加入!當(dāng)前在線人數(shù)為" + getOnlineCount()); logger.info("有新連接加入!當(dāng)前在線人數(shù)為" + getOnlineCount()); } /** * 連接關(guān)閉調(diào)用的方法 */ @OnClose public void onClose(){ WebSocketMapUtil.remove(session.getId()); //從map中刪除 subOnlineCount(); //在線數(shù)減1 messageHandler.onDisconnect(session.getId()); try { if(session != null){ session.close(); } } catch (IOException e) { e.printStackTrace(); } System.out.println("有一連接關(guān)閉!當(dāng)前在線人數(shù)為" + getOnlineCount()); logger.info("有一連接關(guān)閉!當(dāng)前在線人數(shù)為" + getOnlineCount()); } /** * 收到客戶端消息后調(diào)用的方法 * @param message 客戶端發(fā)送過來的消息 * @param session 可選的參數(shù) */ @OnMessage public String onMessage(String message, Session session) { System.out.println("來自客戶端的消息:" + message); logger.info("來自客戶端的消息:" + message); if (message.equals("&")){ return "&"; }else{ messageHandler.onMessage(session.getId(),message); return "Got your message ("+ message +")"; } } /** * 發(fā)生錯(cuò)誤時(shí)調(diào)用 * @param session * @param error */ @OnError public void onError(Session session, Throwable error){ System.out.println("發(fā)生錯(cuò)誤"); logger.info("發(fā)生錯(cuò)誤:" + error); error.printStackTrace(); } //單發(fā)消息 public void sendMessage(String message) throws IOException{ //阻塞式(同步) //this.session.getBasicRemote().sendText(message); //非阻塞式(異步) this.session.getAsyncRemote().sendText(message); } //群發(fā)消息 public void sendMessageAll(String message) throws IOException{ for(WebSocket webSocket : WebSocketMapUtil.getValues()){ webSocket.sendMessage(message); } } public static synchronized int getOnlineCount() { return onlineCount; } public static synchronized void addOnlineCount() { WebSocket.onlineCount++; } public static synchronized void subOnlineCount() { WebSocket.onlineCount--; } public WebSocketServiceImpl getWebSocketService(){ ClassPathXmlApplicationContext classPathXmlApplicationContext = new ClassPathXmlApplicationContext("classpath*:applicationContext.xml"); return (WebSocketServiceImpl) classPathXmlApplicationContext.getBean("webSocketService"); } }
5. 在WebSocketServiceImpl實(shí)現(xiàn)類里實(shí)現(xiàn)服務(wù)器推送消息的方法
@Override public boolean sendMessage(String message) { logger.info("發(fā)送給客戶端的websocket消息message=="+message); if (messageHandler == null) { logger.info("上層調(diào)用者沒有給messageHandler賦值,websocket消息無法發(fā)送到客戶端"); return false; } if (message == null || "".equals(message)) { logger.info("發(fā)送給客戶端的消息message為空"); return false; } try { for(WebSocket webSocket : WebSocketMapUtil.getValues()){ webSocket.sendMessage(message); logger.info("給sessionId為" + webSocket.session.getId() + "的客戶端發(fā)送消息:"+message+"=成功"); } return true; } catch (IOException e) { logger.info("向所有客戶端發(fā)送消息:"+message+"=失敗:" + e); e.printStackTrace(); } return false; }
其實(shí),使用Tomcat8開發(fā)WebSocket服務(wù)端非常簡(jiǎn)單,主要有如下兩種方式:
1. 使用注解方式開發(fā)(上述示例代碼),被@ServerEndpoint修飾的Java類即可作為WebSocket服務(wù)端。
2. 繼承Endpint基類實(shí)現(xiàn)WebSocket服務(wù)端。
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
- Spring與Struts整合之讓Spring管理控制器操作示例
- spring整合struts2過程詳解
- struts2+spring+ibatis框架整合實(shí)現(xiàn)增刪改查
- Spring+Hibernate+Struts(SSH)框架整合實(shí)戰(zhàn)
- struts+spring+hibernate三個(gè)框架的整合
- Spring整合Struts2的兩種方法小結(jié)
- 詳解JAVAEE——SSH三大框架整合(spring+struts2+hibernate)
- struts2.2.3+spring3.1.0+mybatis3.1.0框架整合集成簡(jiǎn)單demo
- SSH框架網(wǎng)上商城項(xiàng)目第1戰(zhàn)之整合Struts2、Hibernate4.3和Spring4.2
- struts2 spring整合fieldError問題
- Spring與Struts整合之使用自動(dòng)裝配操作示例
相關(guān)文章
解決springboot啟動(dòng)報(bào)錯(cuò)bean找不到的問題
這篇文章主要介紹了解決springboot啟動(dòng)報(bào)錯(cuò)bean找不到原因,本文給大家分享完美解決方案,通過圖文相結(jié)合給大家介紹的非常詳細(xì),需要的朋友可以參考下2023-03-03Eclipse?2022?設(shè)置中文漢化的超詳細(xì)圖文教程
這篇文章主要介紹了Eclipse?2022?設(shè)置中文漢化的超詳細(xì)圖文教程,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2023-03-03使用SpringBoot的CommandLineRunner遇到的坑及解決
這篇文章主要介紹了使用SpringBoot的CommandLineRunner遇到的坑及解決方案,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-02-02SpringBoot使用Redis的zset統(tǒng)計(jì)在線用戶信息
這篇文章主要介紹了SpringBoot使用Redis的zset統(tǒng)計(jì)在線用戶信息,幫助大家更好的理解和學(xué)習(xí)使用SpringBoot框架,感興趣的朋友可以了解下2021-04-04java中的BlockingQueue(阻塞隊(duì)列)解析
這篇文章主要介紹了java中的BlockingQueue阻塞隊(duì)列解析,阻塞隊(duì)列是一個(gè)支持兩個(gè)附加操作的隊(duì)列,這兩個(gè)附加的操作是,在隊(duì)列為空時(shí),獲取元素的線程會(huì)等待隊(duì)列變?yōu)榉强?需要的朋友可以參考下2023-12-12關(guān)于MyBatis通用Mapper@Table注解使用的注意點(diǎn)
這篇文章主要介紹了關(guān)于MyBatis通用Mapper@Table注解使用的注意點(diǎn),具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-11-11BootStrap Jstree 樹形菜單的增刪改查的實(shí)現(xiàn)源碼
這篇文章主要介紹了BootStrap Jstree 樹形菜單的增刪改查的實(shí)現(xiàn)源碼,非常不錯(cuò),具有參考借鑒價(jià)值,需要的朋友可以參考下2017-02-02Java實(shí)現(xiàn)圖片驗(yàn)證碼具體代碼
這篇文章主要為大家詳細(xì)介紹了Java實(shí)現(xiàn)圖片驗(yàn)證碼具體代碼,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2016-10-10