feat: 配置 trace id 过滤器，配置 feign 传递 trace id

Author: cadecode

example/example_svc/src/main/resources/logback-spring.xml

@@ -24,9 +24,9 @@
 
     <!--输出格式-->
     <property name="consolePattern"
-              value="%red(%d{yyyy-MM-dd HH:mm:ss.SSS}) %green([%-15thread]) %highlight(%-5level) %cyan(%-50logger{50}) : %msg%n"/>
+              value="%red(%d{yyyy-MM-dd HH:mm:ss.SSS}) %green([%-15thread]-%X{trace-id}) %highlight(%-5level) %cyan(%-50logger{50}) : %msg%n"/>
     <!--不带色彩的格式用以输出到文件-->
-    <property name="filePattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%-15thread] %-5level %-50logger{50} : %msg%n"/>
+    <property name="filePattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%-15thread]-%X{trace-id} %-5level %-50logger{50} : %msg%n"/>
 
     <!--控制台输出日志-->
     <appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender">

framework/framework_api/src/main/java/com/github/cadecode/uniboot/framework/api/config/FeignConfig.java

@@ -52,7 +52,12 @@ protected void configRequestTemplate(RequestTemplate requestTemplate) {
             return;
         }
         // 配置客户端 IP
-        requestTemplate.header("X-Forwarded-For", ServletUtil.getClientIP(servletRequest));
+        requestTemplate.header(SecurityConst.HEAD_FORWARDED_FOR, ServletUtil.getClientIP(servletRequest));
+        // 传递 trace id
+        String traceId = ServletUtil.getHeader(servletRequest, SecurityConst.HEAD_TRACE_ID, CharsetUtil.CHARSET_UTF_8);
+        if (ObjectUtil.isNotEmpty(traceId)) {
+            requestTemplate.header(SecurityConst.HEAD_TRACE_ID, traceId);
+        }
         // 传递用户 token
         String token = SecurityUtil.getTokenFromRequest(servletRequest);
         if (StrUtil.isNotEmpty(token)) {

framework/framework_api/src/main/java/com/github/cadecode/uniboot/framework/api/config/SecurityConfig.java

@@ -2,7 +2,11 @@
 
 import cn.hutool.core.collection.CollUtil;
 import cn.hutool.core.util.ArrayUtil;
+import cn.hutool.core.util.CharsetUtil;
+import cn.hutool.core.util.ObjectUtil;
+import cn.hutool.extra.servlet.ServletUtil;
 import com.github.cadecode.uniboot.framework.api.config.SecurityConfig.SecurityProperties;
+import com.github.cadecode.uniboot.framework.api.consts.SecurityConst;
 import com.github.cadecode.uniboot.framework.api.enums.AuthModelEnum;
 import com.github.cadecode.uniboot.framework.api.security.filter.TokenAuthFilter;
 import com.github.cadecode.uniboot.framework.api.security.handler.NoAuthenticationHandler;
@@ -11,6 +15,7 @@
 import lombok.Data;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
+import org.slf4j.MDC;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
@@ -26,7 +31,13 @@
 import org.springframework.security.config.http.SessionCreationPolicy;
 import org.springframework.security.web.access.expression.WebExpressionVoter;
 import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;
+import org.springframework.web.filter.OncePerRequestFilter;
 
+import javax.servlet.FilterChain;
+import javax.servlet.ServletException;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import java.io.IOException;
 import java.util.Arrays;
 import java.util.List;
 
@@ -89,6 +100,8 @@ protected void configure(HttpSecurity http) throws Exception {
                         Arrays.asList(new WebExpressionVoter(), dataBaseRoleVoter)));
         // 配置 Token 校验过滤器
         http.addFilterBefore(tokenAuthFilter, UsernamePasswordAuthenticationFilter.class);
+        // 配置 trace id 过滤器
+        http.addFilterBefore(new TraceInfoFilter(), TokenAuthFilter.class);
         log.info("Config Security over，AuthModel:{}", properties.getAuthModel());
     }
 
@@ -147,4 +160,21 @@ public static class TokenConfig {
          */
         private String secret;
     }
+
+    /**
+     * Filter
+     * trace id to MDC
+     */
+    public static class TraceInfoFilter extends OncePerRequestFilter {
+        @Override
+        protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain
+                filterChain)
+                throws ServletException, IOException {
+            String traceId = ServletUtil.getHeader(request, SecurityConst.HEAD_TRACE_ID, CharsetUtil.CHARSET_UTF_8);
+            if (ObjectUtil.isNotEmpty(traceId)) {
+                MDC.put(SecurityConst.HEAD_TRACE_ID, traceId);
+            }
+            filterChain.doFilter(request, response);
+        }
+    }
 }

framework/framework_api/src/main/java/com/github/cadecode/uniboot/framework/api/consts/SecurityConst.java

@@ -28,4 +28,14 @@ public interface SecurityConst {
      */
     String HEAD_USER_DETAILS = "inner-user-details";
 
+    /**
+     * X-Forwarded-For
+     */
+    String HEAD_FORWARDED_FOR = "X-Forwarded-For";
+
+    /**
+     * trace id
+     */
+    String HEAD_TRACE_ID = "trace-id";
+
 }

framework/framework_svc/src/main/resources/logback-spring.xml

@@ -24,9 +24,9 @@
 
     <!--输出格式-->
     <property name="consolePattern"
-              value="%red(%d{yyyy-MM-dd HH:mm:ss.SSS}) %green([%-15thread]) %highlight(%-5level) %cyan(%-50logger{50}) : %msg%n"/>
+              value="%red(%d{yyyy-MM-dd HH:mm:ss.SSS}) %green([%-15thread]-%X{trace-id}) %highlight(%-5level) %cyan(%-50logger{50}) : %msg%n"/>
     <!--不带色彩的格式用以输出到文件-->
-    <property name="filePattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%-15thread] %-5level %-50logger{50} : %msg%n"/>
+    <property name="filePattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%-15thread]-%X{trace-id} %-5level %-50logger{50} : %msg%n"/>
 
     <!--控制台输出日志-->
     <appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender">