4秉馏、spring boot + websocket 通信入門

認(rèn)識HTML5的WebSocket

WebSocket是HTML5開始提供的一種在單個 TCP 連接上進(jìn)行全雙工通訊的協(xié)議堤框。

在WebSocket API中栖榨,瀏覽器和服務(wù)器只需要做一個握手的動作自沧,然后坟奥,瀏覽器和服務(wù)器之間就形成了一條快速通道树瞭。兩者之間就直接可以數(shù)據(jù)互相傳送。

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

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

引入websocket依賴寺旺,核心包

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

配置bean爷抓,名為ServerEndpointExporter

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

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

websocket簡單的例子

import java.io.IOException;
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.ServerEndpoint;

import org.springframework.stereotype.Component;

/**
 * @ServerEndpoint 注解是一個類層次的注解,它的功能主要是將目前的類定義成一個websocket服務(wù)器端,
 * 注解的值將被用于監(jiān)聽用戶連接的終端訪問URL地址,客戶端可以通過這個URL來連接到WebSocket服務(wù)器端
 * @describe 描述:
 * @author 作者:內(nèi)酷拉拉
 * @time 創(chuàng)建時間:2017年8月16日 下午3:21:20
 */
@ServerEndpoint("/mywebsocket")  
@Component
public class WebSocketTest {
        //靜態(tài)變量阻塑,用來記錄當(dāng)前在線連接數(shù)蓝撇。應(yīng)該把它設(shè)計成線程安全的。
        private static int onlineCount = 0;
        //concurrent包的線程安全Set陈莽,用來存放每個客戶端對應(yīng)的MyWebSocket對象渤昌。若要實現(xiàn)服務(wù)端與單一客戶端通信的話,可以使用Map來存放走搁,其中Key可以為用戶標(biāo)識
        private static CopyOnWriteArraySet<WebSocketTest> webSocketSet = new CopyOnWriteArraySet<WebSocketTest>();
        //與某個客戶端的連接會話独柑,需要通過它來給客戶端發(fā)送數(shù)據(jù)
        private Session session;
        /**
        * 連接建立成功調(diào)用的方法
        * @param session 可選的參數(shù)。session為與某個客戶端的連接會話朱盐,需要通過它來給客戶端發(fā)送數(shù)據(jù)
        */
        @OnOpen
        public void onOpen(Session session){
                this.session = session;
                webSocketSet.add(this); //加入set中
                addOnlineCount(); //在線數(shù)加
                System.out.println("有新連接加入群嗤!當(dāng)前在線人數(shù)為" + getOnlineCount());
        }
        /**
        * 連接關(guān)閉調(diào)用的方法
        */
        @OnClose
        public void onClose(){
                webSocketSet.remove(this); //從set中刪除
                subOnlineCount(); //在線數(shù)減
                System.out.println("有一連接關(guān)閉菠隆!當(dāng)前在線人數(shù)為" + getOnlineCount());
        }
        /**
        * 收到客戶端消息后調(diào)用的方法
        * @param message 客戶端發(fā)送過來的消息
        * @param session 可選的參數(shù)
        */
        @OnMessage
        public void onMessage(String message, Session session) {
            System.out.println("來自客戶端的消息:" + message);
            //群發(fā)消息
            for(WebSocketTest item: webSocketSet){
                try {
                    item.sendMessage(message);
                } catch (IOException e) {
                    e.printStackTrace();
                    continue;
                }
            }
        }
        /**
        * 發(fā)生錯誤時調(diào)用
        * @param session
        * @param error
        */
        @OnError
        public void onError(Session session, Throwable error){
            System.out.println("發(fā)生錯誤");
            error.printStackTrace();
        }
        /**
        * 這個方法與上面幾個方法不一樣兵琳。沒有用注解,是根據(jù)自己需要添加的方法骇径。
        * @param message
        * @throws IOException
        */
        public void sendMessage(String message) throws IOException{
            this.session.getBasicRemote().sendText(message);
            //this.session.getAsyncRemote().sendText(message);
        }
        public static synchronized int getOnlineCount() {
            return onlineCount;
        }
        public static synchronized void addOnlineCount() {
            WebSocketTest.onlineCount++;
        }
        public static synchronized void subOnlineCount() {
            WebSocketTest.onlineCount--;
        }
}

html代碼

<html xmlns:th="http://www.thymeleaf.org">
  <head>
     <meta content="text/html;charset=UTF-8"/>
     <meta charset="UTF-8" />
     <meta http-equiv="X-UA-Compatible" content="IE=edge"/>
     <meta name="viewport" content="width=device-width, initial-scale=1"/>
  </head>
<body>
        webSocket初見<br/>
        <input id="text" type="text"/>
        <button onclick="send()">發(fā)送消息</button>
        <hr/>
        <button onclick="closeWebSocket()">關(guān)閉WebSocket連接</button>
        <hr/>
        <div id="message"></div>
        <script type="text/javascript">
        var websocket = null;
        //判斷當(dāng)前瀏覽器是否支持WebSocket
        if ('WebSocket' in window) {
            websocket = new WebSocket("ws://localhost:9001/wesocket/mywebsocket");
        }
        else {
            alert('當(dāng)前瀏覽器 Not support websocket')
        }
        //連接發(fā)生錯誤的回調(diào)方法
        websocket.onerror = function () {
            setMessageInnerHTML("WebSocket連接發(fā)生錯誤");
        };
        //連接成功建立的回調(diào)方法
        websocket.onopen = function () {
            setMessageInnerHTML("WebSocket連接成功");
        }
        //接收到消息的回調(diào)方法
        websocket.onmessage = function (event) {
            setMessageInnerHTML(event.data);
        }
        //連接關(guān)閉的回調(diào)方法
        websocket.onclose = function () {
            setMessageInnerHTML("WebSocket連接關(guān)閉");
        }
        //監(jiān)聽窗口關(guān)閉事件躯肌,當(dāng)窗口關(guān)閉時,主動去關(guān)閉websocket連接破衔,防止連接還沒斷開就關(guān)閉窗口清女,server端會拋異常。
        window.onbeforeunload = function () {
            closeWebSocket();
        }
        //將消息顯示在網(wǎng)頁上
        function setMessageInnerHTML(innerHTML) {
            document.getElementById('message').innerHTML += innerHTML + '<br/>';
        }
        //關(guān)閉WebSocket連接
        function closeWebSocket() {
            websocket.close();
        }
        //發(fā)送消息
        function send() {
            var message = document.getElementById('text').value;
            websocket.send(message);
        }
        </script>
</body>
 </html>
結(jié)果展示
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末晰筛,一起剝皮案震驚了整個濱河市嫡丙,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌读第,老刑警劉巖曙博,帶你破解...
    沈念sama閱讀 216,692評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異怜瞒,居然都是意外死亡父泳,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,482評論 3 392
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來惠窄,“玉大人蒸眠,你說我怎么就攤上這事「巳冢” “怎么了楞卡?”我有些...
    開封第一講書人閱讀 162,995評論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長擒贸。 經(jīng)常有香客問我臀晃,道長,這世上最難降的妖魔是什么介劫? 我笑而不...
    開封第一講書人閱讀 58,223評論 1 292
  • 正文 為了忘掉前任徽惋,我火速辦了婚禮,結(jié)果婚禮上座韵,老公的妹妹穿的比我還像新娘险绘。我一直安慰自己,他們只是感情好誉碴,可當(dāng)我...
    茶點故事閱讀 67,245評論 6 388
  • 文/花漫 我一把揭開白布宦棺。 她就那樣靜靜地躺著,像睡著了一般黔帕。 火紅的嫁衣襯著肌膚如雪代咸。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,208評論 1 299
  • 那天成黄,我揣著相機(jī)與錄音呐芥,去河邊找鬼。 笑死奋岁,一個胖子當(dāng)著我的面吹牛思瘟,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播闻伶,決...
    沈念sama閱讀 40,091評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼滨攻,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了蓝翰?” 一聲冷哼從身側(cè)響起光绕,我...
    開封第一講書人閱讀 38,929評論 0 274
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎畜份,沒想到半個月后诞帐,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,346評論 1 311
  • 正文 獨居荒郊野嶺守林人離奇死亡漂坏,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,570評論 2 333
  • 正文 我和宋清朗相戀三年景埃,在試婚紗的時候發(fā)現(xiàn)自己被綠了媒至。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,739評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡谷徙,死狀恐怖拒啰,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情完慧,我是刑警寧澤谋旦,帶...
    沈念sama閱讀 35,437評論 5 344
  • 正文 年R本政府宣布,位于F島的核電站屈尼,受9級特大地震影響册着,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜脾歧,卻給世界環(huán)境...
    茶點故事閱讀 41,037評論 3 326
  • 文/蒙蒙 一甲捏、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧鞭执,春花似錦司顿、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,677評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至估脆,卻和暖如春钦奋,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背疙赠。 一陣腳步聲響...
    開封第一講書人閱讀 32,833評論 1 269
  • 我被黑心中介騙來泰國打工付材, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人棺聊。 一個月前我還...
    沈念sama閱讀 47,760評論 2 369
  • 正文 我出身青樓伞租,卻偏偏與公主長得像贞谓,于是被迫代替她去往敵國和親限佩。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,647評論 2 354

推薦閱讀更多精彩內(nèi)容