nginx代理接口

上周帮同事调一个前端跨域问题，理接折腾了半小时没搞定，理接最后发现是理接nginx代理配置里多写了一个斜杠。这件事让我觉得，理接nginx代理接口这事，理接看着简单，理接坑却不少。理接

先说一个最常被忽略的理接点：proxy_pass后面加不加斜杠，行为完全不同。理接举个例子，理接假设你有一条location规则：

location /api/ {  proxy_pass http://backend:8080/; }

请求/api/user/list，理接转发到后端就变成/user/list。理接但如果写成proxy_pass http://backend:8080;，理接没有末尾那个斜杠，理接转发过去就是理接/api/user/list。差别就在这一条斜杠上，很多人第一次配代理时根本不会注意到，等前端报404了才回头查。

我的习惯是：只要location路径带/api/这种前缀，proxy_pass就加上斜杠，把前缀干净地切掉。反过来，如果后端接口本身就包含这个前缀，那就不加。这个逻辑想清楚了，配置几乎不会出错。

再说一个实际项目里遇到的案例。我们有个网关服务，前面挂了一层nginx做反向代理。某天运维改了配置，加了一行proxy_set_header Host $host;，结果后端所有接口返回的跳转链接全乱了。原因很简单——后端根据Host头拼接重定向地址，nginx默认传过去的是$proxy_host，也就是后端服务的内部主机名。运维改成$host之后，Host头变成了用户访问的域名，后端拼出来的地址自然就对了。但那次改动没通知开发，排查了一阵子才定位到。

代理接口时，请求头这块要特别留心。Host、X-Real-IP、X-Forwarded-For、X-Forwarded-Proto，这几个头该传的都要传。尤其是X-Forwarded-Proto，如果nginx前面还有一层HTTPS终止（比如云负载均衡），不传这个头，后端会以为用户走的是HTTP，生成的链接全带http://，浏览器直接报混合内容警告。我见过不止一个项目栽在这上面。

超时设置也是容易被忽略的地方。nginx默认的proxy_read_timeout是60秒，对于普通接口够用。但如果你代理的是一个导出报表的接口，后端处理要两三分钟，那60秒一到nginx就断开了，前端拿到502。这时候需要把proxy_read_timeout和proxy_send_timeout都调大。不过也别无脑调成600秒，得看后端实际处理时间，设一个合理的上限。

还有proxy_buffering。默认是开的，nginx会把后端响应先缓冲到内存或磁盘，再发给客户端。对于大文件下载或者流式接口（比如SSE），这个缓冲会带来延迟，甚至把流式响应变成一次性返回。我一般对SSE接口单独关掉：proxy_buffering off;，加上proxy_cache off;，让数据直接透传。

最后提一个调试技巧。配完代理发现不通，别急着改配置。先用curl -v http://nginx-host/api/xxx看nginx返回什么，再用curl -v http://backend:8080/xxx直接打后端，对比两边差异。大多数时候问题就出在路径重写、请求头丢失或者后端本身没起来。nginx的error.log也要看，proxy_pass失败时会有明确记录，比瞎猜快得多。

nginx代理接口这件事，核心就一句话：想清楚请求从客户端到后端，路径、请求头、超时、缓冲这四样东西分别发生了什么变化。把这四点理清楚，配置写出来基本不会有大问题。