WebSocket整合SSM(Spring,Struts2,Maven)的實現(xiàn)示例

更新時間：2019年01月17日 11:20:24 作者：冰湖一角

這篇文章主要介紹了WebSocket整合SSM(Spring,Struts2,Maven)的實現(xiàn)示例，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

一、WebSocket與HTTP長輪詢

WebSocket屬于HTML5 規(guī)范的一部分，提供的一種在單個 TCP 連接上進行全雙工通訊的協(xié)議。允許服務端主動向客戶端推送數(shù)據(jù)。在 WebSocket API 中，瀏覽器和服務器只需要完成一次握手，兩者之間就直接可以創(chuàng)建持久性的連接，并進行雙向數(shù)據(jù)傳輸。（Tomcat 8以上版本支持）

HTTP 協(xié)議是一種無狀態(tài)的、無連接的、單向的應用層協(xié)議。它采用了請求/響應模型。通信請求只能由客戶端發(fā)起，服務端對請求做出應答處理。這種通信模型有一個弊端：HTTP 協(xié)議無法實現(xiàn)服務器主動向客戶端發(fā)起消息。

HTTP長輪詢：客戶端向服務器發(fā)送(http)Ajax請求，服務器接到請求后hold住連接，直到有新消息才返回響應信息并關(guān)閉連接，客戶端處理完響應信息后再向服務器發(fā)送新的請求。

WebSocket與HTTP長輪詢的通信機制如下：

二、客戶端如何使用WebSocket

瀏覽器通過 JavaScript 向服務器發(fā)出建立 WebSocket 連接的請求，連接建立以后，客戶端和服務器端就可以通過 TCP 連接直接交換數(shù)據(jù)。

當你獲取 Web Socket 連接后，你可以通過send()方法來向服務器發(fā)送數(shù)據(jù)，并通過onmessage事件來接收服務器返回的數(shù)據(jù)。

1. 創(chuàng)建 WebSocket 對象API

//第一個參數(shù) url, 指定連接的 URL。第二個參數(shù) protocol 是可選的，指定了可接受的子協(xié)議?！　?

API：var webSocket = new WebSocket(url, [protocol] );

2. WebSocket 屬性

以下是 WebSocket 對象的屬性。假定我們使用了以上代碼創(chuàng)建了 Socket 對象：

屬性	描述
Socket.readyState	只讀屬性 readyState 表示連接狀態(tài)，可以是以下值： 0 - 表示連接尚未建立。 1 - 表示連接已建立，可以進行通信。 2 - 表示連接正在進行關(guān)閉。 3 - 表示連接已經(jīng)關(guān)閉或者連接不能打開。
Socket.bufferedAmount	只讀屬性 bufferedAmount 已被 send() 放入正在隊列中等待傳輸，但是還沒有發(fā)出的 UTF-8 文本字節(jié)數(shù)。

屬性

描述

Socket.readyState

只讀屬性 readyState 表示連接狀態(tài)，可以是以下值：

0 - 表示連接尚未建立。
1 - 表示連接已建立，可以進行通信。
2 - 表示連接正在進行關(guān)閉。
3 - 表示連接已經(jīng)關(guān)閉或者連接不能打開。

Socket.bufferedAmount

只讀屬性 bufferedAmount 已被 send() 放入正在隊列中等待傳輸，但是還沒有發(fā)出的 UTF-8 文本字節(jié)數(shù)。

3. WebSocket 事件

以下是 WebSocket 對象的相關(guān)事件。假定我們使用了以上代碼創(chuàng)建了 Socket 對象：

事件	事件處理程序	描述
open	Socket.onopen	連接建立時觸發(fā)
message	Socket.onmessage	客戶端接收服務端數(shù)據(jù)時觸發(fā)
error	Socket.onerror	通信發(fā)生錯誤時觸發(fā)
close	Socket.onclose	連接關(guān)閉時觸發(fā)

4. WebSocket 方法

以下是 WebSocket 對象的相關(guān)方法。假定我們使用了以上代碼創(chuàng)建了 Socket 對象：

方法	描述
Socket.send()	使用連接發(fā)送數(shù)據(jù)
Socket.close()	關(guān)閉連接

5. WebSocket 實例

<%@ 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";
    //判斷當前瀏覽器是否支持WebSocket
    if ('WebSocket' in window) {
      //建立客戶端websocket  
      webSocket = new WebSocket(url);
    } else {
      console.log("您的瀏覽器不支持WebSocket");
    }
    
    //封裝內(nèi)部監(jiān)聽事件
    function init(){
      //連接發(fā)生錯誤的回調(diào)方法
      webSocket.onerror = function(event) {
        console.log("webSocket連接發(fā)生錯誤.");
      };

      //連接成功建立的回調(diào)方法
      webSocket.onopen = function(event) {
        console.log("webSocket連接成功.");
         //心跳檢測重置
        heartCheck.start();
      };

      //接收到消息的回調(diào)方法
      webSocket.onmessage = function(event) {
        //拿到任何消息都說明當前連接是正常的
        if(event.data=="&"){
          console.log("收到心跳回復"+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)閉事件，當窗口關(guān)閉時，主動去關(guān)閉websocket連接，防止連接還沒斷開就關(guān)閉窗口，server端會拋異常。
      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("向服務器發(fā)送消息="+document.getElementById("msg").value);
      document.getElementById("msg").value = "";     
    } 
    
    //將消息顯示在網(wǎng)頁上
    function setMessageInnerHTML(innerHTML) {
      document.getElementById('message').innerHTML += innerHTML + '<br/>';
    }
    
    function onClose(){
      webSocket.close();
    }
  });  
  
  //心跳檢測
  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ā)送一個心跳，后端收到后，返回一個心跳消息，
     console.log('發(fā)送心跳&');
     webSocket.send("&");
     self.serverTimeoutObj = setTimeout(function() {
      console.log(webSocket);
      console.log("服務器心跳回復超時");
      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>

三、服務器端如何使用WebSocket

1. pom.xml文件引入對應的依賴包：

<!-- 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服務類

 <!-- websocket -->
   <bean id="webSocketService" class="minyuantec.tvwall.service.impl.WebSocketServiceImpl" scope="singleton">
   </bean>

3. struts2配置文件過濾websocket請求

<!-- 過濾掉ws請求 -->
<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)變量，用來記錄當前在線連接數(shù)。應該把它設(shè)計成線程安全的
  public static int onlineCount = 0;

  //與某個客戶端的連接會話，需要通過它來給客戶端發(fā)送數(shù)據(jù)
  public Session session;

  /**
   * 連接建立成功調(diào)用的方法
   * @param session 可選的參數(shù)。session為與某個客戶端的連接會話，需要通過它來給客戶端發(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("有新連接加入！當前在線人數(shù)為" + getOnlineCount());
    logger.info("有新連接加入！當前在線人數(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)閉！當前在線人數(shù)為" + getOnlineCount());
    logger.info("有一連接關(guān)閉！當前在線人數(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ā)生錯誤時調(diào)用
   * @param session
   * @param error
   */
  @OnError
  public void onError(Session session, Throwable error){
    System.out.println("發(fā)生錯誤");
    logger.info("發(fā)生錯誤:" + 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實現(xiàn)類里實現(xiàn)服務器推送消息的方法

@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;
  }

其實，使用Tomcat8開發(fā)WebSocket服務端非常簡單，主要有如下兩種方式：

1. 使用注解方式開發(fā)（上述示例代碼），被@ServerEndpoint修飾的Java類即可作為WebSocket服務端。

2. 繼承Endpint基類實現(xiàn)WebSocket服務端。

以上就是本文的全部內(nèi)容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: