引言

拦截器是开发中常用的一种技术，它用于在请求被处理前后进行一些预处理和后处理操作，提供统一的处理逻辑。Spring Boot提供了方便的方式来实现拦截器，结合自定义注解可以更加灵活地控制拦截器的使用。

什么是拦截器？

拦截器是一种用于拦截并处理请求的组件，它可以在请求进入控制器之前或之后进行一些处理。拦截器可以用于日志记录、权限验证、参数校验等场景，提供统一的处理逻辑。

Spring Boot中的拦截器

在Spring Boot中，可以通过实现HandlerInterceptor接口来创建拦截器。该接口包含了3个方法，分别是preHandle、postHandle和afterCompletion，分别对应请求处理的前中后三个阶段。

1. preHandle(Request request, Response response, Object handler)：在请求处理之前执行，返回布尔值，表示是否中断请求处理链。

2. postHandle(Request request, Response response, Object handler, ModelAndView modelAndView)：在请求处理完成后，渲染视图之前执行。

3. afterCompletion(Request request, Response response, Object handler, Exception ex)：在整个请求处理完成后执行，主要用于清理资源等操作。

结合自定义注解实现拦截器

Spring Boot提供了@EnableWebMvc注解，通过添加该注解可以启用Spring MVC的相关功能，包括拦截器。我们可以结合自定义注解来控制拦截器的使用。

1. 创建自定义注解@Intercept，用于标记需要拦截的接口或方法。

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Intercept {

}

2. 创建拦截器CustomInterceptor，实现HandlerInterceptor接口。

public class CustomInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 在请求处理之前执行的逻辑
        if(handler instanceof HandlerMethod) {
            HandlerMethod handlerMethod = (HandlerMethod) handler;
            Intercept annotation = handlerMethod.getMethodAnnotation(Intercept.class);
            if(annotation != null) {
                // 对被@Intercept注解标记的接口或方法进行处理
                // ...
            }
        }
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 请求处理完成后执行的逻辑
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 整个请求处理完成后执行的逻辑
    }
}

3. 创建配置类WebMvcConfig，并添加@EnableWebMvc注解。

@Configuration
@EnableWebMvc
public class WebMvcConfig implements WebMvcConfigurer {

    @Autowired
    private CustomInterceptor customInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(customInterceptor);
    }
}

4. 在Controller中使用@Intercept注解标记需要拦截的接口或方法。

@RestController
public class HelloController {

    @GetMapping("/hello")
    @Intercept
    public String hello() {
        return "Hello, World!";
    }
}

总结

通过自定义注解和拦截器的结合，可以在Spring Boot中灵活控制拦截器的使用。拦截器能够提供统一的处理逻辑，用于日志记录、权限验证、参数校验等场景。同时，Spring Boot还提供了方便的配置方式，使拦截器的添加和配置变得更加简单。

本文来自极简博客，作者：时光旅者，转载请注明原文链接：Spring Boot 结合自定义注解实现拦截器