Spring Boot + WebSocket 實時監控，實戰來了！

寫在前面

此異常非彼異常，標題所說的異常是業務上的異常。

最近做了一個需求，消防的設備巡檢，如果巡檢發現異常，通過手機端提交，後臺的實時監控頁面實時獲取到該設備的信息及位置，然後安排員工去處理。

因爲需要服務端主動向客戶端發送消息，所以很容易的就想到了用WebSocket來實現這一功能。

WebSocket就不做介紹了，上鍊接：

https://developer.mozilla.org/zh-CN/docs/Web/API/WebSocket

前端略微複雜，需要在一張位置分佈圖上進行鼠標描點定位各個設備和根據不同屏幕大小渲染，本文不做介紹，只是簡單地用頁面樣式進行效果呈現。

推薦一個開源免費的 Spring Boot 實戰項目：

https://github.com/javastacks/spring-boot-best-practice

綠色代表正常，紅色代表異常

預期效果，未接收到請求前----->id爲3的提交了異常，id爲3的王五變成了紅色

實現

前端：

直接貼代碼

<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8" />
        <title>實時監控</title>
    </head>
    <style>
        .item {
            display: flex;
            border-bottom: 1px solid #000000;
            justify-content: space-between;
            width: 30%;
            line-height: 50px;
            height: 50px;
        }

        .item span:nth-child(2){
            margin-right: 10px;
            margin-top: 15px;
            width: 20px;
            height: 20px;
            border-radius: 50%;
            background: #55ff00;
        }
        .nowI{
            background: #ff0000 !important;
        }
    </style>
    <body>
        <div id="app">
            <div v-for="item in list" class="item">
                <span>{{item.id}}.{{item.name}}</span>
                <span :class='item.state==-1?"nowI":""'></span>
            </div>
        </div>
    </body>
    <script src="./js/vue.min.js"></script>
    <script type="text/javascript">
        var vm = new Vue({
            el: "#app",
            data: {
                list: [{
                        id: 1,
                        name: '張三',
                        state: 1
                    },
                    {
                        id: 2,
                        name: '李四',
                        state: 1
                    },
                    {
                        id: 3,
                        name: '王五',
                        state: 1
                    },
                    {
                        id: 4,
                        name: '韓梅梅',
                        state: 1
                    },
                    {
                        id: 5,
                        name: '李磊',
                        state: 1
                    },
                ]
            }
        })

        var webSocket = null;
        if ('WebSocket' in window) {
            //創建WebSocket對象
            webSocket = new WebSocket("ws://localhost:18801/webSocket/" + getUUID());

            //連接成功
            webSocket.onopen = function() {
                console.log("已連接");
                webSocket.send("消息發送測試")
            }
            //接收到消息
            webSocket.onmessage = function(msg) {
                //處理消息
                var serverMsg = msg.data;
                var t_id = parseInt(serverMsg)    //服務端發過來的消息，ID，string需轉化爲int類型才能比較
                for (var i = 0; i < vm.list.length; i++) {
                    var item = vm.list[i];
                    if(item.id == t_id){
                        item.state = -1;
                        vm.list.splice(i,1,item)
                        break;
                    }
                }
            };

            //關閉事件
            webSocket.onclose = function() {
                console.log("websocket已關閉");
            };
            //發生了錯誤事件
            webSocket.onerror = function() {
                console.log("websocket發生了錯誤");
            }
        } else {
            alert("很遺憾，您的瀏覽器不支持WebSocket！")
        }

        function getUUID() {    //獲取唯一的UUID
            return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function(c) {

                var r = Math.random() * 16 | 0,
                    v = c == 'x' ? r : (r & 0x3 | 0x8);
                return v.toString(16);
            });
        }
    </script>
</html>

後端：

Spring Boot 基礎就不介紹了，推薦看這個實戰項目：

https://github.com/javastacks/spring-boot-best-practice

項目結構是這樣子的，後面的代碼關鍵註釋都有，就不重複描述了

1、新建SpringBoot工程，選擇web和WebSocket依賴

2、配置application.yml

#端口
server:
  port: 18801

#密碼，因爲接口不需要權限，所以加了個密碼做校驗
mySocket:
  myPwd: jae_123

3、WebSocketConfig配置類

@Configuration
public class WebSocketConfig {

    /**
     * 注入一個ServerEndpointExporter,該Bean會自動註冊使用@ServerEndpoint註解申明的websocket endpoint
     */
    @Bean
    public ServerEndpointExporter serverEndpointExporter(){
        return new ServerEndpointExporter();
    }
}

4、WebSocketServer類，用來進行服務端和客戶端之間的交互

/**
 * @author jae
 * @ServerEndpoint("/webSocket/{uid}") 前端通過此URI與後端建立鏈接
 */

@ServerEndpoint("/webSocket/{uid}")
@Component
public class WebSocketServer {

    private static Logger log = LoggerFactory.getLogger(WebSocketServer.class);

    //靜態變量，用來記錄當前在線連接數。應該把它設計成線程安全的。
    private static final AtomicInteger onlineNum = new AtomicInteger(0);

    //concurrent包的線程安全Set，用來存放每個客戶端對應的WebSocketServer對象。
    private static CopyOnWriteArraySet<Session> sessionPools = new CopyOnWriteArraySet<Session>();

    /**
     * 有客戶端連接成功
     */
    @OnOpen
    public void onOpen(Session session, @PathParam(value = "uid") String uid){
        sessionPools.add(session);
        onlineNum.incrementAndGet();
        log.info(uid + "加入webSocket！當前人數爲" + onlineNum);
    }

    /**
     * 連接關閉調用的方法
     */
    @OnClose
    public void onClose(Session session) {
        sessionPools.remove(session);
        int cnt = onlineNum.decrementAndGet();
        log.info("有連接關閉，當前連接數爲：{}", cnt);
    }

    /**
     * 發送消息
     */
    public void sendMessage(Session session, String message) throws IOException {
        if(session != null){
            synchronized (session) {
                session.getBasicRemote().sendText(message);
            }
        }
    }

    /**
     * 羣發消息
     */
    public void broadCastInfo(String message) throws IOException {
        for (Session session : sessionPools) {
            if(session.isOpen()){
                sendMessage(session, message);
            }
        }
    }

    /**
     * 發生錯誤
     */
    @OnError
    public void onError(Session session, Throwable throwable){
        log.error("發生錯誤");
        throwable.printStackTrace();
    }

}

5、WebSocketController類，用於進行接口測試

@RestController
@RequestMapping("/open/socket")
public class WebSocketController {

    @Value("${mySocket.myPwd}")
    public String myPwd;

    @Autowired
    private WebSocketServer webSocketServer;

    /**
     * 手機客戶端請求接口
     * @param id    發生異常的設備ID
     * @param pwd   密碼（實際開發記得加密）
     * @throws IOException
     */
    @PostMapping(value = "/onReceive")
    public void onReceive(String id,String pwd) throws IOException {
        if(pwd.equals(myPwd)){  //密碼校驗一致（這裏舉例，實際開發還要有個密碼加密的校驗的），則進行羣發
            webSocketServer.broadCastInfo(id);
        }
    }

}