nginx proxy_set_header设置、自定义header

港控/mmm° 2022-09-26 00:28 361阅读 0赞

先来看下proxy\_set\_header的语法

<table> 
 <tbody> 
  <tr> 
   <td style="font-size:1em; vertical-align:baseline">语法:</td> 
   <td style="font-size:1em; vertical-align:baseline"><code style="font-family:'Courier New',Courier,monospace; font-size:1em; white-space:pre"><strong>proxy_set_header</strong>&nbsp;<code style="font-family:'Courier New',Courier,monospace; font-size:1em"><em>field</em></code>&nbsp;<code style="font-family:'Courier New',Courier,monospace; font-size:1em"><em>value</em></code>;</code></td> 
  </tr> 
  <tr> 
   <td style="font-size:1em; vertical-align:baseline">默认值:</td> 
   <td style="font-size:1em; vertical-align:baseline"> <pre style="white-space:pre-wrap; word-wrap:break-word; font-size:1em">proxy_set_header Host $proxy_host;</pre> <pre style="white-space:pre-wrap; word-wrap:break-word; font-size:1em">proxy_set_header Connection close;</pre> </td> 
  </tr> 
  <tr> 
   <td style="font-size:1em; vertical-align:baseline">上下文:</td> 
   <td style="font-size:1em; vertical-align:baseline"><code style="font-family:'Courier New',Courier,monospace; font-size:1em; white-space:pre">http</code>,&nbsp;<code style="font-family:'Courier New',Courier,monospace; font-size:1em; white-space:pre">server</code>,&nbsp;<code style="font-family:'Courier New',Courier,monospace; font-size:1em; white-space:pre">location</code></td> 
  </tr> 
 </tbody> 
</table>

允许重新定义或者添加发往后端服务器的请求头。`value`可以包含文本、变量或者它们的组合。 当且仅当当前配置级别中没有定义`proxy_set_header`指令时，会从上面的级别继承配置。 默认情况下，只有两个请求头会被重新定义：

>     proxy_set_header Host       $proxy_host;
>     proxy_set_header Connection close;
> 
>   
>

proxy\_set\_header也可以自定义参数，如：proxy\_set\_header test paroxy\_test;

如果想要支持下划线的话，需要增加如下配置：

underscores\_in\_headers on;

可以加到http或者server中

语法：underscores\_in\_headers on|off  
默认值：off  
使用字段：http, server  
是否允许在header的字段中带下划线

**在java端，需要获取proxy\_set\_header的参数时，需要使用request.getHeader(field)，一般用来获取真实ip地址**

\--------------------------------------------------------------------------------------------------------------------------------------------------------------

# 使用Nginx后如何在web应用中获取用户ip及原理解释 #

**问题背景：**

在实际应用中，我们可能需要获取用户的ip地址，比如做异地登陆的判断，或者统计ip访问次数等，通常情况下我们使用request.getRemoteAddr()就可以获取到客户端ip，但是当我们使用了nginx作为反向代理后，使用request.getRemoteAddr()获取到的就一直是nginx服务器的ip的地址，那这时应该怎么办？

**part1：解决方案**

我在查阅资料时，有一本名叫《实战nginx》的书，作者张晏，这本书上有这么一段话“经过反向代理后，由于在客户端和web服务器之间增加了中间层，因此web服务器无法直接拿到客户端的ip，通过$remote\_addr变量拿到的将是反向代理服务器的ip地址”。这句话的意思是说，当你使用了nginx反向服务器后，在web端使用request.getRemoteAddr()（本质上就是获取$remote\_addr），取得的是nginx的地址，即$remote\_addr变量中封装的是nginx的地址，当然是没法获得用户的真实ip的，但是，nginx是可以获得用户的真实ip的，也就是说nginx使用$remote\_addr变量时获得的是用户的真实ip，如果我们想要在web端获得用户的真实ip，就必须在nginx这里作一个赋值操作，如下：

proxy\_set\_header            X-real-ip $remote\_addr;

其中这个X-real-ip是一个自定义的变量名，名字可以随意取，这样做完之后，用户的真实ip就被放在X-real-ip这个变量里了，然后，在web端可以这样获取：

request.getAttribute("X-real-ip")

这样就明白了吧。

** **

**part2：原理介绍**

这里我们将nginx里的相关变量解释一下，通常我们会看到有这样一些配置

server \{

listen       88;

server\_name  localhost;

\#charset koi8-r;

\#access\_log  logs/host.access.log  main;

location /\{

root   html;

index  index.html index.htm;

proxy\_pass                  http://backend;

proxy\_redirect              off;

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\_set\_header            X-Forwarded-For $http\_x\_forwarded\_for;

我们来一条条的看

**1. proxy\_set\_header    X-real-ip $remote\_addr;**

这句话之前已经解释过，有了这句就可以在web服务器端获得用户的真实ip

但是，实际上要获得用户的真实ip，不是只有这一个方法，下面我们继续看。

**2.  proxy\_set\_header            X-Forwarded-For $proxy\_add\_x\_forwarded\_for;**

我们先看看这里有个X-Forwarded-For变量，这是一个squid开发的，用于识别通过HTTP代理或负载平衡器原始IP一个连接到Web服务器的客户机地址的非rfc标准，如果有做X-Forwarded-For设置的话,每次经过proxy转发都会有记录,格式就是client1, proxy1, proxy2,以逗号隔开各个地址，由于他是非rfc标准，所以默认是没有的，需要强制添加，在默认情况下经过proxy转发的请求，在后端看来远程地址都是proxy端的ip 。也就是说在默认情况下我们使用request.getAttribute("X-Forwarded-For")获取不到用户的ip，如果我们想要通过这个变量获得用户的ip，我们需要自己在nginx添加如下配置：

**proxy\_set\_header            X-Forwarded-For $proxy\_add\_x\_forwarded\_for;**

意思是增加一个$proxy\_add\_x\_forwarded\_for到X-Forwarded-For里去，注意是增加，而不是覆盖，当然由于默认的X-Forwarded-For值是空的，所以我们总感觉X-Forwarded-For的值就等于$proxy\_add\_x\_forwarded\_for的值，实际上当你搭建两台nginx在不同的ip上，并且都使用了这段配置，那你会发现在web服务器端通过request.getAttribute("X-Forwarded-For")获得的将会是客户端ip和第一台nginx的ip。

**那么$proxy\_add\_x\_forwarded\_for又是什么？**

$proxy\_add\_x\_forwarded\_for变量包含客户端请求头中的"X-Forwarded-For"，与$remote\_addr两部分，他们之间用逗号分开。

举个例子，有一个web应用，在它之前通过了两个nginx转发，www.linuxidc.com 即用户访问该web通过两台nginx。

在第一台nginx中,使用

proxy\_set\_header            X-Forwarded-For $proxy\_add\_x\_forwarded\_for;

现在的$proxy\_add\_x\_forwarded\_for变量的"X-Forwarded-For"部分是空的，所以只有$remote\_addr，而$remote\_addr的值是用户的ip，于是赋值以后，X-Forwarded-For变量的值就是用户的真实的ip地址了。

到了第二台nginx，使用

proxy\_set\_header            X-Forwarded-For $proxy\_add\_x\_forwarded\_for;

现在的$proxy\_add\_x\_forwarded\_for变量，X-Forwarded-For部分包含的是用户的真实ip，$remote\_addr部分的值是上一台nginx的ip地址，于是通过这个赋值以后现在的X-Forwarded-For的值就变成了“用户的真实ip，第一台nginx的ip”，这样就清楚了吧。

最后我们看到还有一个$http\_x\_forwarded\_for变量，这个变量就是X-Forwarded-For，由于之前我们说了，默认的这个X-Forwarded-For是为空的，所以当我们直接使用proxy\_set\_header            X-Forwarded-For $http\_x\_forwarded\_for时会发现，web服务器端使用request.getAttribute("X-Forwarded-For")获得的值是null。如果想要通过request.getAttribute("X-Forwarded-For")获得用户ip，就必须先使用proxy\_set\_header            X-Forwarded-For $proxy\_add\_x\_forwarded\_for;这样就可以获得用户真实ip。