Nginx最为最受欢迎的反向代理和负载均衡服务器,被广泛的应用于互联网项目中。这不仅仅是因为Nginx本身比较轻量,更多的是得益于Nginx的高性能特性,以及支持插件化开发,为此,很多开发者或者公司基于Nginx开发出了众多的高性能插件。使用者可以根据自身的需求来为Nginx指定某款插件以增强Nginx在某种特定场景下的功能或者提升Nginx在某种特定场景下的性能。
获取客户端信息
客户信息主要指:客户真是IP、域名、协议、端口
Nginx反向代理后,Servlet应用通过 request.getRemoteAddr() 取到的IP是Nginx的IP地址,并非客户端真实IP,通过 request.getRequestURL() 获取的域名、协议、端口都是Nginx访问Web应用时的域名、协议、端口,而非客户端浏览器地址栏上的真实域名、协议、端口
存在的问题:
例如在某一台IP为192.168.11.101的服务器上,Jetty或者Tomcat端口号为8080,Nginx端口号80,Nginx反向代理8080端口:
- server {
- listen 80;
- location / {
- proxy_pass http://127.0.0.1:8080; # 反向代理应用服务器HTTP地址
- }
- }
在另一台机器上用浏览器打开http://192.168.11.100/test访问某个Servlet应用,获取客户端IP和URL:
- System.out.println("RemoteAddr: " + request.getRemoteAddr());
- System.out.println("URL: " + request.getRequestURL().toString());
控制台输出结果:
- RemoteAddr: 127.0.0.1
- URL: http://127.0.0.1:8080/test
最终结果可以发现,程序获取到的客户端IP是Nginx的IP而非浏览器所在机器的IP,获取到的URL是Nginx配置的proxy_pass的URL组成的地址,而非浏览器地址栏上的真实地址。如果将ginx用作https服务器反向代理后端的http服务,那么 request.getRequestURL() 获取的URL是http前缀的而非https前缀,无法获取到浏览器地址栏的真实协议。如果此时将request.getRequestURL() 获取得到的URL用作拼接Redirect地址,就会出现跳转到错误的地址,这也是Nginx反向代理时经常出现的一个问题。
解决方案:
由于Nginx是代理服务器,所有客户端请求都从Nginx转发到Tomcat,如果Nginx不把客户端真实IP、域名、协议、端口告诉Jetty/Tomcat,那么Tomcat应用永远不会知道这些信息,所以需要Nginx配置一些HTTP Header来将这些信息告诉被代理的Tomcat。
Tomcat端,不能再获取直接和它连接的客户端(也就是Nginx)的信息,而是要从
Nginx传递过来的HTTP Header中获取客户端信息。
Nginx配置:
我们需要在Nginx的配置文件nginx.conf中添加如下配置
- 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;
参数含义解析:
重新使用 request.getRemoteAddr() 和 request.getRequestURL() 的输出结果:
- RemoteAddr: 127.0.0.1
- URL: http://192.168.11.100/test
可以发现URL好像已经没问题了,但是IP还是本地的IP而非真实客户端IP。但是如果是用Nginx作为https服务器反向代理到http服务器,会发现浏览器地址栏是https前缀但是request.getRequestURL() 获取到的URL还是http前缀,也就是仅仅配置Nginx还不能彻底解决问
题
这个时候就需要通过JAVA代码解决以上问题:
- /***
- * 获取客户端IP地址;这里通过了Nginx获取;X-Real-IP
- */
- public static String getClientIP(HttpServletRequest request) {
- String fromSource = "X-Real-IP";
- String ip = request.getHeader("X-Real-IP");
- if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
- ip = request.getHeader("X-Forwarded-For");
- fromSource = "X-Forwarded-For";
- }
- if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
- ip = request.getHeader("Proxy-Client-IP");
- fromSource = "Proxy-Client-IP";
- }
- if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
- ip = request.getHeader("WL-Proxy-Client-IP");
- fromSource = "WL-Proxy-Client-IP";
- }
- if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
- ip = request.getRemoteAddr();
- fromSource = "request.getRemoteAddr";
- }
- return ip;
- }
这种方式虽然能够获取客户端的IP地址、问题也就解决了
Tomcat服务器配置:
配置Tomcat的server.xml文件,在Host元素内最后加入:
<Valve className="org.apache.catalina.valves.RemoteIpValve" />