使用nginx作为websocket的proxy server

以下内容均copy该文章,链接地址

一、下载

下载链接。
下载后解压即可。

二、修改配置文件

nginx配置文件在 nginx-1.8.0\conf\nginx.conf

server {
    listen 80;
    server_name xxx.com;
    # add_header    '*' ;
    location /u/ {
        # 反向代理透传客户端ip
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $http_host;
        proxy_set_header X-NginX-Proxy true;

        proxy_pass http://127.0.0.1:8001;
        proxy_redirect off;
    }

    location /c/ {
        proxy_pass http://127.0.0.1:8002;
        # WebScoket Support
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";

        proxy_set_header Origin xxx;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $http_host;
        proxy_set_header X-NginX-Proxy true;
    }
}

备份一下这个配置文件。

首先为服务器设置监听端口,然后是服务的域名。

location的具体用法在这里要展开说一下,因为实在太常用到了。

location [=|~|~*|^~] patt {

}

这里分别是4个语法

  1. 精确匹配。

  2. 正则表达式匹配。

  3. 正则表达式不区分大小写匹配。

  4. ^~ 开头表示uri以某个常规字符串开头,理解为匹配url路径即可。nginx不对url做编码,因此请求为/static/20%/aa,可以被规则^~ /static/ /aa匹配到(注意是空格)。

  5. 另外还有一种用法没在这里 加 !号的用法。!和!*分别为区分大小写不匹配及不区分大小写不匹配的正则。

这里比如我要捕捉一个请求 /oauth/user 的请求转发到本地 8000 端口:

location /oauth/ {
        proxy_pass http://localhost:8000;
   }

这里比如我又要捕捉一个/api/pp/asdasd 的请求转发到 /pp/asdasd:

location ~ ^/api/(.*) {
        proxy_pass http://127.0.0.1:8000/$1?$args;
   }

这个正则写法稍微进阶了一点。我们以正则正则表达式 ^ 表示开始匹配,然后精确匹配/api/这一层然后使用正则表达式分组捕捉后面捕捉到的信息,在转发的时候我们把捕捉到的分组信息追加到转发之后,就完成了一个动态转发地址,另外值得一题的是,location中捕捉到的 uri 是不带参数的,如果需要把参数也追加到后面需要手动增加后面 $args 变量。这里的 $args 由 nginx 提供用于存储传递的变量。更多探索可以参考文章末尾 reference 的第一篇和第三篇文章。

下面我依次介绍各参数作用:

proxy_set_header X-Real-IP $remote_addr;               # 远端真实ip地址
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;   # 反向代理之后转发之前的ip地址
proxy_set_header Host $http_host;                    # http请求的主机域名
proxy_set_header X-NginX-Proxy true;                 # nginx代理

这些参数都是在nginx反向代理中使用的。

proxy_pass http://127.0.0.1:8001;    # 反向代理转发地址
proxy_redirect off;                  # 代理是否支持重定向

下面匹配/c/路径下的,是我的websocket转发服务。跟上面不同的是,他需要再header里面加入下面内容

proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";

升级http1.1到 websocket协议。另外有一个特别值得注意的地方是,如果websocket服务器在收到websocket握手包,查看Origin信息与所在域信息不符的话。会直接拒绝服务。这点很坑,我花了接近半天的时间来找为什么连不上的原因,最后竟然发现是Origin 必须和请求地址在一个域,不然会被拒绝访问并且返回403.

另外以上的所有配置里面的变量都是可以通过get_header里面的信息拿到并且获取的。

另外再提一点就是 upstream 的使用,之前我都是直接在 proxy_pass 那里写转发地址。后来发现只要指定好 upstream 地址之后,就可以方便的进行负载均衡或者直接用upstream 的 name 进行转发。这里再贴一个配置看下:

server {
    listen       8030;
    server_name  odin;

    #charset koi8-r;
    #access_log  /var/log/nginx/host.access.log  main;
    location ~ ^/api/v4/axiba/(.*) {
        proxy_pass http://odin/$1?$args;
    }
}
upstream odin {
    server localhost:8999;
}

这里我配置了一个叫 odin 的服务器。然后指定了一个 server 地址。这里其实可以同时指定很多个 server 地址进行负载均衡。

然后在 location 中使用的时候就可以设置转发了 要使用 http//:upstream/XXXX 这种形式。

根据各不同想更详细查看配置的 可以查阅nginx的官网和reference。

以上。

Reference:

https://www.kancloud.cn/curder/nginx/97541 Nginx的location详解
https://segmentfault.com/n/1330000006925038 nginx 配置文件梳理
http://seanlook.com/2015/05/17/nginx-location-rewrite/ nginx配置location总结及rewrite规则写法
http://www.ha97.com/5194.html (总结)Nginx配置文件nginx.conf中文详解
http://nginx.org/en/docs/http/websocket.html WebSocket proxying

三、启动nginx

注意不要直接双击nginx.exe,这样会导致修改配置后重启、停止nginx无效,需要手动关闭任务管理器内的所有nginx进程

在nginx.exe目录,打开命令行工具,用命令 启动/关闭/重启nginx

start nginx : 启动nginx
nginx -s reload :修改配置后重新加载生效
nginx -s reopen :重新打开日志文件
nginx -t -c /path/to/nginx.conf 测试nginx配置文件是否正确

关闭nginx:
nginx -s stop :快速停止nginx
nginx -s quit :完整有序的停止nginx

如果遇到报错:
bash: nginx: command not found

有可能是你再linux命令行环境下运行了windows命令,

如果你之前是允许 nginx -s reload报错, 试下 ./nginx -s reload

或者 用windows系统自带命令行工具运行

你可能感兴趣的:(使用nginx作为websocket的proxy server)