nginx 支持websocket

深碍√TFBOYSˉ_ 2021-11-04 13:42 558阅读 0赞

### nginx 反向代理websocket ###

nginx配置

请求地址及路径：ws://x.x.x.x/web/springws/websocket.ws

**解析 map 指令**

上面 nginx.conf 配置中的 map $http\_upgrade $connection\_upgrade 的作用，参考 http://www.ttlsa.com/nginx/using-nginx-map-method/

该作用主要是根据客户端请求中 $http\_upgrade 的值，来构造改变 $connection\_upgrade 的值，即根据变量 $http\_upgrade 的值创建新的变量 $connection\_upgrade，创建的规则就是 \{\} 里面的东西，请见配置：

![复制代码][copycode.gif]

http{
    
        # websocket
        map $http_upgrade $connection_upgrade {
            default upgrade;
            '' close;
        }
    }

![复制代码][copycode.gif]

# websocket
    upstream websocket {
        server xxx.xxx.xxx.xxx:8082;
        server xxx.xxx.xxx.xxx:8082;
    }
    server {
    
        # websocket
        location ^~ /web/springws/ {
        proxy_pass http://websocket;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For             
        $proxy_add_x_forwarded_for;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection $connection_upgrade;
        }
    }

![复制代码][copycode.gif]

map指令使用ngx\_http\_map\_module模块提供的。默认情况下，[nginx][]有加载这个模块，除非人为的 --without-http\_map\_module。  
ngx\_http\_map\_module模块可以创建变量，这些变量的值与另外的变量值相关联。允许分类或者同时映射多个值到多个不同值并储存到一个变量中，map指令用来创建变量，但是仅在变量被接受的时候执行视图映射操作，对于处理没有引用变量的请求时，这个模块并没有性能上的缺失。

### **一. ngx\_http\_map\_module模块指令说明** ###

map  
语法: map $var1 $var2 \{ ... \}  
默认值: —  
配置段: http  
map为一个变量设置的映射表。映射表由两列组成，匹配模式和对应的值。  
在 map 块里的参数指定了源变量值和结果值的对应关系。  
匹配模式可以是一个简单的字符串或者正则表达式，使用正则表达式要用('~')。  
一个正则表达式如果以 “~” 开头，表示这个正则表达式对大小写敏感。以 “~\*”开头，表示这个正则表达式对大小写不敏感。

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div> 
     <div>
       1 
     </div> 
     <div>
       2 
     </div> 
     <div>
       3 
     </div> 
     <div>
       4 
     </div> 
     <div>
       5 
     </div> 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <span>map<span> <span>$<span>http_user_agent<span> <span>$<span>agent<span> <span>{ </span></span></span></span></span></span></span></span></span> 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span>default<span> <span>""<span>;</span></span></span></span></span> 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span>~<span>curl <span>curl<span>;</span></span></span></span></span> 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span>~<span>*<span>apachebench"<span> <span>ab<span>;</span></span></span></span></span></span></span> 
     </div> 
     <div> 
      <span>}</span> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

正则表达式里可以包含命名捕获和位置捕获，这些变量可以跟结果变量一起被其它指令使用。

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div> 
     <div>
       1 
     </div> 
     <div>
       2 
     </div> 
     <div>
       3 
     </div> 
     <div>
       4 
     </div> 
     <div>
       5 
     </div> 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <span>map<span> <span>$<span>uri<span> <span>$<span>value<span> <span>{ </span></span></span></span></span></span></span></span></span> 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;<span>/<span>ttlsa_com<span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span>/<span>index<span>.<span>php<span>;</span></span></span></span></span></span></span></span></span> 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;<span>~<span>^<span>/<span>ttlsa_com<span>/<span>(<span>?<span>&lt;<span>suffix<span>&gt;<span>.<span>*<span>)<span>$<span>&nbsp;&nbsp;<span>/<span>boy<span>/<span>;</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span> 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;<span>~<span>/<span>fz<span>(<span>/<span>.<span>*<span>)<span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span>/<span>index<span>.<span>php<span>?<span>;<span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; </span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span> 
     </div> 
     <div> 
      <span>}</span> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

\[warning\]不能在map块里面引用命名捕获或位置捕获变量。如~^/ttlsa\_com/(.\*) /boy/$1; 这样会报错nginx: \[emerg\] unknown variable。\[/warning\]如果源变量值包含特殊字符如‘~’，则要以‘\\’来转义。

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div> 
     <div>
       1 
     </div> 
     <div>
       2 
     </div> 
     <div>
       3 
     </div> 
     <div>
       4 
     </div> 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <span>map<span> <span>$<span>http_referer<span> <span>$<span>value<span> <span>{ </span></span></span></span></span></span></span></span></span> 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;<span>Mozilla<span>&nbsp;&nbsp;&nbsp;&nbsp;<span>111<span>;</span></span></span></span></span> 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;<span>\<span>~<span>Mozilla<span>&nbsp;&nbsp;<span>222<span>;</span></span></span></span></span></span></span> 
     </div> 
     <div> 
      <span>}</span> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

结果变量可以是一个字符串也可以是另外一个变量。

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div> 
     <div>
       1 
     </div> 
     <div>
       2 
     </div> 
     <div>
       3 
     </div> 
     <div>
       4 
     </div> 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <span>map<span> <span>$<span>num<span> <span>$<span>limit<span> <span>{ </span></span></span></span></span></span></span></span></span> 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span>1<span> <span>$<span>binary_remote_addr<span>;</span></span></span></span></span></span> 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span>0<span> <span>""<span>;</span></span></span></span></span> 
     </div> 
     <div> 
      <span>}</span> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

map指令有三个参数：  
default ： 指定如果没有匹配结果将使用的默认值。当没有设置 default，将会用一个空的字符串作为默认的结果。  
hostnames ： 允许用前缀或者后缀掩码指定域名作为源变量值。这个参数必须写在值映射列表的最前面。  
include ： 包含一个或多个含有映射值的文件。

如果匹配到多个特定的变量，如掩码和正则同时匹配，那么会按照下面的顺序进行选择：  
1. 没有掩码的字符串  
2. 最长的带前缀的字符串，例如: “\*.example.com”  
3. 最长的带后缀的字符串，例如：“mail.\*”  
4. 按顺序第一个先匹配的正则表达式 （在配置文件中体现的顺序）  
5. 默认值

map\_hash\_bucket\_size  
语法: map\_hash\_bucket\_size size;  
默认值: map\_hash\_bucket\_size 32|64|128;  
配置段: http  
指定一个映射表中的变量在哈希表中的最大值，这个值取决于处理器的缓存。

map\_hash\_max\_size  
语法: map\_hash\_max\_size size;  
默认值: map\_hash\_max\_size 2048;  
配置段: http  
设置映射表对应的哈希表的最大值。

### **二. 实例** ###

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div> 
     <div>
       1 
     </div> 
     <div>
       2 
     </div> 
     <div>
       3 
     </div> 
     <div>
       4 
     </div> 
     <div>
       5 
     </div> 
     <div>
       6 
     </div> 
     <div>
       7 
     </div> 
     <div>
       8 
     </div> 
     <div>
       9 
     </div> 
     <div>
       10 
     </div> 
     <div>
       11 
     </div> 
     <div>
       12 
     </div> 
     <div>
       13 
     </div> 
     <div>
       14 
     </div> 
     <div>
       15 
     </div> 
     <div>
       16 
     </div> 
     <div>
       17 
     </div> 
     <div>
       18 
     </div> 
     <div>
       19 
     </div> 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <span>http<span> <span>{ </span></span></span> 
     </div> 
     <div> 
      <span> <span>map<span> <span>$<span>http_user_agent<span> <span>$<span>agent<span> <span>{ </span></span></span></span></span></span></span></span></span></span> 
     </div> 
     <div> 
      <span> <span>~<span>curl <span>curl<span>;</span></span></span></span></span> 
     </div> 
     <div> 
      <span> <span>~<span>*<span>chrome <span>chrome<span>;</span></span></span></span></span></span> 
     </div> 
     <div> 
      <span> <span>}</span></span> 
     </div> 
     <div> 
      <span> <span>server<span> <span>{ </span></span></span></span> 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span>listen<span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span>8080<span>;</span></span></span></span></span> 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span>server_name&nbsp;&nbsp;<span>test<span>.<span>ttlsa<span>.<span>com<span>;</span></span></span></span></span></span></span></span> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span>location<span> <span>/<span>hello<span> <span>{ </span></span></span></span></span></span></span> 
     </div> 
     <div> 
      <span> <span>default_type <span>text<span>/<span>plain<span>;</span></span></span></span></span></span> 
     </div> 
     <div> 
      <span> <span>echo <span>http_user_agent<span>:<span> <span>$<span>http_user_agent<span>;</span></span></span></span></span></span></span></span> 
     </div> 
     <div> 
      <span> <span>echo <span>agent<span>:<span> <span>agent<span>:<span>$<span>agent<span>;</span></span></span></span></span></span></span></span></span></span> 
     </div> 
     <div> 
      <span> <span>}</span></span> 
     </div> 
     <div> 
      <span> <span>}</span></span> 
     </div> 
     <div> 
      <span>}</span> 
     </div> 
     <div> 
      <span># curl 127.0.0.1:8080/hello&nbsp;&nbsp;</span> 
     </div> 
     <div> 
      <span>http_user_agent<span>:<span> <span>curl<span>/<span>7.15.5<span> <span>(<span>x86_64<span>-<span>redhat<span>-<span>linux<span>-<span>gnu<span>)<span> <span>libcurl<span>/<span>7.15.5<span> <span>OpenSSL<span>/<span>0.9.8b<span> <span>zlib<span>/<span>1.2.3<span> <span>libidn<span>/<span>0.6.5</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span> 
     </div> 
     <div> 
      <span>agent<span>:<span> <span>curl</span></span></span></span> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

[![map][]][map]  
[![map][map 1]][map 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div> 
     <div>
       1 
     </div> 
     <div>
       2 
     </div> 
     <div>
       3 
     </div> 
     <div>
       4 
     </div> 
     <div>
       5 
     </div> 
     <div>
       6 
     </div> 
     <div>
       7 
     </div> 
     <div>
       8 
     </div> 
     <div>
       9 
     </div> 
     <div>
       10 
     </div> 
     <div>
       11 
     </div> 
     <div>
       12 
     </div> 
     <div>
       13 
     </div> 
     <div>
       14 
     </div> 
     <div>
       15 
     </div> 
     <div>
       16 
     </div> 
     <div>
       17 
     </div> 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <span>http<span> <span>{ </span></span></span> 
     </div> 
     <div> 
      <span> <span>map<span> <span>$<span>uri<span> <span>$<span>match<span> <span>{ </span></span></span></span></span></span></span></span></span></span> 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span>~<span>^<span>/<span>hello<span>/<span>(<span>.<span>*<span>)<span> <span>http<span>:<span>//www.ttlsa.com/;</span></span></span></span></span></span></span></span></span></span></span></span></span></span> 
     </div> 
     <div> 
      <span> <span>}</span></span> 
     </div> 
     <div> 
      <span> <span>server<span> <span>{ </span></span></span></span> 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span>listen<span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span>8080<span>;</span></span></span></span></span> 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span>server_name&nbsp;&nbsp;<span>test<span>.<span>ttlsa<span>.<span>com<span>;</span></span></span></span></span></span></span></span> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span>location<span> <span>/<span>hello<span> <span>{ </span></span></span></span></span></span></span> 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span>default_type <span>text<span>/<span>plain<span>;</span></span></span></span></span></span> 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span>echo <span>uri<span>:<span> <span>$<span>uri<span>;</span></span></span></span></span></span></span></span> 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span>echo <span>match<span>:<span> <span>$<span>match<span>;</span></span></span></span></span></span></span></span> 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span>echo <span>capture<span>:<span> <span>$<span>1<span>;</span></span></span></span></span></span></span></span> 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span>echo <span>new<span>:<span> <span>$<span>match<span>$<span>1<span>;</span></span></span></span></span></span></span></span></span></span> 
     </div> 
     <div> 
      <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span>}</span></span> 
     </div> 
     <div> 
      <span> <span>}</span></span> 
     </div> 
     <div> 
      <span>}</span> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

[![map][map 2]][map 2]

如需转载请注明出处：http://www.ttlsa.com/html/3206.html

Nginx配置WebSocket反向代理  
问题描述  
目前项目中需要使用到WebSocket来进行通讯,所以就写了个Nginx反向代理WebSocket的配置文件.

很简单,但是很有效,能够横向扩展WebSocket服务端

先直接展示配置文件,如下(使用的话直接复制,然后改改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;  
\}  
\}  
1  
2  
3  
4  
5  
6  
7  
8  
9  
10  
11  
12  
13  
14  
15  
16  
17  
18  
19  
20  
21  
22  
23  
24  
25  
26  
27  
28  
会用了还需要理解(厚积薄发,不要让曾经的努力白费)

首先:

map $http\_upgrade $connection\_upgrade \{  
default upgrade;  
'' close;  
\}

表示的是

1. 如果 $http\_upgrade 不为 '' (空),则 $connection\_upgrade 为 upgrade  
2. 如果 $http\_upgrade 为 '' (空),则 $connection\_upgrade 为 close  
1  
2  
3  
4  
5  
6  
7  
8  
9  
其次:

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

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

server \{

listen 20038;

location /\{

表示的是监听的服务器的配置  
1. listen 20038 表示 nginx 监听的端口  
2. locations / 表示监听的路径(/表示所有路径,通用匹配,相当于default)  
3. proxt\_http\_version 1.1 表示反向代理发送的HTTP协议的版本是1.1,HTTP1.1支持长连接  
4. proxy\_pass http://wsbackend; 表示反向代理的uri,这里可以使用负载均衡变量  
5. proxy\_redirect off; 表示不要替换路径,其实这里如果是/则有没有都没关系,因为default也是将路径替换到proxy\_pass的后边  
6. proxy\_set\_header Host $host; 表示传递时请求头不变, $host是nginx内置变量,表示的是当前的请求头,proxy\_set\_header表示设置请求头  
7. proxy\_set\_header X-Real-IP $remote\_addr; 表示传递时来源的ip还是现在的客户端的ip  
8. proxy\_read\_timeout 3600s; 表的两次请求之间的间隔超过 3600s 后才关闭这个连接,默认的60s.自动关闭的元凶  
9. proxy\_set\_header X-Forwarded-For $proxy\_add\_x\_forwarded\_for; 表示X-Forwarded-For头不发生改变  
10. proxy\_set\_header Upgrade $http\_upgrade; 表示设置Upgrade不变  
11. proxy\_set\_header Connection $connection\_upgrade; 表示如果 $http\_upgra  
\---------------------  
作者：lhn1599085  
来源：CSDN  
原文：https://blog.csdn.net/lhn1599085/article/details/80612890  
版权声明：本文为博主原创文章，转载请附上博文链接！

转载于:https://www.cnblogs.com/zhengchunyuan/p/10843553.html

[copycode.gif]: /images/20211104/540914e9e67b46399582dd7f1b8e5a37.png
[nginx]: http://www.ttlsa.com/nginx/
[map]: /images/20211104/c1b4f03f93124de0b7cabc97c52452a2.png
[map 1]: /images/20211104/5651cf14e10642e9ad30b664ae1ffc43.png
[map 2]: /images/20211104/c86d8ea8b38a4e6591a4580969bd02ae.png