spring boot中过滤器,拦截器和切片的使用

以记录所有服务的处理时间的需求为例

1.过滤器(Filter)

实现方式一:

创建自定义的Filter,实现 Filter的接口方法,使用 @Component注解注册过滤器.

@Component

public class TimeFilter implements Filter {

       @Override

       //过滤器初始化调用

       public void init(FilterConfig arg0) throws ServletException {

              System.out.println("time filter init");

       }

       @Override

       //过滤器销毁时调用

       public void destroy() {

              System.out.println("time filter destroy");

       }

       @Override

       public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)

                     throws IOException, ServletException {

              System.out.println("time filter start");

              long start = new Date().getTime();

              chain.doFilter(request, response);//调用处理方法

              System.out.println("time filter 耗时:"+ (new Date().getTime() - start));

              System.out.println("time filter finish");

       }

}

使用第一种方式的好处是简单,只需 @Component注解即可让过滤器生效,缺点是不够灵活,默认会对所有的接口进行过滤,如果我们要针对特定的接口使用过滤器,就不能使用这种方式.

实现方式二:

通过配置注册过滤器:

通过这种方式,我们不仅可以注册自定义的过滤器,也可以注册第三方的过滤器(可能没有@Component 注解,所以无法使用第一种方式注册),另外,我们可以灵活的定义过滤器的处理规则

@Configuration //@Configuration注解声明该类为配置类

public class WebConfig extends WebMvcConfigurerAdapter {

//     @Bean

       public FilterRegistrationBean timeFilter() {

              //过滤器注册的bean 

              FilterRegistrationBean registrationBean = new FilterRegistrationBean();

              //注册过滤器 

              TimeFilter timeFilter = new TimeFilter();

              registrationBean.setFilter(timeFilter);

               

              //添加过滤规则 

              List<String> urls = new ArrayList<>();

              urls.add("/*");

              registrationBean.setUrlPatterns(urls);

              return registrationBean;

       }

}

使用过滤器可以方便的记录各个接口的处理时间,并且我们可以获取到request,  response参数,根据业务需要做其他的处理,但是使用过滤器有一个限制,就是我们并不知道当前过滤的请求是由哪个处理器中的哪个方法来处理的,如果有这样的需求,就只能使用其他方式来拦截请求;

2.拦截器(Interceptor)

   创建自定义拦截器实现HandlerInterceptor接口,该接口有三个方法:

   preHandle 具体控制器方法调用前执行该方法,拦截器根据 preHandle的返回值来确定是否执行控制器方法,,返回ture则执行,返回false不执行;

   postHandle 处理器方法执行完毕调用,如果控制器方法抛出异常,该方法就不会调用 ;

   afterCompletion 请求方法结束时调用,无论是否抛出异常,都会调用该方法.

@Component

public class TimeInterceptor implements HandlerInterceptor {

      

       @Override

       public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)

                     throws Exception {

              System.out.println("preHandle");

              System.out.println(((HandlerMethod)handler).getBean().getClass().getName());

              System.out.println(((HandlerMethod)handler).getMethod().getName());

              request.setAttribute("startTime", new Date().getTime());

              return true;

       }

    

       @Override

       public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,

                     ModelAndView modelAndView) throws Exception {

              System.out.println("postHandle");

              Long start = (Long) request.getAttribute("startTime");

              System.out.println("time interceptor 耗时:"+ (new Date().getTime() - start));

       }

       @Override

       public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)

                     throws Exception {

              System.out.println("afterCompletion");

              Long start = (Long) request.getAttribute("startTime");

              System.out.println("time interceptor 耗时:"+ (new Date().getTime() - start));

              System.out.println("ex is "+ex);

       }

}

注册拦截器(必须有此步骤,拦截器才能生效):

@Configuration

public class WebConfig extends WebMvcConfigurerAdapter {

       @SuppressWarnings("unused")

       @Autowired

       private TimeInterceptor timeInterceptor;

       @Override

       public void addInterceptors(InterceptorRegistry registry) {

            registry.addInterceptor(timeInterceptor);

       }

}

3.切片(Aspect)

@Aspect

@Component

public class TimeAspect {

       @Around("execution(* com.test.web.controller.UserController.*(..))")//定义切片作用范围

       public Object handleControllerMethod(ProceedingJoinPoint pjp) throws Throwable {

              System.out.println("time aspect start");

              Object[] args = pjp.getArgs();

              for (Object arg : args) {

                     System.out.println("arg is "+arg);

              }

              long start = new Date().getTime();

              Object object = pjp.proceed();

              System.out.println("time aspect 耗时:"+ (new Date().getTime() - start));

              System.out.println("time aspect end");

              return object;

       }

}