在使用 workerman 开发 websocket 服务器时，握手失败的原因主要包括请求头不正确、sec-websocket-key 处理错误、状态码错误和子协议及扩展处理错误。1) 请求头不正确时，检查客户端的请求头；2) sec-websocket-key 处理错误时，通过日志记录相关值来调试；3) 状态码错误时，检查服务器返回的 http 状态码；4) 子协议和扩展处理错误时，记录处理过程来调试。
引言
在开发 WebSocket 服务器时，握手失败是一个常见的问题，搞得我头疼了好几天。今天就来聊聊在使用 workerman 开发 WebSocket 服务器时，握手失败的那些事儿。读完这篇文章，你将了解到握手失败的各种原因，以及如何避免这些问题，让你的 WebSocket 服务器更加稳定可靠。
基础知识回顾
WebSocket 是一种在单个 TCP 连接上进行全双工通信的协议，它通过一个 HTTP 握手过程来建立连接。Workerman 是一个高性能的 php 框架，非常适合开发 WebSocket 服务器。在使用 Workerman 时，握手过程是通过 HTTP 请求和响应来完成的，如果这个过程出现问题，就会导致握手失败。
Workerman 提供了 onWebSocketConnect 回调函数来处理 WebSocket 连接的握手过程，这个函数是我们需要重点关注的地方。
核心概念或功能解析
WebSocket 握手过程的定义与作用
WebSocket 握手过程是客户端和服务器之间建立 WebSocket 连接的关键步骤。这个过程通过 HTTP 请求和响应来完成，客户端发送一个特殊的 HTTP 请求，服务器返回一个 HTTP 响应，如果一切正常，连接就会升级为 WebSocket 连接。
握手过程的作用是确保客户端和服务器都支持 WebSocket 协议，并且能够协商出合适的子协议和扩展。
public function onWebSocketConnect($connection, $http_response) { // 握手处理逻辑 }
工作原理
在 Workerman 中，握手过程主要通过 onWebSocketConnect 函数来处理。这个函数会在客户端发送 WebSocket 握手请求时被调用，服务器需要在这个函数中验证请求头，生成正确的响应头，并通过 $http_response 对象返回给客户端。
握手过程的关键步骤包括：
- 验证客户端请求头中的 Upgrade 和 Connection 字段，确保它们分别为 websocket 和 Upgrade。
- 验证 Sec-WebSocket-Key 字段，并生成 Sec-WebSocket-Accept 响应头。
- 设置 HTTP 状态码为 101 switching Protocols，并返回正确的响应头。
如果这些步骤中的任何一个出现问题，都会导致握手失败。
使用示例
基本用法
下面是一个简单的 Workerman WebSocket 服务器握手处理示例：
use WorkermanWorker; use WorkermanConnectionTcpConnection; $worker = new Worker('websocket://0.0.0.0:8080'); $worker->onWebSocketConnect = function($connection, $http_response) { $connection->onWebSocketConnect = function($connection, $http_response) { $secWebSocketKey = $connection->header('Sec-WebSocket-Key'); $secWebSocketAccept = base64_encode(sha1($secWebSocketKey . '258EAFA5-E914-47DA-95CA-C5AB0DC85B11', true)); $http_response->withHeader('Sec-WebSocket-Accept', $secWebSocketAccept); $http_response->withHeader('Upgrade', 'websocket'); $http_response->withHeader('Connection', 'Upgrade'); $http_response->withStatus(101); }; }; Worker::runAll();
这段代码展示了如何在 onWebSocketConnect 函数中处理 WebSocket 握手请求，生成正确的响应头，并返回给客户端。
高级用法
在实际开发中，我们可能需要处理更多的握手细节，比如支持子协议和扩展。这里是一个支持子协议的示例：
$worker->onWebSocketConnect = function($connection, $http_response) { $secWebSocketKey = $connection->header('Sec-WebSocket-Key'); $secWebSocketAccept = base64_encode(sha1($secWebSocketKey . '258EAFA5-E914-47DA-95CA-C5AB0DC85B11', true)); $http_response->withHeader('Sec-WebSocket-Accept', $secWebSocketAccept); $http_response->withHeader('Upgrade', 'websocket'); $http_response->withHeader('Connection', 'Upgrade'); // 处理子协议 $protocols = $connection->header('Sec-WebSocket-Protocol'); if ($protocols) { $protocols = explode(',', $protocols); $protocol = trim($protocols[0]); $http_response->withHeader('Sec-WebSocket-Protocol', $protocol); } $http_response->withStatus(101); };
这个示例展示了如何在握手过程中处理子协议，确保客户端和服务器能够协商出合适的子协议。
常见错误与调试技巧
握手失败的原因有很多，以下是一些常见的错误和调试技巧：
-
请求头不正确：客户端发送的请求头中 Upgrade 和 Connection 字段必须分别为 websocket 和 Upgrade，否则服务器会拒绝握手请求。可以通过检查客户端的请求头来排查这个问题。
-
Sec-WebSocket-Key 处理错误：服务器需要正确处理 Sec-WebSocket-Key 字段，并生成正确的 Sec-WebSocket-Accept 响应头。如果这个过程出错，握手就会失败。可以通过日志记录 Sec-WebSocket-Key 和 Sec-WebSocket-Accept 的值来调试。
-
状态码错误：握手响应的状态码必须为 101 Switching Protocols，如果状态码不正确，握手也会失败。可以通过检查服务器返回的 HTTP 状态码来排查这个问题。
-
子协议和扩展处理错误：如果客户端请求中包含子协议或扩展，服务器需要正确处理这些字段，否则握手可能会失败。可以通过日志记录子协议和扩展的处理过程来调试。
性能优化与最佳实践
在开发 WebSocket 服务器时，握手过程的性能优化和最佳实践非常重要。以下是一些建议：
-
缓存 Sec-WebSocket-Accept：生成 Sec-WebSocket-Accept 是一个计算密集的过程，可以考虑将结果缓存起来，避免每次握手都重新计算。
-
使用异步处理：Workerman 支持异步处理，可以利用这个特性来提高握手过程的性能，避免阻塞。
-
日志记录和监控：在握手过程中记录详细的日志，可以帮助快速定位和解决问题。同时，监控握手失败的频率和原因，可以帮助优化服务器的性能。
-
代码可读性和维护性：在编写握手处理代码时，注意代码的可读性和维护性，适当添加注释和文档，方便后续的维护和调试。
总之，握手失败的原因多种多样，理解握手过程的工作原理和常见错误，可以帮助我们更好地开发和优化 WebSocket 服务器。希望这篇文章能对你有所帮助，让你的 WebSocket 服务器更加稳定可靠。
