spring拦截器拦截和排除接口冲突

我就是我 2024-04-19 08:29 3阅读 0赞

以下为springboot案例:

场景:  某个规则下的绝大部分接口路径不需要经过拦截器, 但其中的某几个接口又需要经过拦截器.

例如: "/api/register/\*\*" 模式匹配的路径下绝大部分接口不需要登录, 但是其中"/api/register/logout"接口又需要登录(暂不要考虑为啥, 仅仅是做样例)

下意识反应的可能操作是:

但遗憾的是发现如上配置并不能生效, 当我们尝试将3的配置写到1的地方, 或者放在1,2之间 依旧不能生效.

正确的做法是在调用一个addInterceptor方法(即: 在添加一个拦截器配置), 如下:

public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(loginInterceptor) // loginInterceptor 登陆拦截器
            .addPathPatterns("/**") // 1. 拦截所有接口路径 
            .excludePathPatterns("/api/register/**"); // 2. 不拦截器"/api/register/"下的所有接口
            
    // 再创建一个拦截器, 对该特定接口拦截, 只不过这个拦截器和上面的拦截器业务代码一样
    registry.addInterceptor(loginInterceptor) // loginInterceptor 登陆拦截器
            .addPathPatterns("/api/register/logout"); // 3. 拦截"/api/register/logout"接口路径(为了覆盖2步骤中全部拦截)
    }

为什么这么做可以?

我们看registry.addInterceptor会根据入参new一个InterceptorRegistration, 即每一次addInterceptor都是一个新的对象. 这不是和我们声明不同的拦截器, 拦截不同的路径一个道理吗? 只不过这里的两个拦截器的业务是一样的, 如果可以, 你完全可以声明两个拦截器, 但他们的业务逻辑完全一致, 然后用于以上代码中.

如下为addInterceptor的内部实现:

// 所在类全限定名org.springframework.web.servlet.config.annotation.InterceptorRegistry#addInterceptor
    // interceptor 为 registry.addInterceptor(loginInterceptor)的入参
    public InterceptorRegistration addInterceptor(HandlerInterceptor interceptor) {
        InterceptorRegistration registration = new InterceptorRegistration(interceptor);
        this.registrations.add(registration);
        return registration;
    }