WebSocket协议状态码解析_websocket状态码

WebSocket协议状态码解析

1. 引言

WebSocket协议是一种基于TCP的全双工通信协议，它允许客户端和服务器之间进行实时的双向通信。在WebSocket通信过程中，服务器和客户端会通过状态码来表示当前通信的状态或错误信息。

2. WebSocket协议状态码概述

WebSocket协议状态码是一个16位的整数，用于表示WebSocket连接的状态。状态码的第一个数字表示状态的分类，后三个数字表示具体的状态。根据WebSocket协议的规范，状态码可以分为以下几类：

• 1xxx：表示信息性状态码，用于传递一些非错误信息。
• 2xxx：表示成功状态码，用于表示连接成功或操作成功。
• 3xxx：表示重定向状态码，用于表示需要进一步操作以完成请求。
• 4xxx：表示客户端错误状态码，用于表示客户端发送的请求有误。
• 5xxx：表示服务器错误状态码，用于表示服务器无法完成请求。

常见的WebSocket协议状态码有：

• 1000：正常关闭
• 1001：终端离开
• 1002：协议错误
• 1003：数据类型错误
• 1005：无法接收
• 1006：连接关闭异常
• 1011：服务器遇到异常

3. WebSocket协议状态码详解

3.1 WebSocket协议状态码1000：正常关闭

状态码1000表示WebSocket连接正常关闭。当服务器或客户端决定关闭连接时，会发送状态码1000给对方，表示连接关闭的原因是正常的。

3.2 WebSocket协议状态码1001：终端离开

状态码1001表示客户端离开。当客户端主动关闭连接时，会发送状态码1001给服务器，表示客户端离开。

3.3 WebSocket协议状态码1002：协议错误

状态码1002表示协议错误。当服务器或客户端收到的数据不符合WebSocket协议的规范时，会发送状态码1002给对方，表示协议错误。

3.4 WebSocket协议状态码1003：数据类型错误

状态码1003表示数据类型错误。当服务器或客户端收到的数据类型不符合预期时，会发送状态码1003给对方，表示数据类型错误。

3.5 WebSocket协议状态码1005：无法接收

状态码1005表示无法接收数据。当服务器或客户端由于某些原因无法接收数据时，会发送状态码1005给对方，表示无法接收。

3.6 WebSocket协议状态码1006：连接关闭异常

状态码1006表示连接关闭异常。当服务器或客户端在关闭连接时遇到异常情况时，会发送状态码1006给对方，表示连接关闭异常。

3.7 WebSocket协议状态码1011：服务器遇到异常

状态码1011表示服务器遇到异常。当服务器在处理WebSocket请求时遇到异常情况时，会发送状态码1011给客户端，表示服务器遇到异常。

4. WebSocket协议状态码的使用场景

在使用WebSocket协议时，我们需要正确处理状态码以及相应的错误情况。以下是一些处理WebSocket协议状态码的示例：

// 客户端代码示例
const socket = new WebSocket('ws://example.com');

socket.onopen = function() {
```javascript
    console.log('WebSocket连接已打开');
};

socket.onmessage = function(event) {
    console.log('收到消息：', event.data);
};

socket.onclose = function(event) {
    if (event.code === 1000) {
        console.log('WebSocket连接正常关闭');
    } else if (event.code === 1001) {
        console.log('WebSocket连接被客户端关闭');
    } else if (event.code === 1006) {
        console.log('WebSocket连接关闭异常');
    } else {
        console.log('WebSocket连接关闭，状态码：', event.code);
    }
};

socket.onerror = function(error) {
    console.error('WebSocket连接发生错误：', error);
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

在上述示例中，我们使用了WebSocket的四个事件处理函数来处理不同的状态码和错误情况。当连接成功打开时，会触发onopen事件；当收到消息时，会触发onmessage事件；当连接关闭时，会触发onclose事件；当连接发生错误时，会触发onerror事件。在onclose事件中，我们根据不同的状态码来进行相应的处理。

5. WebSocket协议状态码的扩展

除了使用WebSocket协议规定的状态码外，我们还可以自定义WebSocket协议状态码来满足特定的需求。下面是一个自定义WebSocket协议状态码的示例：

// 服务端代码示例
const http = require('http');
const server = http.createServer();

server.on('upgrade', (request, socket, head) => {
    const responseHeaders = [
        'HTTP/1.1 101 Switching Protocols',
        'Upgrade: websocket',
        'Connection: Upgrade',
        'Sec-WebSocket-Accept: ' + generateAcceptKey(request.headers['sec-websocket-key']),
        'Sec-WebSocket-Protocol: custom-protocol',
        'Custom-Status: 2000',
        '\r\n'
    ];

    socket.write(responseHeaders.join('\r\n'));

    // ... 处理WebSocket连接
});

function generateAcceptKey(key) {
    // 生成Sec-WebSocket-Accept头部的值
    // ...
}

server.listen(8080);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

在上述示例中，我们在服务端的响应头中添加了一个自定义的头部字段Custom-Status，用于表示自定义的状态码。客户端在收到服务端响应后，可以根据Custom-Status头部字段来判断自定义的状态码。

6. 总结

WebSocket协议状态码是用于表示WebSocket连接状态或错误信息的一种机制。我们可以根据不同的状态码来处理相应的情况，确保WebSocket通信的稳定性和可靠性。同时，我们还可以扩展WebSocket协议状态码，以满足特定的需求。

7. 参考文献

• RFC 6455 - The WebSocket Protocol