本文旨在幫助未掌握此技能的小白掃清障礙，快速搭建websocket訊息推送服務，高手請繞行。謝謝！

首先，筆者的寫作背景也是一名剛剛打通websocket訊息推送服務的小白。在連續幾日的蒐集資料下，最終在沒有找到一個完整的解決方案的情況下。摸索出正確的結果，倍感不易的同時，希望能夠記錄下自己心路歷程的同時真正幫助到那些正在此處掙扎的道友。

筆者此前參考了眾多資料之後，最終採用的是@Bean註冊ServerEndpointExporter，並註解@ServerEndpoint的方式，簡單直接。參考前輩長樂忘憂的個人部落格：

然而還是在實現的過程中出現一系列問題，下面會詳細描述，具體實現步驟如下。

首先介紹使用SpringBoot內建Tomcat的配置方式，我們按照流程編輯序號如下：

1、配置SpringBootMaven環境
pom檔案中，需要引入spring-boot-starter-websocket的資源包

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
            <version
 
>1.3.5.RELEASE</version>
        </dependency>

2、配置ServerEndpointExporter的元件註冊。
這個bean會自動註冊使用了@ServerEndpoint註解宣告的Websocket endpoint。

@Configuration
public class WebSocketConfig {
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }

}
 

3、實現類的編碼。
此處程式碼原型依然來源於參考文件，後經筆者調整完善，修改內容如下：
1>完善了統計連線人數，每次關閉會話時都會無限-1的bug。
此bug導致所有異常連線的關閉都會將線上人數-1。某些情況下是@onOpen執行沒有成功的，但卻會執行@onClose，於是會造成線上人數統計異常。
2>添加了對業務登入使用者和會話使用者的繫結。
根據參考文件原始碼，可操作連線成功的會話使用者，即websocket session。但是實際開發中，我們操作的是當前業務使用者，即資料庫user table中的使用者。因此，此處需要將業務使用者與會話使用者繫結，從而實現1對1或多對多的靈活自由訊息互動。
實現方式是：在@ServerEndpoint註解時，value值可設定路徑引數。而在連線成功，即@onOpen執行時可接收此引數，接收方式為@PathParam。通過此引數即可將業務使用者與會話使用者繫結。
3>基於業務特點以及實用/安全性等考慮，筆者對程式碼做出一個原則性限制，即一個業務使用者同時只能連線成功一個會話使用者。若讀者不需要此限制，則自行修改程式碼即可。
4>添加了幾個工具方法：
（1）getcurrentWenSocket（Integer fuserid）根據當前登入的業務使用者，獲取其對應的會話使用者的websocket物件。方便於“系統–>使用者”的面對點定點訊息推送。
（2）sendMessage(Integer fuserid,String message) 給指定使用者傳送訊息，即集成了（1）方法，可直接呼叫此方法給當前業務使用者推送訊息，可用於傳送私信。
（3）sendMessageList(List fuseridList, String message) 給指定業務使用者列表傳送訊息，即集成了方法（2），此方法可給指定群體推送同一條訊息，可用於傳送區域性公告。
（4）sendMessageAll(String message) 給所有線上使用者傳送訊息。此方法可用於傳送全網公告。
程式碼如下：

package com.iking.tms.util;

import java.io.IOException;
import java.util.Iterator;
import java.util.List;
import java.util.concurrent.CopyOnWriteArraySet;

import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;

import org.apache.commons.lang.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;


/**
 * websocket
 * @author hufx
 * @version 1.0
 * @date 2017年6月2日上午10:27:40
 */
@ServerEndpoint(value = "/websocket/{fuserid}")
@Component
public class WebSocket {
    private static Logger log = LoggerFactory.getLogger(WebSocket.class);

    private static int onlineCount = 0;                             //靜態變數，用來記錄當前線上連線數。應該把它設計成執行緒安全的。

    private static CopyOnWriteArraySet<WebSocket> webSocketSet = new CopyOnWriteArraySet<WebSocket>(); //concurrent包的執行緒安全Set，用來存放每個客戶端對應的MyWebSocket物件。

    private Session session;                                        //與某個客戶端的連線會話，需要通過它來給客戶端傳送資料

    private Integer fuserid;                                        //儲存當前登入使用者ID

    /**
     * 連線建立成功呼叫的方法
     */
    @OnOpen
    public void onOpen(Session session, @PathParam(value = "fuserid") Integer fuserid) {
        try {
            this.session = session;                                 //設定當前session
            this.fuserid = fuserid;
            WebSocket _this = getcurrentWenSocket(this.fuserid);    //當前登入使用者校驗  每個使用者同時只能連線一次
            if(_this != null){
                sendMessage("您已有連線資訊，不能重複連線 !");
                return;
            }
            webSocketSet.add(this);                                 //將當前websocket加入set中
            addOnlineCount();                                       //線上數加1
            sendMessage("連線成功！");
            System.out.println("有一新連線！當前線上人數為" + getOnlineCount());
        } catch (IOException e) {
            System.out.println("連線異常！");
            log.error("websocket連線異常  : 登入人ID = " + this.fuserid +" , Exception = " + e.getMessage());
        }
    }

    /**
     * 連線關閉呼叫的方法
     */
    @OnClose
    public void onClose() {
        boolean b = webSocketSet.remove(this);                      //從set中刪除
        if(b && getOnlineCount() > 0){
            subOnlineCount();                                       //線上數減1
        }                   
        System.out.println("有一連線關閉！當前線上人數為" + getOnlineCount());
    }

    /**
     * 收到客戶端訊息後呼叫的方法
     *
     * @param message 客戶端傳送過來的訊息*/
    @OnMessage
    public void onMessage(String message, Session session) {
        try {
            WebSocket _this = null;
            for (WebSocket item : webSocketSet) {
                if(item.session.getId() == session.getId()){
                    _this = item;
                }
            }
            if(_this == null){
                this.sendMessage("未連線不能傳送訊息！");
                return;
            }
            System.out.println("來自客戶端的訊息:" + message);
            this.sendMessage("來自服務端的訊息: <已讀> " + message);
        } catch (IOException e) {
            System.out.println("傳送訊息異常！");
            log.error("websocket傳送訊息異常  : 登入人ID = " + this.fuserid +" , Exception = " + e.getMessage());
        }
    }

    /**
     * 發生錯誤時呼叫
     */
    @OnError
    public void onError(Session session, Throwable error) {
        System.out.println("發生錯誤！");
        log.error("websocket發生錯誤  : 登入人ID = " + this.fuserid);
    }

    public static synchronized int getOnlineCount() {
        return onlineCount;
    }

    public static synchronized void addOnlineCount() {
        WebSocket.onlineCount++;
    }

    public static synchronized void subOnlineCount() {
        WebSocket.onlineCount--;
    }

    /**
     * 根據當前登入使用者ID獲取他的websocket物件
     * @param fuserid 使用者ID
     * @return
     * MyWebSocket
     * @author hufx
     * @date 2017年6月2日上午10:35:32
     */
    public static WebSocket getcurrentWenSocket(Integer fuserid){
        if(fuserid == null || fuserid < 1 || webSocketSet == null || webSocketSet.size() < 1){
            return null;
        }
        Iterator<WebSocket> iterator = webSocketSet.iterator();
        while (iterator.hasNext()) {
            WebSocket _this = iterator.next();
            if(_this.fuserid == fuserid){
                return _this;
            }
        }
        return null;
    }

    /**
     * 給當前使用者發訊息（單條）
     * @param message 訊息
     * @throws IOException
     * void
     * @author hufx
     * @date 2017年6月1日下午2:05:36
     */
    public void sendMessage(String message) throws IOException {
        this.session.getBasicRemote().sendText(message);
        //this.session.getAsyncRemote().sendText(message);
    }

    /**
     * 給指定使用者髮指定訊息（單人單條）
     * @param fuserid   使用者ID
     * @param message   訊息
     * void
     * @author hufx
     * @date 2017年6月2日上午11:13:26
     */
    public static void sendMessage(Integer fuserid,String message){
        try {
            if(fuserid == null || fuserid < 1 || StringUtils.isBlank(message)){
                return;
            }
            WebSocket _this = getcurrentWenSocket(fuserid);
            if(_this == null){
                return;
            }
            _this.sendMessage(message);
        } catch (IOException e) {
            System.out.println("傳送訊息異常！");
        }
    }

   /**
    * 給指定人群發訊息（單條）
    * @param fuseridList 使用者ID列表
    * @param message 訊息
    * void
    * @author hufx
    * @date 2017年6月2日上午11:25:29
    */
    public static void sendMessageList(List<Integer> fuseridList, String message){
        try{
            if(fuseridList == null || fuseridList.size() < 1 || StringUtils.isBlank(message)){
                return;
            }
            for (Integer fuserid : fuseridList) {
                WebSocket _this = getcurrentWenSocket(fuserid);
                if(_this == null){
                    continue;
                }
                _this.sendMessage(message);
            }
        }catch(Exception e){
            System.out.println("傳送訊息異常！");
            log.error("websocket傳送訊息異常  : 登入人ID = " + fuseridList.toString() +" , Exception = " + e.getMessage());
        }
    }

    /**
     * 給所有線上使用者發訊息（單條）
     * @param message 訊息
     * @throws IOException
     * void
     * @author hufx
     * @date 2017年6月2日上午11:11:05
     */
    public static void sendMessageAll(String message) {
        try {
            if(webSocketSet == null || webSocketSet.size() < 1 || StringUtils.isBlank(message)){
                return;
            }
            for (WebSocket item : webSocketSet) {
                item.sendMessage(message);
            }
        } catch (IOException e) {
            System.out.println("傳送訊息異常！");
            log.error("websocket傳送訊息異常  : Exception = " + e.getMessage());
        }
    }

}

4、前段頁面程式碼
此程式碼為參考文件原始碼。

<!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')
    }

    //連線發生錯誤的回撥方法
    websocket.onerror = function(){
        setMessageInnerHTML("error");
    };

    //連線成功建立的回撥方法
    websocket.onopen = function(event){
        setMessageInnerHTML("open");
    }

    //接收到訊息的回撥方法
    websocket.onmessage = function(event){
        setMessageInnerHTML(event.data);
    }

    //連線關閉的回撥方法
    websocket.onclose = function(){
        setMessageInnerHTML("close");
    }

    //監聽視窗關閉事件，當視窗關閉時，主動去關閉websocket連線，防止連線還沒斷開就關閉視窗，server端會拋異常。
    window.onbeforeunload = function(){
        websocket.close();
    }

    //將訊息顯示在網頁上
    function setMessageInnerHTML(innerHTML){
        document.getElementById('message').innerHTML += innerHTML + '<br/>';
    }

    //關閉連線
    function closeWebSocket(){
        websocket.close();
    }

    //傳送訊息
    function send(){
        var message = document.getElementById('text').value;
        websocket.send(message);
    }
</script>
</html>

截至此時，SpringBoot核心Tomcat啟動的 websocket已經配置完成，可以投入測試。

測試方式：
1>右鍵專案run as Java Applacation 啟動。
2>編輯前端頁面檔案，將new WebSocket(“ws://localhost:8084/websocket/1”);中的路徑引數修改到
本地儲存即可。
3>雙擊使用瀏覽器開啟此頁面，見到下圖即表明連線成功。

4>連線成功之後即可傳送訊息內容給後臺。後臺Conlose控制檯即可見到此連線使用者資訊。

接下來會講述maven build 打包時所遇到的問題以及外部Tomcat的websocket 配置調整。

在SpringBoot Run As 啟動方式測試成功之後，最終是要將專案部署到伺服器Web容器中去的。那麼，上述程式碼在部署以及打包時會遇到一系列問題。具體解釋如下：

5、初次打包部署
對上述上述程式碼進行maven build 打包操作，我們以war包為例。具體打包操作此處不做闡述。
上述程式碼打包不會報錯。
但是在部署時，基本上都會遇到一個錯誤：
中文解釋是 “非法堆疊異常”，描述是 “@ServerEndpoint 元件註冊失敗”。

Application startup failed
java.lang.IllegalStateException: Failed to register @ServerEndpoint class: class com.iking.tms.util.WebSocket

究其原因，苦思不得其解。在調查了大量資料後，得出如下結論：
1>、tomcat7以下的版本（包含tomcat7部分版本），均不支援websocket。而@ServerEndpoint為javax.websocket包下的。此包在tomcat7後期版本及後續版本中，tomcat的lib目錄下可見。名稱為：“websocket-api.jar”。
2>、出現此問題的原因。
此時要從SpringBoot的特性說起，我們知道SpringBoot Run As 可以快速啟動專案，且能夠即時重新整理。其原因是SpringBoot擁有一個內建的Tomcat，此Tomcat的版本可在pom.xml中指定。每次我們使用SpringBoot Run As啟動專案時，我們的web容器即就是這個內建的Tomcat。此刻web容器連同專案本身都是由Spring進行代理。而當我們將專案打成war包，部署在伺服器上的某個Tomcat下時。此刻我們的專案將會交由這個Tomcat去管理。因為外部Tomcat的優先順序高於Spring內建Tomcat。問題就在這裡。當我們在IDE內使用 SpringBoot Run As去啟動時，Spring會幫我們找到內建Tomcat lib中的javax.websocket包載入使用。所以專案正常執行。而當我們將打好的war包放在外部Tomcat上進行啟動時。Tomcat管理器根據之前的Javax.websocket包的路徑找不到對應的ServerEndpoint類資原始檔，因此自然會註冊失敗。
3>、解決方案。
為了解決此問題，我們可以手動將此包引入專案。
有兩種引入方式：
1>>pom.xml 引入
2>>.jar檔案直接引入
6、解決問題。
兩種解決方案均可，但推薦使用.jar檔案直接copy進專案build path即可。
這裡重點說明pom檔案引入
程式碼如下：
pom做如下配置：

       <dependency>
         <groupId>javax.servlet</groupId>
         <artifactId>javax.servlet-api</artifactId>
         <version>3.1-b07</version>
       </dependency>

之後再打包。打包時可能會出現“javax.servlet-api不存在”的錯誤。出現此錯誤時，我們需要將此jar的路徑手動引入專案。引入方式如下：
參考文件：

當然，在方便專案遷移，引入是自然是要從Tomcat下找到此jar包儲存在專案目錄下的。因此。推薦使用jar檔案直接build path的方式。

7、再次打包。
此時問題已基本解決，打包成功！
部署！
但是會驚奇的發現，部署時仍會報Failed to register @ServerEndpoint。
梳理後發現原因如下。
8、最終問題得解。
上面有簡述過當我們使用外部Tomcat時，專案的管理權將會由Spring交接至Tomcat。
而Tomcat7及後續版本是對websocket直接支援的，且我們所使用的jar包也是tomcat提供的。
但是我們在WebSocketConfig中將ServerEndpointExporter指定給Spring管理。而部署後ServerEndpoint是需要Tomcat直接管理才能生效的。所以此時即就是此包的管理權交接失敗，那肯定不能成功了。最後我們需要將WebSocketConfig中的bean配置註釋掉。然後再打包上傳部署測試。一切正常！

至此，此問題完全解決！

以上為筆者解決SpringBoot實現websocket訊息推送的全部步驟、問題、bug、解決方案以及筆者個人的見解。
文中如有錯誤，還望不吝指正！
筆者郵箱 ： [email protected]