簡版線上聊天Websocket

来源:https://www.cnblogs.com/sky233/archive/2020/05/19/12920291.html
-Advertisement-
Play Games

序言 What is Webscoket ? websocket 應用場景 簡版群聊實現 代碼例子 小結 Webscoket Websokcet 是一種單個 "TCP" 連接上進行 "全雙工" 通信的協議,通過 "HTTP" /1.1 協議的101狀態碼進行握手。 http://websocket. ...


序言

  • What is Webscoket ?

  • websocket 應用場景

  • 簡版群聊實現

  • 代碼例子

  • 小結

Webscoket

Websokcet 是一種單個TCP連接上進行全雙工通信的協議,通過HTTP/1.1 協議的101狀態碼進行握手。

http://websocket.org

Websocket 應用場景

Websocket 和 http 協議都是web通訊協議,兩者有何區別?先說Http,它是一種請求響應協議,這種模型決定了,只能客戶端請求,服務端被動回答。如果我們有服務端主動推送給客戶端的需求怎麼辦?比如一個股票網站,我們會選擇主動輪詢,也就是”拉模式“。

大家可以思考下主動輪詢帶來的問題是什麼?

主動輪詢其實會產生大量無效請求,增加了伺服器壓力。

由此,websocket 協議的補充,為我們帶來了新的解決思路。

簡版群聊實現

利用Websocket 實現一個簡陋群聊功能,加深一下Websocket 理解。

  1. 假設李雷和韓梅梅都登錄線上;
  2. 李雷通過瀏覽器發送消息轉nginx 代理到Ws伺服器;
  3. Ws伺服器載入所有線上會話廣播消息;
  4. 韓梅梅接受到消息。

聊天

代碼例子

後端(shop-server)

  1. 引入pom.xml 依賴

      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-websocket</artifactId>
      </dependency>
    
  2. 配置類

    package com.onlythinking.shop.websocket;
    
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.socket.server.standard.ServerEndpointExporter;
    
    /**
     * <p> The describe </p>
     *
     * @author Li Xingping
     */
    @Slf4j
    @Configuration
    public class WebSocketConfiguration {
    
        @Bean
        public ServerEndpointExporter endpointExporter() {
            return new ServerEndpointExporter();
        }
    
    }
    
  3. 接受請求端點

    package com.onlythinking.shop.websocket;
    
    import com.alibaba.fastjson.JSON;
    import com.google.common.collect.Maps;
    import com.onlythinking.shop.websocket.handler.ChatWsHandler;
    import com.onlythinking.shop.websocket.handler.KfWsHandler;
    import com.onlythinking.shop.websocket.handler.WsHandler;
    import com.onlythinking.shop.websocket.store.WsReqPayLoad;
    import com.onlythinking.shop.websocket.store.WsRespPayLoad;
    import com.onlythinking.shop.websocket.store.WsStore;
    import com.onlythinking.shop.websocket.store.WsUser;
    import lombok.extern.slf4j.Slf4j;
    import org.apache.commons.lang3.StringUtils;
    import org.springframework.stereotype.Component;
    
    import javax.websocket.*;
    import javax.websocket.server.ServerEndpoint;
    import java.io.IOException;
    import java.util.Map;
    
    /**
     * <p> The describe </p>
     *
     * @author Li Xingping
     */
    @Slf4j
    @Component
    @ServerEndpoint("/ws")
    public class WebsocketServerEndpoint {
    
        private static Map<String, WsHandler> wsHandler = Maps.newConcurrentMap();
    
        static {
            wsHandler.put("robot", new KfWsHandler());
            wsHandler.put("chat", new ChatWsHandler());
        }
    
        @OnOpen
        public void onOpen(Session session) {
            log.info("New ws connection {} ", session.getId());
            WsStore.put(session.getId(), WsUser.builder().id(session.getId()).session(session).build());
            respMsg(session, WsRespPayLoad.ok().toJson());
        }
    
        @OnClose
        public void onClose(Session session, CloseReason closeReason) {
            WsStore.remove(session.getId());
            log.warn("ws closed,reason:{}", closeReason);
        }
    
        @OnMessage
        public void onMessage(String message, Session session) {
            log.info("accept client messages: {}" + message);
            WsReqPayLoad payLoad = JSON.parseObject(message, WsReqPayLoad.class);
            if (StringUtils.isBlank(payLoad.getType())) {
                respMsg(session, WsRespPayLoad.ofError("Type is null.").toJson());
                return;
            }
            WsUser wsUser = WsStore.get(session.getId());
            if (null == wsUser || StringUtils.isBlank(wsUser.getUsername())) {
                WsStore.put(session.getId(), WsUser.builder()
                  .id(session.getId())
                  .username(payLoad.getUsername())
                  .avatar(payLoad.getAvatar())
                  .session(session)
                  .build()
                );
            }
            WsHandler handler = wsHandler.get(payLoad.getType());
            if (null != handler) {
                WsRespPayLoad resp = handler.onMessage(session, payLoad);
                if (null != resp) {
                    respMsg(session, resp.toJson());
                }
            } else {
                respMsg(session, WsRespPayLoad.ok().toJson());
            }
        }
    
        @OnError
        public void onError(Session session, Throwable e) {
            WsStore.remove(session.getId());
            log.error("WS Error: ", e);
        }
    
        private void respMsg(Session session, String content) {
            try {
                session.getBasicRemote().sendText(content);
            } catch (IOException e) {
                log.error("Ws resp msg error {} {}", content, e);
            }
        }
    }
    
    
  4. 聊天業務處理器

    package com.onlythinking.shop.websocket.handler;
    
    import com.onlythinking.shop.websocket.store.*;
    import lombok.extern.slf4j.Slf4j;
    
    import javax.websocket.Session;
    import java.util.Date;
    import java.util.List;
    
    /**
     * <p> The describe </p>
     *
     * @author Li Xingping
     */
    @Slf4j
    public class ChatWsHandler implements WsHandler {
    
        @Override
        public WsRespPayLoad onMessage(Session session, WsReqPayLoad payLoad) {
            // 廣播消息
            List<WsUser> allSessions = WsStore.getAll();
            for (WsUser s : allSessions) {
                WsRespPayLoad resp = WsRespPayLoad.builder()
                  .data(
                    WsChatResp.builder()
                      .username(payLoad.getUsername())
                      .avatar(payLoad.getAvatar())
                      .msg(payLoad.getData())
                      .createdTime(new Date())
                      .self(s.getId().equals(session.getId()))
                      .build()
                  )
                  .build();
                log.info("Broadcast message {} {} ", s.getId(), s.getUsername());
                s.getSession().getAsyncRemote().sendText(resp.toJson());
            }
            return null;
        }
    }
    
    

前端(shop-web-mgt)

  1. 引入依賴

    npm install vue-native-websocket --save
    
  2. 添加Store

    import Vue from 'vue'
    
    const ws = {
      state: {
        wsData: {
          hasNewMsg: false,
        },
        socket: {
          isConnected: false,
          message: '',
          reconnectError: false,
        }
      },
      mutations: {
        SET_WSDATA(state, data) {
          state.wsData.hasNewMsg = data.hasNewMsg
        },
        RESET_WSDATA(state, data) {
          state.wsData.hasNewMsg = false
        },
        SOCKET_ONOPEN(state, event) {
          Vue.prototype.$socket = event.currentTarget;
          state.socket.isConnected = true
        },
        SOCKET_ONCLOSE(state, event) {
          state.socket.isConnected = false
        },
        SOCKET_ONERROR(state, event) {
          console.error(state, event)
        },
        // default handler called for all methods
        SOCKET_ONMESSAGE(state, message) {
          state.socket.message = message
        },
        // mutations for reconnect methods
        SOCKET_RECONNECT(state, count) {
          console.info(state, count)
        },
        SOCKET_RECONNECT_ERROR(state) {
          state.socket.reconnectError = true;
        },
      },
      actions: {
        AskRobot({rootGetters}, data) {
          return new Promise((resolve, reject) => {
            console.log('Ask robot msg', data);
            const payLoad = {
              type: 'robot',
              username: rootGetters.loginName,
              data: data
            };
            Vue.prototype.$socket.sendObj(payLoad)
            resolve(1)
          })
        },
        SendChatMsg({rootGetters}, data) {
          return new Promise((resolve, reject) => {
            console.log('Send chat msg', data);
            const payLoad = {
              type: 'chat',
              username: rootGetters.loginName,
              data: data
            };
            Vue.prototype.$socket.sendObj(payLoad)
            resolve(1)
          })
        },
        MessageRead({commit, state}, data) {
          commit('RESET_WSDATA', {})
        },
      }
    };
    
    export default ws
    
    
  3. 編寫組件

    <template>
      <div>
        <ot-drawer
          title="聊天"
          :visible.sync="chatVisible"
          direction="rtl"
          :before-close="handleClose">
          <div class="chat-body">
            <div id="msgList" style="margin-bottom: 200px" class="chat-msg">
              <div class="chat-msg-item" v-for="item in msgList">
                <div v-if="!item.self">
                  <div class="msg-header">
                    <img
                      :src="baseUrl+'/api/insecure/avatar?code='+item.avatar+'&size=64'"
                      class="user-avatar"
                    >
                    <span class="avatar-name">{{item.username}}</span>&nbsp;&nbsp;
                    <div style="display: inline-block; float: right">
                      {{item.createdTime | parseTime('{h}:{i}')}}
                    </div>
                  </div>
                  <div class="msg-body" style="float: left;">
                    {{item.msg}}
                  </div>
                </div>
                <div v-else>
                  <div class="msg-header clearfix">
                    <img
                      :src="baseUrl+'/api/insecure/avatar?code='+item.avatar+'&size=64'"
                      class="user-avatar"
                      style="float: right"
                    >
                  </div>
                  <div class="msg-body" style="float: right;background-color: #67C23A">
                    {{item.msg}}
                  </div>
                </div>
              </div>
            </div>
          </div>
          <div class="chat-send">
            <el-input
              v-model="text"
              autocomplete="off"
              placeholder="請輸入你想說的內容..."
              @keyup.enter.native="handleSendMsg"
            ></el-input>
            <div class="chat-btns">
    
              <el-button
                class="action-item"
                @click="handleClearMsg"
              >清空
              </el-button>
              <el-button
                type="success"
                class="action-item"
                @click="handleSendMsg"
                v-scroll-to="{ el: '#msgList', offset: 140 }"
              >發送
              </el-button>
            </div>
          </div>
        </ot-drawer>
      </div>
    </template>
    
    <script>
    
      import {mapGetters} from 'vuex'
      import store from '@/store'
      import {config} from '@/utils/config'
      import OtDrawer from '@/components/OtDrawer'
      import Cookies from 'js-cookie'
    
      export default {
        name: 'UserChat',
        components: {OtDrawer},
        props: {
          visible: {
            type: Boolean,
            default: false
          }
        },
        data() {
          return {
            baseUrl: config.baseUrl,
            text: '',
            msgList: [],
          }
        },
        computed: {
          ...mapGetters([
            'roles', 'isConnected', 'message', 'reconnectError'
          ]),
          chatVisible: {
            get() {
              return this.visible
            },
            set(val) {
              this.$emit('update:visible', val)
            }
          }
        },
        beforeDestroy() {
          if (this.isConnected) {
            this.$disconnect()
          }
        },
        mounted() {
          console.log('Chat mounted.')
          if (!this.isConnected) {
            this.$connect(config.wsUrl, {
              format: 'json',
              store: store
            })
          }
          // 監聽消息接收
          this.$options.sockets.onmessage = (res) => {
            const data = JSON.parse(res.data);
            console.log('收到消息', data);
            if (data.code === 0) {
              // 連接建立成功
              if (!data.data.msg) {
                return;
              }
              this.msgList.push(data.data)
            } else if (data.code === 400) {
              this.$message({
                type: 'warning',
                message: data.data
              })
            }
          };
        },
        methods: {
          handleSendMsg() {
            if (!this.text) {
              this.$message({
                type: 'warning',
                message: '請輸入內容'
              });
              return;
            }
            this.$store.dispatch('SendChatMsg', this.text).then(data => {
              this.text = ''
            })
          },
          handleClearMsg() {
            this.msgList = [];
            Cookies.remove('chatMsg');
            // 刪除
          },
          // 聊天關閉前
          handleClose() {
            // 緩存消息到本地
            Cookies.set('chatMsg', JSON.stringify(this.msgList));
            this.$emit('update:visible', false)
          }
        },
        created() {
          // 載入緩存數據
          const chatMsg = Cookies.get('chatMsg');
          if (chatMsg) {
            this.msgList = JSON.parse(chatMsg);
          }
        }
      }
    </script>
    
    <style>
      .el-drawer__body {
        height: 100%;
        box-sizing: border-box;
        overflow-y: auto;
        background-color: rgba(244, 244, 244, 1);
        scroll-snap-type: y proximity;
      }
    </style>
    
    <style rel="stylesheet/scss" lang="scss" scoped>
    
      .user-avatar {
        width: 20px;
        height: 20px;
        border-radius: 4px;
        vertical-align: middle;
      }
    
      .msg-header {
        font-size: 12px;
        color: rgba(109, 114, 120, 1);
      }
    
      .avatar-name {
        vertical-align: middle;
      }
    
      .msg-body {
        text-align: center;
        max-width: 300px;
        min-width: 100px;
        word-wrap: break-word;
    
        margin: 4px 0;
        padding: 4px;
        line-height: 24px;
        border-radius: 4px;
        background-color: rgba(255, 255, 255, 1);
      }
    
      .chat-body {
        height: 100%;
        position: relative;
      }
    
      .chat-msg {
        padding: 10px;
    
        .chat-msg-item {
          margin-top: 10px;
          height: 65px;
        }
      }
    
      .chat-send {
        padding: 20px;
        background-color: rgba(255, 255, 255, 1);
        position: absolute;
        left: 50%;
        width: 100%;
        transform: translateX(-50%);
        bottom: 0px;
      }
    
      .chat-btns {
        text-align: center;
      }
    
      .action-item {
        margin-top: 10px;
      }
    </style>
    
    

    Nginx 代理配置 nginx.conf (如有需要可添加)

    map $http_upgrade $connection_upgrade {
        default upgrade;
        '' close;
    }
    
    upstream websocket {
        server 127.0.0.1:8300;
    }
    
    server {
         server_name shop-web-mgt.onlythinking.com;
         listen 443 ssl;
         location / {
             proxy_pass http://websocket;
             proxy_read_timeout 300s;
             proxy_send_timeout 300s;
             
             proxy_set_header Host $host;
             proxy_set_header X-Real-IP $remote_addr;
             proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
             
             proxy_http_version 1.1;
             proxy_set_header Upgrade $http_upgrade;
             proxy_set_header Connection $connection_upgrade;
         }
        ssl_certificate /etc/data/shop-web-mgt.onlythinking.com/full.pem;
        ssl_certificate_key /etc/data/shop-web-mgt.onlythinking.com/privkey.pem;
    }
    

    實現效果圖

    界面比較醜,因為不太擅長,請大家別見笑!!

聊天界面

聊天界面

聊天界面

項目地址

https://github.com/cuteJ/shop-server (後端)

https://github.com/cuteJ/shop-web-mgt (前端)

項目演示地址

http://shop-web-mgt.onlythinking.com

小結

該篇學習Websocket,寫此Demo加深印象!


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 北航OO(2020)第三單元博客作業 [TOC] JML語言總結 理論基礎 JML是用於對Java程式進行規格化設計的一種表示語言,它使用JavaDoc註釋的方式來表示規格。JML以Java語法為基礎併進行了一定的擴充。JML的語法分為幾個層次,下麵對JML Level 0的核心特性進行簡要的總結。 ...
  • 背景 最近一口氣看完了Joshua Bloch大神的 Effective Java (下文簡稱EJ)。書中以tips的形式羅列了Java開發中的最佳實踐,每個tip都將其意圖和要點壓縮在了標題里,這種做法我很喜歡:一來比較親切,比起難啃的系統書,EJ就像是一本Java的《俚語指南》;二來記憶起來十分 ...
  • 發版流程 SNAPSHOT(快照版)--->M1(里程碑1)--->M2--->M3--->RC1(候選版本1)--->RC2--->Release(正式版)--->SR1(正式版第一次修複)--SR2--->SR3 選擇SR2版本之後的版本比較合適。之前的會有很多坑 ...
  • PYTHON 補充知識點 面向對象三大特性:封裝,繼承和多態。 繼承的意義在於兩點: 第一,子類如若繼承自父類,則自動獲取父類所有功能,並且可以在此基礎上再去添加自己獨有的功能。 第二,當子類和父類存在同樣方法時,子類的方法覆寫了父類的代碼,於是子類對象執行的將是子類的方法,即“多態”。 多態到底有 ...
  • 1 前言 良好的代碼習慣是一個優秀程式員應該具備的品質,但靠人的習慣與記憶來保證代碼質量,始終不是一件靠譜的事。在電腦行業應該深知,只要是人為的,都會有操作風險。本文講解如何通過 搭建代碼檢測平臺 ,並使用它來檢測 項目的代碼。 2 Docker安裝SonarQube 2.1 安裝 通過 安裝,方 ...
  • Spring Boot 教程 Mybatis 1. 什麼是Mybatis? MyBatis 是一款優秀的持久層框架,它支持自定義 SQL、存儲過程以及高級映射。MyBatis 免除了幾乎所有的 JDBC 代碼以及設置參數和獲取結果集的工作。MyBatis 可以通過簡單的 XML 或註解來配置和映射原 ...
  • Spring Boot 教程 HelloWorld 1. Spring Boot 的由來 大家都知道,Spring框架是Java生態中舉足輕重的輕量型框架,幫助我們廣大的大佬們進行Java開發。Spring框架的發展非常的迅速,從最開始的Spring核心容器幫助我們管理Java對象,到後來各種業務上 ...
  • C++語言規定,提供預設值時必須按從右至左的順序提供,即有預設值的形參必須在形參列表的最後。如果有某個形參沒有預設值,則它左側的所有形參都不能有預設值。調用函數時,主調函數的實參與被調函數的形參按從左至右的順序進行匹配對應。 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...