Spring Boot添加拦截器

Servlet本身提供了Filter，用于过滤web请求。Spring提供了拦截器HandlerInterceptor，功能与过滤器类似，但更精细。拦截器拦截request请求后，可以对内容进行判断，然后抛出异常或者返回false，从而直接打断request的后续执行。但拦截器是无法修改request的内容的。

要使用拦截器，必须使用配置类WebMvcConfigurer。

1. 定义拦截器，定义方式有两种：

public class TemplateInterceptor extends HandlerInterceptorAdapter {...}

或：

public class TemplateInterceptor implements HandlerInterceptor {...}

这两种定义方式效果相同。但HandlerInterceptorAdapter多一个接口。

2. 定义配置文件Configuration，定义方式有两种：

@Configuration
public class TemplateConfig extends WebMvcConfigurerAdapter {...}

或：

@Configuration
public class TemplateConfig implements WebMvcConfigurer {...}

这两种定义方式效果相同。

注意必须添加@Configuration注解，这样spring才会将其注入到自身容器中。

3. 重载Configuration的addInterceptors()函数，注册自定义的拦截器：

@Override
public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(new TemplateInterceptor()).addPathPatterns("/**");
}

这样，拦截器就被配置到spring中了。当收到请求时，拦截器就会生效。

对于拦截器HandlerInterceptor，提供了3个接口用于重载：preHandle()，postHandle()，afterCompletion()。

因此实现自定义的拦截器TemplateInterceptor时：

public class TemplateInterceptor implements HandlerInterceptor {
    /**
     *请求处理前调用
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        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 {
    }
}

若TemplateInterceptor是extends HandlerInterceptorAdapter，则多一个接口afterConcurrentHandlingStarted()。

Spring Boot添加拦截器

猜你喜欢