SpringBoot中使用Filter和Interceptor的示例代码

SpringBoot中使用Filter和Interceptor的示例代码

一、Filter(过滤器)

Filter接口定义在javax.servlet包中，是Servlet规范定义的，作用于Request/Response前后，被Servlet容器调用，当Filter被Sring管理后可以使用Spring容器资源。

实现一个Filter

自定义的过滤器需要实现javax.servlet.Filter，Filter接口中有三个方法：

init(FilterConfig filterConfig)：过滤器初始化的被调用。

doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain chain)：在doFilter()方法中，chain.doFilter()前的一般是对request执行的过滤操作，chain.doFilter后面的代码一般是对response执行的操作,chain.doFiter()执行下一个过滤器或者业务处理器。

destory()：过滤器销毁的时候被调用。

在Spring容器中使用过滤器

通过FilterRegistrationBean

@Configuration

public class WebConfig{

@Bean

public FilterRegistrationBean xxxFilter() {

FilterRegistrationBean registrationBean = new FilterRegistrationBean();

registrationBean.setFilter(new xxxFilter());

registrationBean.setUrlPatterns(Arrays.asList("/*"));

registrationBean.setOrder(1); // 过滤器的优先级

return registrationBean;

}

}

通过@WebFilter和@ServletComponentScan

通过@WebFilter的方式定义Filter，默认使用Filter的类名设置优先级。使用FilterRegistrationBean可以指定优先级。Filter使用白名单过滤Url的方式，配置需要拦截的Url，如果想设置不过滤某些Url需要在doFilter方法中指定。

二、Interceptor(-)

定义一个Interceptor需要实现org.springframework.web.servlet.HandlerInterceptor接口，Interceptor是Spring容器定义的，它可以使用Spring容器的任何资源，只要通过IoC注入到Interceptor即可，Interceptor可以深入到业务处理方法的执行前后和抛出异常的时候，而Filerter无法做到这一点，所以Interceptor相比Filter具有更大的弹性。

实现一个Interceptor

实现HandlerInterceptor或者继承HandlerInterceptorAdapter

public interface HandlerInterceptor {

default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

return true;

}

default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {

}

default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {

}

}

preHandle：在业务处理器处理请求之前被调用。

postHandle：在业务处理器处理请求后并生成视图前被调用，此时有机会修改ModelAndView。

afterCompletion：业务处理处理器处理完请求后(已经渲染视图)被执行，并可以处理业务方法发生异常的场景。

在Spring容器中使用-

@Configuration

public class WebConfig implements WebMvcConfigurer {

@Override

public void addInterceptors(InterceptorRegistry registry) {

InterceptorRegistration registration = registry.addInterceptor(new TimeInterceptor());

registration.excludePathPatterns("/user");

registration.excludePathPatterns("/*");

}

}

Interceptor既可以指定要过滤的Url也可以指定不拦截的Url，缺省情况拦截所有Url。

三、调用顺序

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。