feat: 添加一个 获取请求 IP 地址的工具方法

Author: cadecode

simple-common/src/main/java/top/cadecode/common/util/WebUtil.java

@@ -1,24 +1,40 @@
 package top.cadecode.common.util;
 
+import lombok.extern.slf4j.Slf4j;
 import org.springframework.http.MediaType;
 import top.cadecode.common.core.exception.CommonException;
 import top.cadecode.common.enums.FrameErrorEnum;
 
+import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import java.io.IOException;
 import java.io.PrintWriter;
+import java.net.InetAddress;
+import java.net.UnknownHostException;
+import java.util.Arrays;
+import java.util.List;
 
 /**
  * @author Cade Li
  * @date 2021/12/11
  * @description Web 工具类
  */
+@Slf4j
 public class WebUtil {
 
+    /**
+     * 未知 IP
+     */
+    private static final String UNKNOWN_IP = "unknown";
+    /**
+     * 本地 IP 地址
+     */
+    private static final List<String> LOCAL_IP_LIST = Arrays.asList("127.0.0.1", "0:0:0:0:0:0:0:1");
+
     /**
      * 向响应对象写入 JSON
      *
-     * @param response 响应对象
+     * @param response   响应对象
      * @param jsonString JSON 字符串
      */
     public static void writeJsonToResponse(HttpServletResponse response, String jsonString) {
@@ -33,4 +49,44 @@ public static void writeJsonToResponse(HttpServletResponse response, String json
                     .suppressed(e);
         }
     }
+
+    /**
+     * 获取被代理的真实 IP
+     *
+     * @param request 请求对象
+     * @return ip
+     */
+    public static String getIpAddress(HttpServletRequest request) {
+        // squid
+        String ip = request.getHeader("X-Forwarded-For");
+        // tomcat
+        if (ip == null || ip.length() == 0 || UNKNOWN_IP.equalsIgnoreCase(ip)) {
+            ip = request.getHeader("Proxy-Client-IP");
+        }
+        // webLogic
+        if (ip == null || ip.length() == 0 || UNKNOWN_IP.equalsIgnoreCase(ip)) {
+            ip = request.getHeader("WL-Proxy-Client-IP");
+        }
+        // nginx
+        if (ip == null || ip.length() == 0 || UNKNOWN_IP.equalsIgnoreCase(ip)) {
+            ip = request.getHeader("X-Real-IP");
+        }
+        // 从 request 获取
+        if (ip == null || ip.length() == 0 || UNKNOWN_IP.equalsIgnoreCase(ip)) {
+            ip = request.getRemoteAddr();
+        }
+        // 获取到的 ip 地址可能经过追加，一般使用 ‘,’ 分隔
+        if (ip.contains(",")) {
+            ip = ip.split(",")[0];
+        }
+        // 本地访问，需要获取本机真正的ip地址
+        if (LOCAL_IP_LIST.contains(ip)) {
+            try {
+                ip = InetAddress.getLocalHost().getHostAddress();
+            } catch (UnknownHostException e) {
+                log.error(e.getMessage(), e);
+            }
+        }
+        return ip;
+    }
 }

simple-framework/src/main/java/top/cadecode/framework/aspect/ResponseLoggerAspect.java

@@ -12,16 +12,17 @@
 import org.aspectj.lang.reflect.MethodSignature;
 import org.springframework.stereotype.Component;
 import org.springframework.util.ObjectUtils;
-import org.springframework.util.StringUtils;
 import org.springframework.web.context.request.RequestContextHolder;
 import org.springframework.web.context.request.ServletRequestAttributes;
 import top.cadecode.common.annotation.ResponseLogger;
 import top.cadecode.common.util.JsonUtil;
+import top.cadecode.common.util.WebUtil;
 
 import javax.servlet.http.HttpServletRequest;
-import java.net.InetAddress;
-import java.net.UnknownHostException;
-import java.util.*;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Objects;
 
 /**
  * @author Cade Li
@@ -33,9 +34,6 @@
 @Component
 public class ResponseLoggerAspect {
 
-    // 本地 IP 地址
-    private static final List<String> LOCAL_IP_LIST = Arrays.asList("127.0.0.1", "0:0:0:0:0:0:0:1");
-
     /**
      * 环绕通知
      *
@@ -72,7 +70,7 @@ public Object around(ProceedingJoinPoint point, ResponseLogger responseLogger) t
                 .threadId(Long.toString(Thread.currentThread().getId()))
                 .threadName(Thread.currentThread().getName())
                 .classMethod(point.getSignature().getDeclaringTypeName() + '.' + point.getSignature().getName())
-                .ip(ResponseLoggerAspect.getIpAddress(request))
+                .ip(WebUtil.getIpAddress(request))
                 .url(request.getRequestURL().toString())
                 .httpMethod(request.getMethod())
                 .requestParams(ResponseLoggerAspect.getRequestParams(point))
@@ -86,26 +84,6 @@ public Object around(ProceedingJoinPoint point, ResponseLogger responseLogger) t
         return result;
     }
 
-    /**
-     * 获取 IP 地址
-     */
-    public static String getIpAddress(HttpServletRequest request) {
-        // 解析请求头 X-Forwarded-For 获取主机地址
-        String ip = request.getHeader("X-Forwarded-For");
-        if (!StringUtils.hasLength(ip)) {
-            ip = request.getRemoteAddr();
-            // 获取本机真正的ip地址
-            if (LOCAL_IP_LIST.contains(ip)) {
-                try {
-                    ip = InetAddress.getLocalHost().getHostAddress();
-                } catch (UnknownHostException e) {
-                    log.error(e.getMessage(), e);
-                }
-            }
-        }
-        return ip;
-    }
-
     /**
      * 获取方法参数名和参数值
      */