WebSocket proxying

要将客户端和服务器之间的连接从 HTTP/1.1 转换为 WebSocket,将使用 HTTP/1.1 中可用的protocol switch机制。

但是,有一个微妙之处:由于“ Upgrade”是hop-by-hopHeaders,因此它不会从客户端传递到代理服务器。使用正向代理,客户端可以使用CONNECT方法来规避此问题。但是,这不适用于反向代理,因为客户端不知道任何代理服务器,并且需要对代理服务器进行特殊处理。

从 1.3.13 版本开始,nginx 实施了特殊的操作模式,如果代理服务器返回了代码为 101(交换协议)的响应,并且客户端通过请求中的“升级”Headers。

如上所述,包括“升级”和“连接”在内的逐跳 Headers 不会从客户端传递到代理服务器,因此,为了使代理服务器了解客户端将协议切换到 WebSocket 的意图,这些 Headers 必须明确传递:

location /chat/ {
    proxy_pass http://backend;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
}

一个更复杂的示例,其中对代理服务器的请求中的“连接”Headers 字段的值取决于客户端请求 Headers 中是否存在“升级”字段:

http {
    map $http_upgrade $connection_upgrade {
        default upgrade;
        ''      close;
    }

    server {
        ...

        location /chat/ {
            proxy_pass http://backend;
            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection $connection_upgrade;
        }
    }

默认情况下,如果代理服务器在 60 秒内未传输任何数据,则连接将关闭。可以使用proxy_read_timeout指令来增加此超时。或者,可以将代理服务器配置为定期发送 WebSocket ping 帧以重置超时并检查连接是否仍然有效。