traceid实现

需要依赖

            <dependency><groupId>com.alibaba</groupId><artifactId>transmittable-thread-local</artifactId><version>2.14.5</version></dependency>

public class TraceIdContext {private static final String TRACE_ID = "traceId";private static final TransmittableThreadLocal<String> context = new TransmittableThreadLocal<>();// 使用雪花算法生成分布式唯一IDprivate static final Snowflake snowflake = IdUtil.getSnowflake(1, 1);public static void setTraceId(String traceId) {context.set(traceId);MDC.put(TRACE_ID, traceId);}/*** 生成新的雪花ID并设置为TraceId*/public static String generateAndSetTraceId() {String traceId = snowflake.nextIdStr();setTraceId(traceId);return traceId;}public static String generateTraceId() {return snowflake.nextIdStr();}public static String getTraceId() {return context.get();}public static void clear() {context.remove();MDC.remove(TRACE_ID);}
}

TraceIdFilter实现

@Slf4j
public class TraceIdFilter extends OncePerRequestFilter {private static final String TRACE_ID_HEADER = "X-Trace-Id";@Overrideprotected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)throws ServletException, IOException {try {String traceId = request.getHeader(TRACE_ID_HEADER);if (StrUtil.isEmpty(traceId)) {traceId = TraceIdContext.generateAndSetTraceId();} else {TraceIdContext.setTraceId(traceId);}// 设置到响应头response.addHeader(TRACE_ID_HEADER, traceId);filterChain.doFilter(request, response);} finally {TraceIdContext.clear();}}
}

注册TraceFilterConfig

@Configuration
public class TraceFilterConfig  {@Beanpublic FilterRegistrationBean<TraceIdFilter> traceIdFilter() {FilterRegistrationBean<TraceIdFilter> registration = new FilterRegistrationBean<>();registration.setFilter(new TraceIdFilter());registration.addUrlPatterns("/*");registration.setOrder(WebFilterOrderEnum.TRACE_FILTER);return registration;}
}

自定义的 Spring Security 配置适配器实现需添加TraceIdFilter, 在登录后

  // 添加 Token FilterhttpSecurity.addFilterBefore(new TraceIdFilter(), UsernamePasswordAuthenticationFilter.class);

在日志中也可以打印每个请求traceid, 其中 [%X{traceId}]) 就是上文 MDC.put(TRACE_ID, traceId)设置的

    <property name="PATTERN_DEFAULT" value="%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} | %highlight(${LOG_LEVEL_PATTERN:-%5p} ${PID:- }) | %boldYellow(%thread [%tid] [%X{traceId}]) %boldGreen(%-40.40logger{39}) | %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}"/>