【记一次Nginx配置时由于转义带来的问题】

记一次Nginx配置时由于转义带来的问题

相信大家在平时的开发过程中都或多或少地接触过MQ中间件，这里就介绍一次在nginx上配置MQ web console代理地址时的经历。

我们需要在nginx上配置一个跳转链接可以直接指向MQ web console的页面，当时想着直接配置一个跳转就可以了。于是直接上手编辑nginx的conf文件，加入了如下配置：

// web console proxy
location /path/ {
proxy_pass http://example.com:80/;
}

满心欢喜地在浏览器上输入网址，看到熟悉的界面，心想这就是小菜一碟，于是就去忙别的了。

但是，后来小伙伴使用的时候发现有的链接打开时会报错，如下图：

我刚收到这个反馈时觉得这不可能吧，这种配置我可是做过无数遍了，而且登录页面是能够正常显示的啊！！
我抱着怀疑的态度，打开web console，结果发现确实有些页面是无法正常打开，这让我百思不得其解。不过凭借着丰富的“找不同”经验，我很快发现问题出在这个"%2F"特殊符号上，如果url路径包含符号，页面就会报错。

Nginx会在跳转时自动进行转义，转义前是这样的：

http://example.com/exchanges/%2Fview/

而Nginx将其转义成这样传递给应用程序：

http://example.com/exchanges//view/

好了，问题的原因找到了，那么如何解决呢？

在万能的度娘上查了好半天，尝试了各种“经常之谈”的方法，终于解决了，话不多说直接上配置：

location /path/ {
proxy_pass http://example.com:80/;
}

location ~* /path/api/ {
	rewrite ^ $request_uri;
	rewrite ^/path/api/(.*) /api/$1 break;
	return 400;
	proxy_pass http://example.com:80$uri;
	proxy_buffering	off;
	proxy_set_header Host $http_addr;
	proxy_set_header X-Real-IP $remote_addr;
	proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
	proxy_set_header X-Forwarded-Proto $scheme;
}

下面再介绍一下这中原理吧，首先来说一下Nginx的路径匹配规则：

location

大家都知道 ~* 是不区分大小写正则匹配，location的匹配优先顺序是：

 ( location = ) > ( location <完整路径> ) > ( location ^~ ) > ( location ~ 或 ~* ) > ( location <部分路径> ) > ( location / )

rewrite

rewrite是Nginx重定向http请求的一种方式，具体语法如下：

Syntax:	rewrite regex replacement [flag];
Default:	—
Context:	server, location, if

上例中第一个rewrite 这里又涉及到一个知识点，$request_uri 这个变量等于从客户端发送来的原始请求URI（最原始的），包括参数，它不可以进行修改。
匹配完第一个rewrite，继续匹配第二个rewrite，把/path 前缀去掉，然后break。

具体规则详见 ngx_http_rewrite_module

到最后 proxy_pass 这行使用到了另一个变量 $uri，这个变量指当前的请求URI，不包括任何参数。重点是这个变量反映任何内部重定向或index模块所做的修改。 所以这里使用rewrite功能绕过了Nginx的转义功能，使url显示正确。