Spring Boot自定义拦截器

前期回顾：
创建Spring Boot项目
Spring Boot项目基础配置
Spring Boot上传文件
Spring Boot全局异常处理、全局数据、参数预处理

拦截器顾名思义就是起到拦截的作用，具体是拦截什么呢？可以通过自定义拦截器来拦截你想拦截的请求，下面通过结合API请求时长的例子来说说自定义拦截器。

• 创建拦截器并实现HandlerInterceptor接口

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

import com.lei.tang.demo.service.log.LogService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

@Slf4j
@Component
public class LogHandlerInterceptor implements HandlerInterceptor {

    @Autowired
    private LogService logService;

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        log.info("=========>in LogHandlerInterceptor preHandle");
        logService.onPre();
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
        log.info("=========>in LogHandlerInterceptor postHandle {} {}");
        logService.onAfter();
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex){
        log.info("=========>in LogHandlerInterceptor afterCompletion {} {}");
        logService.onError();
    }
}

• 将自定义拦截器注册到配置中

import com.lei.tang.demo.config.log.LogHandlerInterceptor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Slf4j
@Configuration
public class CustomWebMvcConfigurer implements WebMvcConfigurer {

    @Autowired
    LogHandlerInterceptor logHandlerInterceptor;

    /**
     * 添加自定义的拦截器
     *
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(logHandlerInterceptor);
    }
}

通过@Component注解将自定义拦截器交由MVC容器管理，当然也可以不通过MVC容器管理，那么在添加自定义拦截器配置时通过手动创建对象就行。拦截器方法的执行顺序为：preHandle——>Controller——>postHandle——>afterCompletion，其中需要注意的是，当在执行API逻辑代码发生错误时，那么将会跳过拦截器中的postHandle方法，发送错误的执行顺序为：preHandle——>Controller——>如果有全局异常处理，则进行异常处理——>afterCompletion。自定义配置类CustomWebMvcConfigurer并实现WebMvcConfigurer接口，通过实现addInterceptors方法，将自定义拦截器添加到配置中，通过registry.addInterceptor(logHandlerInterceptor).addPathPatterns()定义此拦截器生效的路径，默认拦截所有，也可以通过excludePathPatterns()方法添加失效路径。如果定义了多个拦截器，那么当所有拦截器的preHandle方法都返回true时，代码才会继续，并且我们可以通过registry.addInterceptor(logHandlerInterceptor).order(index)来定义多拦截器的执行顺序，index为int类型，值小的先执行。

• 请求时长service实现

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;

@Slf4j
@Service("logService")
public class LogServiceImpl implements LogService {

    final ThreadLocal<Long> logDate = new ThreadLocal<>();

    @Override
    public void onPre() {
        logDate.set(System.currentTimeMillis());
        log.info("进入请求时间 {}", logDate.get());
    }

    @Override
    public void onAfter() {
        log.info("结束请求时间 {}", logDate.get());
        logDate.remove();
    }

    @Override
    public void onError() {
        if(logDate.get() != null) {
            log.info("发生错误引发结束请求时间 {}", logDate.get());
            logDate.remove();
        }
    }
}

这里我只是做简单的实现，具体的根据各位项目需求，我这里通过ThreadLocal来达到各线程的区分。

如有不到之处，欢迎各位留言指正，不慎感激。
更多文章：
点击跳转CSDN博客
点击跳转简书博客
公众号：代码小搬运