浅谈Springboot实现拦截器的两种方式

下面我来详细讲解“浅谈Springboot实现拦截器的两种方式”。

一、背景

在Springboot应用中，拦截器（或者称为过滤器、中间件）是常用的功能模块之一，可以用于对请求进行预处理、后处理、权限控制、日志记录等操作。在本文中，我将介绍两种Springboot实现拦截器的方式。这两种方式分别是基于配置文件的拦截器实现和基于注解的拦截器实现。

二、基于配置文件的拦截器实现

1. 创建拦截器类

@Component
public class MyInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 在请求处理之前进行调用（Controller方法调用之前）
        return true;    // 如果返回false，请求将会被拦截
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 请求处理之后进行调用，但是在视图被渲染之前（Controller方法调用之后）
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 在整个请求处理完成后进行回调，也就是说在视图渲染完毕或者调用方取消了请求时都会回调
    }
}

1. 在配置文件中定义拦截器

@Configuration
public class MyWebMvcConfigurerAdapter implements WebMvcConfigurer {

    @Autowired
    private MyInterceptor myInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 注册拦截器
        registry.addInterceptor(myInterceptor).addPathPatterns("/**");
    }
}

三、基于注解的拦截器实现

1. 创建拦截器类

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyAnnotation {
    // 定义注解
}

@Component
public class MyInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 在请求处理之前进行调用（Controller方法调用之前）
        if (handler instanceof HandlerMethod) {
            HandlerMethod handlerMethod = (HandlerMethod) handler;
            MyAnnotation myAnnotation = handlerMethod.getMethodAnnotation(MyAnnotation.class);
            if (myAnnotation == null) {
                return true;
            }
            // 进行权限控制等操作
            return true;
        }
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 请求处理之后进行调用，但是在视图被渲染之前（Controller方法调用之后）
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 在整个请求处理完成后进行回调，也就是说在视图渲染完毕或者调用方取消了请求时都会回调
    }
}

1. 在Controller方法上添加注解

@RestController
@RequestMapping("/example")
public class ExampleController {

    // 定义注解
    @MyAnnotation
    @GetMapping("/test")
    public String test() {
        return "Hello, world!";
    }
}

1. 在配置文件中注册拦截器

@Configuration
public class MyWebMvcConfigurerAdapter implements WebMvcConfigurer {

    @Autowired
    private MyInterceptor myInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 注册拦截器，只拦截添加了MyAnnotation注解的方法
        registry.addInterceptor(myInterceptor).addPathPatterns("/**").excludePathPatterns("/example/**");
    }
}

至此，我们已经完成了基于配置文件和基于注解的拦截器实现。我们可以看到，两种方式各有优劣。基于配置文件的拦截器实现比较简单，但是不够灵活；基于注解的拦截器实现灵活性比较高，但是需要在Controller方法上添加注解，不够便捷。根据实际需求选择合适的方式即可。