Nginx反向代理配置支持websocket

news2024/9/29 14:50:56

一、官方文档

WebSocket proxying

为了将客户端和服务器之间的连接从HTTP/1.1转换为WebSocket，使用了HTTP/1.1中可用的协议切换机制（RFC 2616: Hypertext Transfer Protocol – HTTP/1.1）。

然而，这里有一个微妙之处:由于“升级”是逐跳报头（hop-by-hop），因此它不会从客户端传递到代理服务器。使用正向代理，客户端可以使用CONNECT方法来规避此问题。但是，这不适用于反向代理，因为客户端不知道任何代理服务器，并且需要在代理服务器上进行特殊处理。

从1.3.13版本开始，nginx实现了特殊的操作模式，允许在客户端和代理服务器之间建立一个隧道，如果代理服务器返回一个带有代码101(切换协议)的响应，并且客户端通过请求中的“升级”头请求协议切换。

代理服务器nginx进行协议升级

二、基础配置（只能处理websocket协议）

如上所述，包括“升级”和“连接”在内的逐跳报头不会从客户端传递到代理服务器，因此为了让代理服务器知道客户端将协议切换到WebSocket的意图，这些报头必须显式传递:

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

简单来说：是如果想要nginx支持websocket 需要配置

proxy_http_version 1.1;

proxy_set_header Upgrade $http_upgrade;

proxy_set_header Connection "upgrade";

三、复杂配置（可以同时处理websocket和http协议）

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;
        }
    }

map语法解释：

当Upgrade是 ‘’ 的时候，设置Connection 为close,其他默认设置成upgrade，这样配置后，nginx就可以同时处理websockt和http请求了。