一、WebSocket握手失败原因排查切入点
在互联网应用开发里，WebSocket可是个好东西，它能让客户端和服务器之间实现双向通信，像实时聊天、在线游戏、股票行情实时更新这类场景都用得上它。不过在这个过程中，握手失败是让人头疼的问题。握手就是客户端和服务器建立WebSocket连接的第一步，要是失败了，后续的双向通信就别想了。而这其中HTTP头校验细节往往是导致失败的隐藏原因。
1.1 WebSocket握手原理
简单来说，WebSocket握手是客户端和服务器之间的一场“对话”。客户端先向服务器发送一个HTTP请求，这个请求和普通的HTTP请求有点不一样，它表明客户端想升级到WebSocket协议。服务器收到请求后，会检查请求里的HTTP头信息，如果符合要求，就会返回一个带有特定响应头的HTTP响应，告诉客户端“行，咱可以开始WebSocket通信啦”。
下面是一个简单的Python代码示例，用asyncio和websockets库演示客户端发送握手请求：
import asyncio
import websockets
async def hello():
uri = "ws://localhost:8765"
# 尝试连接到服务器
async with websockets.connect(uri) as websocket:
print("WebSocket连接成功")
# 运行异步函数
asyncio.get_event_loop().run_until_complete(hello())
1.2 为什么HTTP头这么重要
HTTP头就像是这场“对话”的规则说明书。客户端和服务器都按照这些规则来解读对方的意图。要是头信息里的某个参数不符合规则，服务器就会觉得这个请求有问题，直接拒绝握手。比如说，在Connection和Upgrade头里，服务器规定必须是特定的值，客户端要是发错了，握手就得失败。
二、容易忽略的HTTP头校验细节
2.1 Connection和Upgrade头
2.1.1 规则要求
Connection头的值必须是Upgrade，这表示客户端想把当前的HTTP连接升级到其他协议。Upgrade头的值必须是websocket，明确告诉服务器要升级到WebSocket协议。
2.1.2 示例分析
下面是一个正确的客户端HTTP请求头示例：
GET /ws HTTP/1.1
Host: example.com
Connection: Upgrade
Upgrade: websocket
要是客户端把Connection头写成了别的值，比如Keep-Alive，服务器就会认为这个请求没有升级连接的意图，直接拒绝握手。错误示例如下：
GET /ws HTTP/1.1
Host: example.com
Connection: Keep-Alive
Upgrade: websocket
2.2 Sec-WebSocket-Key和Sec-WebSocket-Accept头
2.2.1 生成规则
Sec-WebSocket-Key是客户端生成的一个Base64编码的随机字符串，长度是16字节。服务器收到这个Sec-WebSocket-Key后，会把它和一个固定的GUID（全球唯一标识符）拼接起来，然后用SHA-1算法计算哈希值，最后再把哈希值进行Base64编码，得到Sec-WebSocket-Accept的值。
2.2.2 示例演示
下面是Python代码实现客户端生成Sec-WebSocket-Key和服务器验证Sec-WebSocket-Accept的示例：
import base64
import hashlib
import os
# 客户端生成Sec-WebSocket-Key
key = base64.b64encode(os.urandom(16)).decode('utf-8')
print(f"客户端生成的Sec-WebSocket-Key: {key}")
# 服务器端验证Sec-WebSocket-Accept
GUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
accept = base64.b64encode(hashlib.sha1((key + GUID).encode('utf-8')).digest()).decode('utf-8')
print(f"服务器计算的Sec-WebSocket-Accept: {accept}")
要是客户端和服务器在计算过程中出了错，比如客户端生成的Sec-WebSocket-Key长度不对，或者服务器在计算Sec-WebSocket-Accept时用错了算法，握手就会失败。
2.3 Sec-WebSocket-Version头
2.3.1 版本要求
这个头用来指定客户端支持的WebSocket协议版本，目前主流的版本是13。服务器会检查这个头的值，如果客户端指定的版本不在服务器支持的范围内，服务器会返回一个错误，拒绝握手。
2.3.2 示例说明
正确的客户端请求头应该是这样的：
GET /ws HTTP/1.1
Host: example.com
Connection: Upgrade
Upgrade: websocket
Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==
Sec-WebSocket-Version: 13
要是客户端把Sec-WebSocket-Version写成了别的值，比如12，而服务器只支持版本13，握手就会失败。错误示例如下：
GET /ws HTTP/1.1
Host: example.com
Connection: Upgrade
Upgrade: websocket
Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==
Sec-WebSocket-Version: 12
三、应用场景
3.1 实时聊天应用
在实时聊天应用中，用户发送的消息要及时显示在其他用户的界面上。WebSocket的双向通信特性就很适合这种场景。但是如果在握手过程中因为HTTP头校验失败，用户就无法正常连接到聊天服务器，消息也就发不出去、收不到。
3.2 在线游戏
在线游戏需要实时更新玩家的位置、动作等信息。如果WebSocket握手失败，玩家可能会卡在登录界面或者游戏过程中频繁掉线。
3.3 股票行情实时更新
股票市场的行情变化非常快，投资者需要及时了解最新的股价信息。通过WebSocket，服务器可以实时把股票行情推送给客户端。要是握手失败，客户端就无法获取最新的行情数据。
四、技术优缺点
4.1 优点
4.1.1 双向通信
WebSocket允许客户端和服务器在连接建立后随时向对方发送数据，不需要像HTTP那样每次都由客户端发起请求。这在实时性要求高的场景中非常有用。
4.1.2 低开销
和HTTP相比，WebSocket在建立连接后，数据传输的开销更小，因为它不需要每次都发送完整的HTTP头信息。
4.2 缺点
4.2.1 兼容性问题
虽然现在大多数浏览器和服务器都支持WebSocket协议，但在一些旧版本的浏览器或者特殊的网络环境中，可能会存在兼容性问题。
4.2.2 安全性要求高
由于WebSocket是一种长连接，一旦连接建立，就会一直保持。如果没有做好安全防护，容易受到中间人攻击和恶意数据注入。
五、注意事项
5.1 调试工具的使用
在排查WebSocket握手失败问题时，可以使用浏览器的开发者工具（比如Chrome的开发者工具）来查看HTTP请求和响应的头信息。还可以使用抓包工具（如Wireshark）来捕获网络数据包，分析其中的详细信息。
5.2 服务器端配置
服务器端要正确配置对HTTP头的校验规则，确保对合法的请求允许握手，对非法请求拒绝握手。同时，要注意服务器的日志记录，方便后续排查问题。
5.3 客户端代码检查
客户端代码要严格按照WebSocket协议的要求生成和发送HTTP头信息，避免因代码错误导致握手失败。
六、文章总结
在开发使用WebSocket的应用时，握手失败是个常见的问题，而容易忽略的HTTP头校验细节往往是导致失败的重要原因。本文详细介绍了几个关键的HTTP头，包括Connection、Upgrade、Sec-WebSocket-Key、Sec-WebSocket-Accept和Sec-WebSocket-Version，分析了它们的规则要求和可能出现的错误情况。同时，结合具体的应用场景、技术优缺点和注意事项，帮助开发者更好地排查和解决WebSocket握手失败的问题。在实际开发中，要仔细检查HTTP头信息，合理使用调试工具，确保服务器和客户端的配置正确，这样才能保证WebSocket连接的顺利建立和稳定通信。
评论
围绕“WebSocket握手失败原因排查：那些你容易忽略的HTTP头校验细节”参与讨论