nginx代理WebSocket

为了将客户端和服务器之间的连接从HTTP/1.1转为WebSocket,协议切换机制在HTTP/1.1中可以使用。
由于“Upgrade”是一个逐跳头,它不会从客户端传递给被代理服务器。客户端可以使用CONNECT方法避免这个问题。但这个不能够在反向代理中工作,因为客户端不知道任何代理服务器,代理服务器必须进行特殊处理。

从1.3.13版本起,nginx实现了特殊的操作模式,允许当被代理服务器返回101状态码(切换协议)时,在客户端和被代理服务器之间建立一个通道,客户端通过请求头中的“Upgrade”要求一个协议切换。

如上所说,逐跳头包括“Upgrade”和“Connection”不会从客户端传递到被代理服务器,因此为了使被代理服务器知道客户端打算切换协议到WebSocket,这些头必须显式的传递:

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

一个更复杂的例子,到被代理服务器的请求“Connection”头域的值取决于客户端请求头出现的“Upgrade”字段:

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帧来重置超时时间,并检测连接是否仍然存活。