WebSocket配置信息

1. 基础介绍：

Nginx1.3.13版本以上，开始支持WebSocket协议。

WebSocket协议是基于TCP的一种网络协议，实现浏览器和服务器全双工（full-duplex）通信 — 允许服务器主动发送信息给客户端。

WebSocket协议中，实现即时任务两大好处：1.Header很小（约2Bytes）; 2.Server Push 服务器主动推送给浏览器。

WebSocket工作在HTTP的80和443端口并使用前缀ws://或者wss://进行协议标注，在建立连接时使用HTTP/1.1的101状态码进行协议切换，当前标准不支持两个客户端之间不借助HTTP直接建立Websocket连接。

2. Nginx配置WebSocket注意事项：

  1. 是否Nginx配置中，同时存在WebSocket 和 Http
  2. 默认情况下，proxy_read_timeout是60s；两次传输时长超过这个，就会断开连接！ —解决— 代理服务器配置为定期发送WebSocket ping帧以重置超时

3. 客户端和服务端的报文

  1. <!--客户端的连接报文-->
  2. GET /webfin/websocket/ HTTP/1.1
  3. Host: localhost
  4. Upgrade: websocket
  5. Connection: Upgrade
  6. Sec-WebSocket-Key: xqBt3ImNzJbYqRINxEFlkg==
  7. Origin: http://localhost:8080
  8. Sec-WebSocket-Version: 13
  1. <!--服务端的相应报文-->
  2. HTTP/1.1 101 Switching Protocols
  3. Upgrade: websocket
  4. Connection: Upgrade
  5. Sec-WebSocket-Accept: K7DJLdLooIwIG/MOpvWFB3y3FE8=

4. Nginx的配置参数

  1. # HTTP配置中，添加server关于websocket的配置
  3.     # 为测试websocket添加
  4.     # 1. 如果 $http_upgrade 不为 '' (空),则 $connection_upgrade 为 upgrade
  5.     # 2. 如果 $http_upgrade 为 '' (空),则 $connection_upgrade 为 close
  6.     map $http_upgrade $connection_upgrade {
  7.         # default upgrade;
  8.         # '' close;
  9.         default        keep-alive;  #默认为keep-alive 可以支持 一般http请求
  10.     'websocket'    upgrade;     #如果为websocket 则为 upgrade 可升级的。
  11.     }
  13.     # 表示的是 nginx负载均衡
  14.     # 1. 两台服务器 (ip1:port1)和(ip2:port2)
  15.     # 2. keepalive 1000 表示的是每个nginx进程中上游服务器保持的空闲连接,当空闲连接过多时,会关闭最少使用的空闲连接.当然,这不是限制连接总数的,可以想象成空闲连接池的大小.设置的值应该是上游服务器能够承受的
  16.     upstream wsbackend{
  17.         server ip1:port1;
  18.         server ip2:port2;
  19.         keepalive 1000;
  20.     }
  24.     # 添加测试websocket的代理
  25.     # 表示的是监听的服务器的配置
  26.     # 1. listen 20038      表示 nginx 监听的端口
  27.     # 2. locations /       表示监听的路径(/表示所有路径,通用匹配,相当于default)
  28.     # 3. proxt_http_version 1.1         表示反向代理发送的HTTP协议的版本是1.1,HTTP1.1支持长连接
  29.     # 4. proxy_pass http://wsbackend;   表示反向代理的uri,这里可以使用负载均衡变量
  30.     # 5. proxy_redirect off;            表示不要替换路径,其实这里如果是/则有没有都没关系,因为default也是将路径替换到proxy_pass的后边
  31.     # 6. proxy_set_header Host $host;    表示传递时请求头不变, $host是nginx内置变量,表示的是当前的请求头,proxy_set_header表示设置请求头
  32.     # 7. proxy_set_header X-Real-IP $remote_addr;     表示传递时来源的ip，还是现在的客户端的ip
  33.     # 8. proxy_read_timeout 3600s;                    表示两次请求之间的间隔超过 3600s 后才关闭这个连接,默认的60s。##自动关闭的元凶##
  34.     # 9. proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;    表示X-Forwarded-For头不发生改变
  35.     # 10. proxy_set_header Upgrade $http_upgrade;        表示设置Upgrade不变
  36.     # 11. proxy_set_header Connection $connection_upgrade;        表示如果 $http_upgrade为upgrade,则请求为upgrade(websocket),如果不是,就关闭连接
  37.     server {
  38.         listen    12443;
  39.         location /socketServer {
  40.             # 反向代理到 EMQ 非加密 WebSocket   ws
  41.             # proxy_pass http://127.0.0.1:58080;
  42.             proxy_pass http://wsbackend;
  44.             # 反向代理保留客户端地址
  45.             proxy_set_header X-Real_IP $remote_addr;
  46.             proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  48.             # WebSocket 额外请求头
  49.             proxy_http_version 1.1;
  50.             proxy_set_header Upgrade $http_upgrade;
  51.             proxy_set_header Connection $connection_upgrade;
  53.             # WebSocket 设置断开连接的时间
  54.             proxy_read_timeout 1800s;
  55.         }
  56.     }

4. Nginx配置模板：

  1. ########   Nginx的main(全局配置)文件
  2. #指定nginx运行的用户及用户组,默认为nobody
  3. #user  nobody;   
  5. #开启的线程数，一般跟逻辑CPU核数一致
  6. worker_processes  1;   
  8. #定位全局错误日志文件，级别以notice显示，还有debug,info,warn,error,crit模式，debug输出最多，crir输出最少，根据实际环境而定
  9. #error_log  logs/error.log;
  10. #error_log  logs/error.log  notice;
  11. #error_log  logs/error.log  info;
  13. #指定进程id的存储文件位置
  14. #pid        logs/nginx.pid;
  16. #指定一个nginx进程打开的最多文件描述符数目，受系统进程的最大打开文件数量限制
  17. #worker_rlimit_nofile 65535
  19. events {
  20.     #设置工作模式为epoll,除此之外还有select,poll,kqueue,rtsig和/dev/poll模式
  21.     #use epoll;
  23.     #定义每个进程的最大连接数,受系统进程的最大打开文件数量限制。
  24.     worker_connections  1024;
  25. }
  27. #######Nginx的Http服务器配置,Gzip配置
  28. http {
  29.     #主模块指令，实现对配置文件所包含的文件的设定，可以减少主配置文件的复杂度，DNS主配置文件中的zonerfc1912,acl基本上都是用include语句。
  30.     include       mime.types;
  32.     #核心模块指令，智力默认设置为二进制流，也就是当文件类型未定义时使用这种方式
  33.     default_type  application/octet-stream;
  35.     #下面代码为日志格式的设定，main为日志格式的名称，可自行设置，后面引用
  36.     #log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
  37.     #                  '$status $body_bytes_sent "$http_referer" '
  38.     #                  '"$http_user_agent" "$http_x_forwarded_for"';
  40.     #引用日志main
  41.     #access_log  logs/access.log  main;
  43.     #设置允许客户端请求的最大的单个文件字节数
  44.     #client_max_body_size 20M;
  45.     #指定来自客户端请求头的headebuffer大小
  46.     #client_header_buffer_size  32k;
  47.     #指定连接请求试图写入缓存文件的目录路径
  48.     #client_body_temp_path /dev/shm/client_body_temp;
  49.     #指定客户端请求中较大的消息头的缓存最大数量和大小，目前设置为4个32KB
  50.     #large client_header_buffers 4 32k;
  52.     client_max_body_size 10240m;
  53.     keepalive_requests 10240;
  54.     client_header_buffer_size 8k;
  55.     open_file_cache max=102400 inactive=20s;
  56.     open_file_cache_valid 30s;
  57.     open_file_cache_min_uses 1;
  58.     client_header_timeout 15;
  59.     client_body_timeout 15;
  60.     reset_timedout_connection on;
  61.     send_timeout 15;
  63.     #开启高效文件传输模式
  64.     sendfile        on;
  65.     #开启防止网络阻塞
  66.     #tcp_nopush     on;
  67.     #开启防止网络阻塞
  68.     #tcp_nodelay    on;
  70.     #设置客户端连接保存活动的超时时间
  71.     #keepalive_timeout  0;
  72.     keepalive_timeout  65;
  74.     #设置客户端请求读取超时时间
  75.     #client_header_timeout 10;
  76.     #设置客户端请求主体读取超时时间
  77.     #client_body_timeout 10;
  78.     #用于设置相应客户端的超时时间
  79.     #send_timeout 
  81.     ####HttpGZip模块配置
  82.     #httpGzip modules
  83.     #开启gzip压缩
  84.     #gzip  on;
  85.     #设置允许压缩的页面最小字节数
  86.     #gzip_min_length 1k;
  87.     #申请4个单位为16K的内存作为压缩结果流缓存
  88.     #gzip_buffers 4 16k;
  89.     #设置识别http协议的版本，默认为1.1
  90.     #gzip_http_version 1.1;
  91.     #指定gzip压缩比，1-9数字越小，压缩比越小，速度越快
  92.     #gzip_comp_level 2;
  93.     #指定压缩的类型
  94.     #gzip_types text/plain application/x-javascript text/css application/xml;
  95.     #让前端的缓存服务器进过gzip压缩的页面
  96.     #gzip_vary on;  
  98.     #########Nginx的server虚拟主机配置
  99.     server {
  100.         #监听端口为 80
  101.         listen       80;
  103.         #设置主机域名
  104.         server_name  localhost;
  106.         #设置访问的语言编码
  107.         #charset koi8-r;
  109.         #设置虚拟主机访问日志的存放路径及日志的格式为main
  110.         #access_log  logs/host.access.log  main;
  112.         #设置虚拟主机的基本信息
  113.         location / {
  114.             #设置虚拟主机的网站根目录
  115.             root   html;
  117.             #设置虚拟主机默认访问的网页
  118.             index  index.html index.htm;
  119.         }
  121.         #error_page  404              /404.html;
  122.         # redirect server error pages to the static page /50x.html
  124.         error_page   500 502 503 504  /50x.html;
  125.         location = /50x.html {
  126.             root   html;
  127.         }
  129.         # proxy the PHP scripts to Apache listening on 127.0.0.1:80
  130.         #
  131.         #location ~ \.php$ {
  132.         #    proxy_pass   http://127.0.0.1;
  133.         #}
  135. }