优化IP地址获取到多个的问题

ruoyi-common/ruoyi-common-core/src/main/java/com/ruoyi/common/core/utils/ip/IpUtils.java

@@ -12,58 +12,62 @@ import com.ruoyi.common.core.utils.StringUtils;
  */
 public class IpUtils
 {
+    /**
+     * 获取客户端IP
+     * 
+     * @param request 请求对象
+     * @return IP地址
+     */
     public static String getIpAddr(HttpServletRequest request)
     {
         if (request == null)
         {
-            return null;
+            return "unknown";
         }
-
+        String ip = request.getHeader("x-forwarded-for");
-        String ip = null;
+        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
-
-        // X-Forwarded-For：Squid 服务代理
-        String ipAddresses = request.getHeader("X-Forwarded-For");
-        if (ipAddresses == null || ipAddresses.length() == 0 || "unknown".equalsIgnoreCase(ipAddresses))
         {
-            // Proxy-Client-IP：apache 服务代理
+            ip = request.getHeader("Proxy-Client-IP");
-            ipAddresses = request.getHeader("Proxy-Client-IP");
         }
-        if (ipAddresses == null || ipAddresses.length() == 0 || "unknown".equalsIgnoreCase(ipAddresses))
+        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
         {
-            // WL-Proxy-Client-IP：weblogic 服务代理
+            ip = request.getHeader("X-Forwarded-For");
-            ipAddresses = request.getHeader("WL-Proxy-Client-IP");
         }
-        if (ipAddresses == null || ipAddresses.length() == 0 || "unknown".equalsIgnoreCase(ipAddresses))
+        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
         {
-            // HTTP_CLIENT_IP：有些代理服务器
+            ip = request.getHeader("WL-Proxy-Client-IP");
-            ipAddresses = request.getHeader("HTTP_CLIENT_IP");
         }
-        if (ipAddresses == null || ipAddresses.length() == 0 || "unknown".equalsIgnoreCase(ipAddresses))
+        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
         {
-            // X-Real-IP：nginx服务代理
+            ip = request.getHeader("X-Real-IP");
-            ipAddresses = request.getHeader("X-Real-IP");
         }
 
-        // 有些网络通过多层代理，那么获取到的ip就会有多个，一般都是通过逗号（,）分割开来，并且第一个ip为客户端的真实IP
+        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
-        if (ipAddresses != null && ipAddresses.length() != 0)
-        {
-            ip = ipAddresses.split(",")[0];
-        }
-
-        // 还是不能获取到，最后再通过request.getRemoteAddr();获取
-        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ipAddresses))
         {
             ip = request.getRemoteAddr();
         }
-        return ip.equals("0:0:0:0:0:0:0:1") ? "127.0.0.1" : ip;
+
+        return "0:0:0:0:0:0:0:1".equals(ip) ? "127.0.0.1" : getMultistageReverseProxyIp(ip);
     }
 
+    /**
+     * 检查是否为内部IP地址
+     * 
+     * @param ip IP地址
+     * @return 结果
+     */
     public static boolean internalIp(String ip)
     {
         byte[] addr = textToNumericFormatV4(ip);
         return internalIp(addr) || "127.0.0.1".equals(ip);
     }
 
+    /**
+     * 检查是否为内部IP地址
+     * 
+     * @param addr byte地址
+     * @return 结果
+     */
     private static boolean internalIp(byte[] addr)
     {
         if (StringUtils.isNull(addr) || addr.length < 2)
@@ -124,7 +128,8 @@ public class IpUtils
             {
                 case 1:
                     l = Long.parseLong(elements[0]);
-                    if ((l < 0L) || (l > 4294967295L)){
+                    if ((l < 0L) || (l > 4294967295L))
+                    {
                         return null;
                     }
                     bytes[0] = (byte) (int) (l >> 24 & 0xFF);
@@ -134,12 +139,14 @@ public class IpUtils
                     break;
                 case 2:
                     l = Integer.parseInt(elements[0]);
-                    if ((l < 0L) || (l > 255L)) {
+                    if ((l < 0L) || (l > 255L))
+                    {
                         return null;
                     }
                     bytes[0] = (byte) (int) (l & 0xFF);
                     l = Integer.parseInt(elements[1]);
-                    if ((l < 0L) || (l > 16777215L)) {
+                    if ((l < 0L) || (l > 16777215L))
+                    {
                         return null;
                     }
                     bytes[1] = (byte) (int) (l >> 16 & 0xFF);
@@ -150,13 +157,15 @@ public class IpUtils
                     for (i = 0; i < 2; ++i)
                     {
                         l = Integer.parseInt(elements[i]);
-                        if ((l < 0L) || (l > 255L)) {
+                        if ((l < 0L) || (l > 255L))
+                        {
                             return null;
                         }
                         bytes[i] = (byte) (int) (l & 0xFF);
                     }
                     l = Integer.parseInt(elements[2]);
-                    if ((l < 0L) || (l > 65535L)) {
+                    if ((l < 0L) || (l > 65535L))
+                    {
                         return null;
                     }
                     bytes[2] = (byte) (int) (l >> 8 & 0xFF);
@@ -166,7 +175,8 @@ public class IpUtils
                     for (i = 0; i < 4; ++i)
                     {
                         l = Integer.parseInt(elements[i]);
-                        if ((l < 0L) || (l > 255L)) {
+                        if ((l < 0L) || (l > 255L))
+                        {
                             return null;
                         }
                         bytes[i] = (byte) (int) (l & 0xFF);
@@ -183,6 +193,11 @@ public class IpUtils
         return bytes;
     }
 
+    /**
+     * 获取IP地址
+     * 
+     * @return 本地IP地址
+     */
     public static String getHostIp()
     {
         try
@@ -195,6 +210,11 @@ public class IpUtils
         return "127.0.0.1";
     }
 
+    /**
+     * 获取主机名
+     * 
+     * @return 本地主机名
+     */
     public static String getHostName()
     {
         try
@@ -206,4 +226,39 @@ public class IpUtils
         }
         return "未知";
     }
+
+    /**
+     * 从多级反向代理中获得第一个非unknown IP地址
+     *
+     * @param ip 获得的IP地址
+     * @return 第一个非unknown IP地址
+     */
+    public static String getMultistageReverseProxyIp(String ip)
+    {
+        // 多级反向代理检测
+        if (ip != null && ip.indexOf(",") > 0)
+        {
+            final String[] ips = ip.trim().split(",");
+            for (String subIp : ips)
+            {
+                if (false == isUnknown(subIp))
+                {
+                    ip = subIp;
+                    break;
+                }
+            }
+        }
+        return ip;
+    }
+
+    /**
+     * 检测给定字符串是否为未知，多用于检测HTTP请求相关
+     *
+     * @param checkString 被检测的字符串
+     * @return 是否未知
+     */
+    public static boolean isUnknown(String checkString)
+    {
+        return StringUtils.isBlank(checkString) || "unknown".equalsIgnoreCase(checkString);
+    }
 }