feat: gateway 添加 filter 生成 traceId

Author: cadecode

gateway/src/main/java/com/github/cadecode/uniboot/gateway/filter/RequestHeaderFilter.java

@@ -2,6 +2,7 @@
 
 import org.springframework.cloud.gateway.filter.GatewayFilterChain;
 import org.springframework.cloud.gateway.filter.GlobalFilter;
+import org.springframework.core.annotation.Order;
 import org.springframework.http.server.reactive.ServerHttpRequest;
 import org.springframework.stereotype.Component;
 import org.springframework.web.server.ServerWebExchange;
@@ -13,16 +14,21 @@
  * @author Cade Li
  * @since 2023/8/8
  */
+@Order(1)
 @Component
 public class RequestHeaderFilter implements GlobalFilter {
 
+    public static final String HEAD_SOURCE = "from-source";
+
+    public static final String HEAD_USER_DETAILS = "inner-user-details";
+
     @Override
     public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
         // 去掉内部调用专用的请求头，防止伪造
         ServerHttpRequest request = exchange.getRequest().mutate()
                 .headers(h -> {
-                    h.remove("from-source");
-                    h.remove("inner-user-details");
+                    h.remove(HEAD_SOURCE);
+                    h.remove(HEAD_USER_DETAILS);
                 })
                 .build();
         return chain.filter(exchange.mutate().request(request).build());

gateway/src/main/java/com/github/cadecode/uniboot/gateway/filter/TraceInfoFilter.java

@@ -0,0 +1,37 @@
+package com.github.cadecode.uniboot.gateway.filter;
+
+import cn.hutool.core.lang.UUID;
+import org.slf4j.MDC;
+import org.springframework.cloud.gateway.filter.GatewayFilterChain;
+import org.springframework.cloud.gateway.filter.GlobalFilter;
+import org.springframework.core.annotation.Order;
+import org.springframework.http.server.reactive.ServerHttpRequest;
+import org.springframework.stereotype.Component;
+import org.springframework.web.server.ServerWebExchange;
+import reactor.core.publisher.Mono;
+
+/**
+ * 用于添加 trace id 的过滤器
+ *
+ * @author Cade Li
+ * @since 2023/8/10
+ */
+@Order(0)
+@Component
+public class TraceInfoFilter implements GlobalFilter {
+
+    public static final String HEAD_TRACE_ID = "trace-id";
+
+    @Override
+    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
+        String traceId = UUID.fastUUID().toString(true);
+        ServerHttpRequest request = exchange.getRequest().mutate()
+                .headers(h -> {
+                    MDC.put(HEAD_TRACE_ID, traceId);
+                    h.set(HEAD_TRACE_ID, traceId);
+                })
+                .build();
+        exchange.getResponse().getHeaders().set(HEAD_TRACE_ID, traceId);
+        return chain.filter(exchange.mutate().request(request).build());
+    }
+}

gateway/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">