如何使用Springboot自定义过滤器记录跟踪id

在Spring Boot中，自定义过滤器是一种强大的工具，可以用于在请求到达控制器之前或之后执行一些操作。记录跟踪ID（Trace ID）是一种常见的需求，它可以帮助我们在分布式系统中跟踪请求的路径。以下是如何使用Spring Boot自定义过滤器来记录跟踪ID的详细步骤：

基础概念

过滤器（Filter）：在Java Web应用中，过滤器是一种组件，可以在请求到达Servlet之前或响应返回客户端之前对请求和响应进行处理。

跟踪ID（Trace ID）：在分布式系统中，跟踪ID是一个唯一的标识符，用于跟踪一个请求在多个服务之间的流转路径。

类型与应用场景

日志过滤器：用于在日志中添加跟踪ID。
请求转发过滤器：用于在微服务架构中传递跟踪ID。

实现步骤

1. 创建自定义过滤器

首先，创建一个自定义过滤器类，实现javax.servlet.Filter接口。

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.UUID;

public class TraceIdFilter implements Filter {

    private static final String TRACE_ID_HEADER = "X-Trace-Id";
    private static final String TRACE_ID_ATTRIBUTE = "traceId";

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        // 初始化操作
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        HttpServletResponse httpResponse = (HttpServletResponse) response;

        String traceId = httpRequest.getHeader(TRACE_ID_HEADER);
        if (traceId == null || traceId.isEmpty()) {
            traceId = UUID.randomUUID().toString();
        }

        // 将跟踪ID添加到请求属性中
        httpRequest.setAttribute(TRACE_ID_ATTRIBUTE, traceId);
        httpResponse.setHeader(TRACE_ID_HEADER, traceId);

        try {
            chain.doFilter(request, response);
        } finally {
            // 清理操作
        }
    }

    @Override
    public void destroy() {
        // 销毁操作
    }
}

2. 注册过滤器

在Spring Boot应用中，可以通过FilterRegistrationBean来注册自定义过滤器。

import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class FilterConfig {

    @Bean
    public FilterRegistrationBean<TraceIdFilter> traceIdFilterRegistration() {
        FilterRegistrationBean<TraceIdFilter> registration = new FilterRegistrationBean<>();
        registration.setFilter(new TraceIdFilter());
        registration.addUrlPatterns("/*"); // 设置过滤器应用的URL模式
        registration.setName("traceIdFilter");
        registration.setOrder(1); // 设置过滤器的执行顺序
        return registration;
    }
}

3. 在日志中使用跟踪ID

可以在日志配置文件中添加MDC（Mapped Diagnostic Context），以便在日志中自动包含跟踪ID。

logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} [traceId=%X{traceId}] - %msg%n

在过滤器中设置MDC：

import org.slf4j.MDC;

@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
        throws IOException, ServletException {
    HttpServletRequest httpRequest = (HttpServletRequest) request;
    HttpServletResponse httpResponse = (HttpServletResponse) response;

    String traceId = httpRequest.getHeader(TRACE_ID_HEADER);
    if (traceId == null || traceId.isEmpty()) {
        traceId = UUID.randomUUID().toString();
    }

    MDC.put(TRACE_ID_ATTRIBUTE, traceId);
    httpResponse.setHeader(TRACE_ID_HEADER, traceId);

    try {
        chain.doFilter(request, response);
    } finally {
        MDC.remove(TRACE_ID_ATTRIBUTE);
    }
}