当前位置:  首页>> 技术小册>> Nginx典型应用场景

Nginx配置WebSocket

Nginx配置WebSocket也比较简单,只需要在nginx.conf文件中进行相应的配置。这种方式很简单,但是很有效,能够横向扩展WebSocket服务端的服务能力。

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

  1. map $http_upgrade $connection_upgrade {
  2. default upgrade;
  3. '' close;
  4. }
  5. upstream wsbackend{
  6. server ip1:port1;
  7. server ip2:port2;
  8. keepalive 1000;
  9. }
  10. server {
  11. listen 20038;
  12. location /{
  13. proxy_http_version 1.1;
  14. proxy_pass http://wsbackend;
  15. proxy_redirect off;
  16. proxy_set_header Host $host;
  17. proxy_set_header X-Real-IP $remote_addr;
  18. proxy_read_timeout 3600s;
  19. proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  20. proxy_set_header Upgrade $http_upgrade;
  21. proxy_set_header Connection $connection_upgrade;
  22. }
  23. }

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

首先:

  1. map $http_upgrade $connection_upgrade {
  2. default upgrade;
  3. '' close;
  4. }

表示的是:

如果 $http_upgrade 不为 ‘’ (空),则 $connection_upgrade 为 upgrade 。
如果 $http_upgrade 为 ‘’ (空),则 $connection_upgrade 为 close。
其次:

  1. upstream wsbackend{
  2. server ip1:port1;
  3. server ip2:port2;
  4. keepalive 1000;
  5. }

表示的是 nginx负载均衡: 两台服务器 (ip1:port1)和(ip2:port2) 。

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

最后:

  1. server {
  2. listen 20038;
  3. location /{
  4. proxy_http_version 1.1;
  5. proxy_pass http://wsbackend;
  6. proxy_redirect off;
  7. proxy_set_header Host $host;
  8. proxy_set_header X-Real-IP $remote_addr;
  9. proxy_read_timeout 3600s;
  10. proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  11. proxy_set_header Upgrade $http_upgrade;
  12. proxy_set_header Connection $connection_upgrade;
  13. }
  14. }

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

  • 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),如果不是,就关闭连接


该分类下的相关小册推荐: