nodejs之websocket即时通讯实现（Socket.io）

古城微笑少年丶 2023-10-02 12:38 8阅读 0赞

### 为什么要用 websocket ###

websocket 是一种网络通信协议，一般用来进行实时通信会使用到。

websocket 协议和 http 协议类似，http 协议有一个缺陷，只能由客户方端发起请求，服务端根据请求 url 和传过去的参数返回对应结果

websocket 是`双向通信`的，只要 websocket 连接建立起来，可以由客户端给服务端发送数据，也可以由服务端主动给客户端发送数据

websocket 适用场景：网页版聊天室，网页版客服，前后端频繁交换数据的即时通讯场景。

### Socket.io ###

双向和低延迟的websocket通信包，高性能，高可靠，可伸缩。  
（简单地讲，就是将websocket进行封装和优化。）  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBATW9zaG936YOR6ZS0_size_20_color_FFFFFF_t_70_g_se_x_16]  
Socket.IO 是一个库，可以在浏览器和服务器之间实现实时、双向和基于事件的通信。 它包括：

*  server端
 *  client端  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBATW9zaG936YOR6ZS0_size_20_color_FFFFFF_t_70_g_se_x_16 1]

官方网址  
[https://socket.io/][https_socket.io]  
官方文档  
[https://socket.io/docs/v4/][https_socket.io_docs_v4]

### 开源项目 ###

以下代码和时间项目会发布在开源项目【nodejs-study】，欢迎下载和学习

### 效果预览 ###

输入`node app` 运行服务之后可以通过 [http://localhost:3000/][http_localhost_3000] 进行访问，如果看到输出监听3000端口和前端显示hello world证明项目启动成功。  
![在这里插入图片描述][223cd947daed4df38cf4b2fabfabf19b.png]

前端页面：一个聊天的UI框，包含发送和接收功能 [http://localhost:3000/test][http_localhost_3000_test]  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBATW9zaG936YOR6ZS0_size_20_color_FFFFFF_t_70_g_se_x_16 2]  
后台websocket：监听和答复  
![在这里插入图片描述][c59b0ea0dc6a4c3db540715dbb58ed2d.png]

### app.js ###

首先需要安装express和socket.io库

输入`npm install express --save`或者`yarn add express`

输入`npm install socket.io--save`或者`yarn add socket,io`

接下来实现 对 `/` 和 `/test` 两个路径的监听

*  `/`返回hello world
 *  `/test`返回html连接页面
 *

`socket.on`(“chat message”,callback function)  
表示开始监听"chat message"通道，只要前后端都是一致的通道即可。

`socket.emit`(“chat message”, msg.toUpperCase());  
表示对这个"chat message"通道进行回复，我们暂时是对英文字母做大写处理并返回。

### index.html ###

这做一些样式处理，并且有以下body内容：

*  message的ul，可以用来追加li信息，显示记录往来
 *  一个form表单，用来提交要发送的信息

script部分而言，首先使用官方的socket.io 的js client ， 初始化一个连接，添加监听事件：

*  输入非空内容提交后，发送信息给websocket后台，同事也输出在信息列表
 *  接收到信息之后，显示在信息列表

<!DOCTYPE html>
    <html>
      <head>
        <title>Socket.IO chat</title>
        <style>
          body {
         margin: 0; padding-bottom: 3rem; font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif; }
    
          #form {
         background: rgba(0, 0, 0, 0.15); padding: 0.25rem; position: fixed; bottom: 0; left: 0; right: 0; display: flex; height: 3rem; box-sizing: border-box; backdrop-filter: blur(10px); }
          #input {
         border: none; padding: 0 1rem; flex-grow: 1; border-radius: 2rem; margin: 0.25rem; }
          #input:focus {
         outline: none; }
          #form > button {
         background: #333; border: none; padding: 0 1rem; margin: 0.25rem; border-radius: 3px; outline: none; color: #fff; }
    
          #messages {
         list-style-type: none; margin: 0; padding: 0; }
          #messages > li {
         padding: 0.5rem 1rem; }
          #messages > li:nth-child(odd) {
         background: #efefef; }
        </style>
      </head>
      <body>
        <ul id="messages"></ul>
        <form id="form" action="">
          <input id="input" autocomplete="off" /><button>Send</button>
        </form>
      </body>
      <script src="/socket.io/socket.io.js"></script>
      <script>
        var socket = io();
        
        var messages = document.getElementById('messages');
        var form = document.getElementById('form');
        var input = document.getElementById('input');
    
        //输出到屏幕
        function addMessage(str){
        
            const li = document.createElement("li")
            li.innerHTML=str;
            messages.appendChild(li); 
            
        }
        // console.log(form)
        form.addEventListener('submit', function(e) {
        
          e.preventDefault();
          if (input.value) {
        
            //Socket.io by zhengkai.blog.csdn.net
            let msg = '发送消息:'+input.value ;
            console.log(msg)
            socket.emit('chat message', input.value);
            addMessage(msg);
            //清空个输入框
            //input.value = '';
          }
        });
        socket.on("chat message", (arg) => {
        
            let msg = '接收消息:'+arg ;
            console.log(msg); // world
            addMessage(msg);
        }); 
      </script>
      
    </html>

[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBATW9zaG936YOR6ZS0_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/719211e28abf409aadeee2dddef43c5b.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBATW9zaG936YOR6ZS0,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBATW9zaG936YOR6ZS0_size_20_color_FFFFFF_t_70_g_se_x_16 1]: https://img-blog.csdnimg.cn/06a89c9c5b8e46eb8cf1bc303589a0c4.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBATW9zaG936YOR6ZS0,size_20,color_FFFFFF,t_70,g_se,x_16
[https_socket.io]: https://socket.io/
[https_socket.io_docs_v4]: https://socket.io/docs/v4/
[http_localhost_3000]: http://localhost:3000/
[223cd947daed4df38cf4b2fabfabf19b.png]: https://img-blog.csdnimg.cn/223cd947daed4df38cf4b2fabfabf19b.png
[http_localhost_3000_test]: http://localhost:3000/test
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBATW9zaG936YOR6ZS0_size_20_color_FFFFFF_t_70_g_se_x_16 2]: https://img-blog.csdnimg.cn/579d84b74cd84feab17ae126c0c8149d.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBATW9zaG936YOR6ZS0,size_20,color_FFFFFF,t_70,g_se,x_16
[c59b0ea0dc6a4c3db540715dbb58ed2d.png]: https://img-blog.csdnimg.cn/c59b0ea0dc6a4c3db540715dbb58ed2d.png