springboot 拦截器

1.新建类实现 HandlerInterceptor

import cn.hutool.core.util.IdUtil;
import cn.hutool.core.util.StrUtil;
import com.tz4cloud.constant.CommonConstants;
import org.slf4j.MDC;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * 跟踪id上下文拦截类
 *
 * @author wrx
 */
@Component
public class TraceIdInterceptor implements HandlerInterceptor {
    /**
     * 最先执行的方法，请求进来前调用该方法
     *
     * @author wrx
     * @date 2022/8/11 9:55
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        //默认获取报文头中的traceId
        String traceId = request.getHeader(CommonConstants.TRACE_ID);
        MDC.put(CommonConstants.TRACE_ID, StrUtil.isBlank(traceId) ? IdUtil.fastSimpleUUID() : traceId);
        return true;
    }

    /**
     * perHandle 方法返回值为 true 时，在 Controller 执行完当前请求后才会执行
     * 可以在这个方法中对 Controller 处理之后的 ModelAndView 对象进行操作。
     *
     * @author wrx
     * @date 2022/8/11 9:58
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
    }

    /**
     * 该方法在整个请求结束后，也就是 DispatcherServlet 渲染了对应视图之后执行，这个方法的主要作用是用于进行资源清理的工作。
     *
     * @author wrx
     * @date 2022/8/11 9:58
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        MDC.clear();
    }

}

2.新增配置类实现WebMvcConfigurer

import com.tz4cloud.interceptor.TraceIdInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * 拦截器注册
 *
 * @author wrx
 * @date 2022/8/11 11:37
 */
@Configuration
public class InterceptorConfig implements WebMvcConfigurer {
    /**
     * 被拦截的路径
     */
    String[] addPathPatterns = {
            "/**"
    };
    /**
     * 忽略路径
     */
    String[] excludePathPatterns = {
            "/index",
            "/loan/**"

    };

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //注：1.先加入的拦截器先执行  2.此处new虽然能正常加入拦截器，但是该拦截器不会被spring管理，若想被管理@Component即可
        registry.addInterceptor(new TraceIdInterceptor())
                .addPathPatterns(addPathPatterns).excludePathPatterns(excludePathPatterns);
    }
}

至此拦截器就完成了，随便发起个请求断点调试即可。