文章目录
  1. 1. 问题
    1. 1.1. 问题产生的原因
    2. 1.2. 解决方案
  2. 2. Nginx
  3. 3. Jetty/Tomcat
    1. 3.1. Jetty
    2. 3.2. Tomcat

问题

Nginx反向代理后，Servlet应用通过request.getRemoteAddr()取到的IP是Nginx的IP地址，并非客户端真实IP，通过request.getRequestURL()获取的域名、协议、端口都是Nginx访问Web应用时的域名、协议、端口，而非客户端浏览器地址栏上的真实域名、协议、端口。

例如在某一台IP为10.4.64.22的服务器上，Jetty或者Tomcat端口号为8080，Nginx端口号80，Nginx反向代理8080端口：

1
2
3
4
5
6
server {
	listen 80;
	location / {
		proxy_pass http://127.0.0.1:8080; # 反向代理应用服务器HTTP地址
	}
}

在另一台机器上用浏览器打开http://10.4.64.22/test访问某个Servlet应用，获取客户端IP和URL：

1
2
System.out.println("RemoteAddr: " + request.getRemoteAddr());
System.out.println("URL: " + request.getRequestURL().toString());

结果是：

1
2
RemoteAddr: 127.0.0.1
URL: http://127.0.0.1:8080/test

可以发现，Servlet程序获取到的客户端IP是本地Nginx的IP而非浏览器所在机器的IP，获取到的URL是Nginx proxy_pass配置的URL组成的地址，而非浏览器地址栏上的真实地址。如果将Nginx用作https服务器反向代理后端的http服务，那么request.getRequestURL()获取的URL是http前缀的而非https前缀，无法获取到浏览器地址栏的真实协议。如果此时将request.getRequestURL()获取得到的URL用作拼接Redirect地址，就会出现跳转到错误的地址，这也是Nginx反向代理时经常出现的一个问题。

问题产生的原因

Nginx的反向代理实际上是客户端和真实的应用服务器之间的一个桥梁，客户端（一般是浏览器）访问Nginx服务器，Nginx再去访问Web应用服务器。对于Web应用来说，这次HTTP请求的客户端是Nginx而非真实的客户端浏览器，如果不做特殊处理的话，Web应用会把Nginx当作请求的客户端，获取到的客户端信息就是Nginx的一些信息。

解决方案

解决这个问题要从两个方面来解决：

  1. 由于Nginx是代理服务器，所有客户端请求都从Nginx转发到Jetty/Tomcat，如果Nginx不把客户端真实IP、域名、协议、端口告诉Jetty/Tomcat，那么Jetty/Tomcat应用是永远不会知道这些信息的，所以需要Nginx配置一些HTTP Header来将这些信息告诉被代理的Jetty/Tomcat；
  2. Jetty/Tomcat这一端，不能再傻乎乎的获取直接和它连接的客户端（也就是Nginx）的信息，而是要从Nginx传递过来的HTTP Header中获取客户端信息。

Nginx

添加以下配置：

1
2
3
4
proxy_set_header Host $http_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-Proto $scheme;

解释以下上面的配置，以上配置是在Nginx反向代理的时候，添加一些请求Header。

  1. Host包含客户端真实的域名和端口号；
  2. X-Forwarded-Proto表示客户端真实的协议（http还是https）；
  3. X-Real-IP表示客户端真实的IP；
  4. X-Forwarded-For和X-Real-IP类似，但它在多层代理时会包含真实客户端及中间每个代理服务器的IP，每个IP用逗号隔开，一般来说最左边的第一个IP地址就是客户端IP。

再试一下request.getRemoteAddr()和request.getRequestURL()的输出结果：

1
2
RemoteAddr: 127.0.0.1
URL: http://10.4.64.22/test

可以发现URL好像已经没问题了，但是IP还是本地的IP而非真实客户端IP。但是如果是用Nginx作为https服务器反向代理到http服务器，会发现浏览器地址栏是https前缀但是request.getRequestURL()获取到的URL还是http前缀，也就是仅仅配置Nginx还不能彻底解决问题。

Jetty/Tomcat

如果你在网上搜索“Java如何获取客户端真实IP”，搜索到的解决方案大多是通过获取HTTP请求头request.getHeader("X-Forwarded-For")或request.getHeader("X-Real-IP")来实现，也就是上面在Nginx上配置的Header，这种方案获取的结果的确是正确的，但是我个人觉得并不优雅。因为既然Servlet API提供了request.getRemoteAddr()方法获取客户端IP，那么无论有没有用反向代理对于代码编写者来说应该是透明的。下面介绍一种更加优雅的方式。

Jetty

在Jetty服务器的jetty.xml文件中，找到httpConfig，加入配置：

1
2
3
4
5
6
7
8
<New id="httpConfig" class="org.eclipse.jetty.server.HttpConfiguration">

	...

  <Call name="addCustomizer">
    <Arg><New class="org.eclipse.jetty.server.ForwardedRequestCustomizer"/></Arg>
  </Call>
</New>

重新启动Jetty，再用浏览器打开http://10.4.64.22/test测试，结果：

1
2
RemoteAddr: 10.1.3.7
URL: http://10.4.64.22/test

此时可发现通过request.getRemoteAddr()获取到的IP不再是127.0.0.1而是客户端真实IP，request.getRequestURL()获取的URL也是浏览器上的真实URL，如果Nginx作为https代理，request.getRequestURL()的前缀也会是https。

另外，Jetty将这个功能封装成一个模块：http-forwarded。如果不想改jetty.xml配置文件的话，也可以启用http-forwarded模块来实现。

例如可以通过命令行启动Jetty：

1
java -jar start.jar --module=http-forwarded

如果有兴趣可以查看org.eclipse.jetty.server.ForwardedRequestCustomizer的源码，原理也就是从X-Forwarded-For头中取到第一个IP地址。

Tomcat

和Jetty类似，如果使用Tomcat作为应用服务器，可以通过配置Tomcat的server.xml文件，在Host元素内最后加入：

1
<Valve className="org.apache.catalina.valves.RemoteIpValve" />

更多用法也可以参考文档：https://tomcat.apache.org/tomcat-8.5-doc/api/org/apache/catalina/valves/RemoteIpValve.html

文章目录
  1. 1. 问题
    1. 1.1. 问题产生的原因
    2. 1.2. 解决方案
  2. 2. Nginx
  3. 3. Jetty/Tomcat
    1. 3.1. Jetty
    2. 3.2. Tomcat