HTML5 前端原生 WebSocket 通信

短命女 2022-05-10 17:34 256阅读 0赞

**目录**

HTML5 原生 WebSocket

创建 WebSocket 对象

WebSocket 属性

WebSocket 事件

WebSocket 方法

webSocket 前端演示

--------------------

# HTML5 原生 WebSocket #

1、WebSocket 是 HTML5 开始提供的一种在单个 TCP 连接上进行全双工通讯的协议。

2、WebSocket 使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。

3、WebSocket 中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。

![format_png][]

4、很多网站为了实现推送技术，所用的技术都是 Ajax 轮询，轮询是在特定的的时间间隔（如每1秒），由浏览器对服务器发出HTTP请求，然后由服务器返回最新的数据给客户端的浏览器。这种传统的模式带来很明显的缺点，即浏览器需要不断的向服务器发出请求，然而HTTP请求可能包含较长的头部，其中真正有效的数据可能只是很小的一部分，显然这样会浪费很多的带宽等资源。

5、HTML5 定义的 WebSocket 协议，能更好的节省服务器资源和带宽，并且能够更实时地进行通讯。

6、浏览器通过 JavaScript 向服务器发出建立 WebSocket 连接的请求，连接建立以后，客户端和服务器端就可以通过 TCP 连接直接交换数据。

7、当获取 Web Socket 连接后，可以通过 **send()** 方法来向服务器发送数据，并通过 **onmessage** 事件来接收服务器返回的数据。

# 创建 WebSocket 对象 #

1、var Socket = new WebSocket(url, \[protocol\] );

> 1）url：指定连接的 webSocket 服务器 URL  
> 2）protocol：可选的，指定了可接受的子协议  
> 3）示例：var Socket = new Socket("ws://192.168.1.20/coco/socket/shake.action);  
>     前缀 "ws://" 表示连接协议，如同 http:// 道理一样  
>     192.168.1.20：webSocket 服务器所在的主机 ip，也可以是域名  
>     coco：web 应用的上下文路径  
>     socket/shake.action：web应用的后台访问地址  
>     new WebSocket 创建对象的同时就会发起连接，如果失败，则浏览器控制台报错。

2、WebSocket 协议本质上是一个基于 TCP 的协议。

3、为了建立一个 WebSocket 连接，客户端浏览器首先要向服务器发起一个 HTTP 请求，这个请求和通常的 HTTP 请求不同，包含了一些附加头信息，其中附加头信息"Upgrade: WebSocket"表明这是一个申请协议升级的 HTTP 请求，服务器端解析这些附加的头信息然后产生应答信息返回给客户端，客户端和服务器端的 WebSocket 连接就建立起来了，双方就可以通过这个连接通道自由的传递信息，并且这个连接会持续存在直到客户端或者服务器端的某一方主动的关闭连接。

# WebSocket 属性 #

1、以下是 WebSocket 对象的属性，假定使用了以上代码创建了 Socket 对象：

<table> 
 <tbody> 
  <tr> 
   <th>属性</th> 
   <th>描述</th> 
  </tr> 
  <tr> 
   <td>Socket.readyState</td> 
   <td> <p>只读属性 <strong>readyState</strong> 表示连接状态，可以是以下值：</p> 
    <ul> 
     <li> <p>0 - 表示连接尚未建立。</p> </li> 
     <li> <p>1 - 表示连接已建立，可以进行通信。</p> </li> 
     <li> <p>2 - 表示连接正在进行关闭。</p> </li> 
     <li> <p>3 - 表示连接已经关闭或者连接不能打开。</p> </li> 
    </ul></td> 
  </tr> 
  <tr> 
   <td>Socket.bufferedAmount</td> 
   <td> <p>只读属性 <strong>bufferedAmount</strong> 已被 send() 放入正在队列中等待传输，但是还没有发出的 UTF-8 文本字节数。</p> </td> 
  </tr> 
 </tbody> 
</table>

# WebSocket 事件 #

1、以下是 WebSocket 对象的相关事件，假定使用了以上代码创建了 Socket 对象：

<table> 
 <tbody> 
  <tr> 
   <th>事件</th> 
   <th>事件处理程序</th> 
   <th>描述</th> 
  </tr> 
  <tr> 
   <td>open</td> 
   <td>Socket.onopen</td> 
   <td>连接建立时触发</td> 
  </tr> 
  <tr> 
   <td>message</td> 
   <td>Socket.onmessage</td> 
   <td>客户端接收服务端数据时触发</td> 
  </tr> 
  <tr> 
   <td>error</td> 
   <td>Socket.onerror</td> 
   <td>通信发生错误时触发</td> 
  </tr> 
  <tr> 
   <td>close</td> 
   <td>Socket.onclose</td> 
   <td>连接关闭时触发</td> 
  </tr> 
 </tbody> 
</table>

# WebSocket 方法 #

1、以下是 WebSocket 对象的相关方法，假定使用了以上代码创建了 Socket 对象：

<table> 
 <tbody> 
  <tr> 
   <th>方法</th> 
   <th>描述</th> 
  </tr> 
  <tr> 
   <td>Socket.send()</td> 
   <td> <p>使用连接发送数据</p> </td> 
  </tr> 
  <tr> 
   <td>Socket.close()</td> 
   <td> <p>关闭连接</p> </td> 
  </tr> 
 </tbody> 
</table>

# webSocket 前端演示 #

1、webSocket 的服务器代码不进行展示，Java 开发人员可以使用 JDK 自带的 webSocket API 或者使用 Spring 提供的 API。

2、浏览器客户端代码示例如下：

<!DOCTYPE html>
    <html lang="en">
    <head>
        <meta charset="UTF-8">
        <title></title>
        
        <script src="https://code.jquery.com/jquery-3.3.1.min.js"
                integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8="
                crossorigin="anonymous"></script>
        <script type="text/javascript">
            /**
             * web socket 绑定
             */
            function webSocketBind() {
                /**主流浏览器都支持 webSocket 通信，但建议还是要判断*/
                if ("WebSocket" in window) {
                    /**创建 web socket 实例
                     * 如果连接失败，浏览器控制台报错，连接失败
                     * 前缀 ws:// 必须正确，weChatInteract 是应用名称，webSocket/shake.action 是后台访问路径
                     * */
                    var ws = new WebSocket("ws://192.168.1.20/weChatInteract/webSocket/shake.action");
    
                    /**onopen：服务器连接成功后，自动触发*/
                    ws.onopen = function () {
                        /** Web Socket 已连接上，使用 send() 方法发送数据*/
                        ws.send("connect success...");
                        console.log("服务器连接成功，并发送数据到后台...");
                    };
    
                    /**服务器发送数据后，自动触发此方法，客户端进行获取数据，使用 evt.data 获取数据*/
                    ws.onmessage = function (evt) {
                        var received_msg = evt.data;
                        console.log("接收到服务器数据：" + received_msg);
                    };
    
                    /**客户端与服务器数据传输错误时触发*/
                    ws.onerror = function (evt) {
                        console.log("客户端 与 服务器 数据传输错误...");
                    };
    
                    /**web Socket 连接关闭时触发*/
                    ws.onclose = function () {
                        console.log("web scoket 连接关闭...");
                    };
                } else {
                    alert("您的浏览器不支持 WebSocket!");
                }
            }
            $(function () {
                webSocketBind();
            });
        </script>
    </head>
    <body>
    </body>
    </html>

浏览器客户端信息如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdteDE5OTMzMjg_size_16_color_FFFFFF_t_70][]

可参考：SpringBoot 2.1.0 整合 Tomcat WebSocket 通信：[https://wangmaoxiong.blog.csdn.net/article/details/84582904][https_wangmaoxiong.blog.csdn.net_article_details_84582904]

[format_png]: /images/20220505/8eba050124eb42199f0c2eb30617c0f1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdteDE5OTMzMjg_size_16_color_FFFFFF_t_70]: /images/20220505/f001682637794b90b15791b6d8c4a38d.png
[https_wangmaoxiong.blog.csdn.net_article_details_84582904]: https://wangmaoxiong.blog.csdn.net/article/details/84582904