Nginx配置WebSocket

原理

一般我们开发的WebSocket服务程序使用ws协议，明文的。但是怎样让它安全的通过互联网传输呢？这时候可以通过nginx在客户端和服务端直接做一个转发了， 客户端通过wss访问，然后nginx和服务端通过ws协议通信。如下图所示：

 

 

 

先直接展示配置文件，如下所示(使用的话直接复制，然后改改ip和port即可)

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

upstream wsbackend{
         server ip1:port1;
         server ip2:port2;
         keepalive 1000;
}

server {
       listen 20038;
       location /{ 
            proxy_http_version 1.1;
            proxy_pass http://wsbackend;
            proxy_redirect off;
            proxy_set_header Host $host;
            proxy_set_header X-Real-IP $remote_addr;
            proxy_read_timeout 3600s;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection $connection_upgrade;
       }
}

接下来，我们就分别分析上述配置的具体含义。

首先：

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

表示的是：

如果 $http_upgrade 不为 '' (空)，则 $connection_upgrade 为 upgrade 。
如果 $http_upgrade 为 '' (空)，则 $connection_upgrade 为 close。
其次：

upstream wsbackend{
        server ip1:port1;
        server ip2:port2;
        keepalive 1000;
}

表示的是 nginx负载均衡：

两台服务器 (ip1:port1)和(ip2:port2) 。
keepalive 1000 表示的是每个nginx进程中上游服务器保持的空闲连接，当空闲连接过多时，会关闭最少使用的空闲连接.当然，这不是限制连接总数的，可以想象成空闲连接池的大小，设置的值应该是上游服务器能够承受的。

最后：

server {
       listen 20038;
       location /{
            proxy_http_version 1.1;
            proxy_pass http://wsbackend;
            proxy_redirect off;
            proxy_set_header Host $host;
            proxy_set_header X-Real-IP $remote_addr;
            proxy_read_timeout 3600s;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection $connection_upgrade;
       }
}

表示的是监听的服务器的配置

listen 20038 表示 nginx 监听的端口
locations / 表示监听的路径(/表示所有路径，通用匹配，相当于default)
proxt_http_version 1.1 表示反向代理发送的HTTP协议的版本是1.1，HTTP1.1支持长连接
proxy_pass http://wsbackend; 表示反向代理的uri，这里可以使用负载均衡变量
proxy_redirect off; 表示不要替换路径，其实这里如果是/则有没有都没关系，因为default也是将路径替换到proxy_pass的后边
proxy_set_header Host $host; 表示传递时请求头不变， $host是nginx内置变量，表示的是当前的请求头，proxy_set_header表示设置请求头
proxy_set_header X-Real-IP $remote_addr; 表示传递时来源的ip还是现在的客户端的ip
proxy_read_timeout 3600s； 表的两次请求之间的间隔超过 3600s 后才关闭这个连接，默认的60s，自动关闭的元凶
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 表示X-Forwarded-For头不发生改变
proxy_set_header Upgrade $http_upgrade; 表示设置Upgrade不变
proxy_set_header Connection $connection_upgrade; 表示如果 $http_upgrade为upgrade，则请求为upgrade(websocket)，如果不是，就关闭连接
若是实际使用的websocket地址后面还有路径，比如实际地址是这样的，访问地址是 http://www.a.com，实际会转发给ws://127.0.0.1:8094/ws

Nginx如何支持WebSocket

WebSocket 和HTTP虽然是不同协议，但是两者“握手”方式兼容。通过HTTP升级机制，使用HTTP的Upgrade和Connection协议头的方式可以将连接从HTTP升级为WebSocket。如下图所示

 

 

Http升级为WebSocket

因为WebSocket协议是一个hop-by-hop协议(此类头部字段只对单次转发有效。会因为转发给缓存/代理服务器而失效)，为了让Nginx代理服务器可以将来自客户端的Upgrade请求发送到后端服务器，要求Upgrade和Connection的头信息必须被显式的设置。可以通过下文将要讲解的修改Nginx的配置文件方式解决此问题。

 

 

Nginx配置Websocket方式

通过修改nginx.conf配置，如下图所示

 

 

1.map是根据客户端请求中 $http_upgrade 的值来构造改变 $connection_upgrade 的值，即根据变量 $http_upgrade 的值和{} 里规则创建新的变量 $connection_upgrade并赋值。

2.HTTP的Upgrade协议头机制用于将连接从HTTP连接升级到WebSocket连接，Upgrade机制使用了Upgrade协议头和Connection协议头;为了让Nginx可以将来自客户端的Upgrade请求发送到后端服务器，Upgrade和Connection的头信息必须被显式的设置。如上图代码中第三个红圈。

 

总结

通过Http升级机制将Http升级为WebSocket。Nginx代理服务器通过修改配置的方式解决了WebSocket属于hop-by-hop协议的问题、并通过保持分别与客户端和服务端的连接一直处于打开状态从而实现WebSokcet的代理。