详解java中spring里的三大拦截器

 更新时间:2018年10月26日 08:37:53   投稿:laozhang  
在本篇文章里我们给大家详细讲述了java中spring里的三大拦截器相关知识点以及用法代码,需要的朋友们学习下。

Filter

新建 TimeFilter

@Component
public class TimeFilter implements Filter {
  @Override
  public void init(FilterConfig filterConfig) throws ServletException {
    System.out.println("time filter init");
  }
 
  @Override
  public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
    System.out.println("time filter start");
    long startTime = System.currentTimeMillis();
 
    filterChain.doFilter(servletRequest, servletResponse);
 
    long endTime = System.currentTimeMillis();
    System.out.println("time filter consume " + (endTime - startTime) + " ms");
    System.out.println("time filter end");
  }
 
  @Override
  public void destroy() {
    System.out.println("time filter init");
  }
}

启动服务器,在浏览器输入:http://localhost:8080/hello?name=tom

可以在控制台输出如下结果:

time filter start
name: tom
time filter consume 3 ms
time filter end

可以看到,filter 先执行,再到真正执行 HelloController.sayHello() 方法。
通过 TimeFilter.doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) 方法的参数可以看出,我们只能得到原始的 request 和 response对象,不能得到这个请求被哪个 Controller 以及哪个方法处理了,使用Interceptor 就可以获得这些信息。

Interceptor

新建 TimeInterceptor

@Component
public class TimeInterceptor extends HandlerInterceptorAdapter {
 
  private final NamedThreadLocal<Long> startTimeThreadLocal = new NamedThreadLocal<>("startTimeThreadLocal");
 
  @Override
  public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    System.out.println("time interceptor preHandle");
 
    HandlerMethod handlerMethod = (HandlerMethod) handler;
    // 获取处理当前请求的 handler 信息
    System.out.println("handler 类:" + handlerMethod.getBeanType().getName());
    System.out.println("handler 方法:" + handlerMethod.getMethod().getName());
 
    MethodParameter[] methodParameters = handlerMethod.getMethodParameters();
    for (MethodParameter methodParameter : methodParameters) {
      String parameterName = methodParameter.getParameterName();
      // 只能获取参数的名称,不能获取到参数的值
      //System.out.println("parameterName: " + parameterName);
    }
 
    // 把当前时间放入 threadLocal
    startTimeThreadLocal.set(System.currentTimeMillis());
 
    return true;
  }
 
  @Override
  public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    System.out.println("time interceptor postHandle");
  }
 
  @Override
  public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
 
    // 从 threadLocal 取出刚才存入的 startTime
    Long startTime = startTimeThreadLocal.get();
    long endTime = System.currentTimeMillis();
 
    System.out.println("time interceptor consume " + (endTime - startTime) + " ms");
 
    System.out.println("time interceptor afterCompletion");
  }
}

注册 TimeInterceptor

把 TimeInterceptor 注入 spring 容器

@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {
 
  @Autowired
  private TimeInterceptor timeInterceptor;
 
  @Override
  public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(timeInterceptor);
  }
}

启动服务器,在浏览器输入:http://localhost:8080/hello?name=tom

可以在控制台输出如下结果:

time filter start
time interceptor preHandle
handler 类:com.nextyu.demo.web.controller.HelloController
handler 方法:sayHello
name: tom
time interceptor postHandle
time interceptor consume 40 ms
time interceptor afterCompletion
time filter consume 51 ms
time filter end

可以看到,filter 先于 interceptor 执行,再到真正执行 HelloController.sayHello() 方法。通过 interceptor 方法上的 handler 参数,我们就可以得到这个请求被哪个 Controller 以及哪个方法处理了。但是不能直接获取到这个方法上的参数值(在这里就是 HelloController.sayHello(String name) 方法参数 name 的值),通过 Aspect 就可以获取到。

Aspcet

新建 TimeAspect

@Aspect
@Component
public class TimeAspect {
 
  @Around("execution(* com.nextyu.demo.web.controller.*.*(..))")
  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 startTime = System.currentTimeMillis();
 
    Object object = pjp.proceed();
 
    long endTime = System.currentTimeMillis();
    System.out.println("time aspect consume " + (endTime - startTime) + " ms");
 
    System.out.println("time aspect end");
 
    return object;
  }
 
}

启动服务器,在浏览器输入:http://localhost:8080/hello?name=tom

可以在控制台输出如下结果:

time filter start
time interceptor preHandle
handler 类:com.nextyu.demo.web.controller.HelloController
handler 方法:sayHello
time aspect start
arg is tom
name: tom
time aspect consume 0 ms
time aspect end
time interceptor postHandle
time interceptor consume 2 ms
time interceptor afterCompletion
time filter consume 4 ms
time filter end

可以看到,filter 先执行,再到 interceptor 执行,再到 aspect 执行,再到真正执行 HelloController.sayHello() 方法。
我们也获取到了 HelloController.sayHello(String name) 方法参数 name 的值。

请求拦截过程图

graph TD
httprequest-->filter
filter-->interceptor
interceptor-->aspect
aspect-->controller

相关文章

  • Java 超详细讲解IO操作字节流与字符流

    Java 超详细讲解IO操作字节流与字符流

    本章具体介绍了字节流、字符流的基本使用方法,图解穿插代码实现。 JAVA从基础开始讲,后续会讲到JAVA高级,中间会穿插面试题和项目实战,希望能给大家带来帮助
    2022-03-03
  • java实现注册登录系统

    java实现注册登录系统

    这篇文章主要为大家详细介绍了java实现注册登录系统,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-04-04
  • 解读JDK1.8 默认使用什么垃圾收集器

    解读JDK1.8 默认使用什么垃圾收集器

    这篇文章主要介绍了解读JDK1.8 默认使用什么垃圾收集器,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-05-05
  • Spring Boot RestTemplate提交表单数据的三种方法

    Spring Boot RestTemplate提交表单数据的三种方法

    本篇文章主要介绍了Spring Boot RestTemplate提交表单数据的三种方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-03-03
  • 基于SpringBoot实现大文件分块上传功能

    基于SpringBoot实现大文件分块上传功能

    这篇文章主要介绍了基于SpringBoot实现大文件分块上传功能,实现原理其实很简单,核心就是客户端把大文件按照一定规则进行拆分,比如20MB为一个小块,分解成一个一个的文件块,然后把这些文件块单独上传到服务端,需要的朋友可以参考下
    2024-09-09
  • Spring Boot高级教程之使用Redis实现session共享

    Spring Boot高级教程之使用Redis实现session共享

    这篇文章主要为大家详细介绍了Spring Boot高级教程之使用Redis实现session共享,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-10-10
  • Kylin对接JDBC集成Zepplin的实现方法

    Kylin对接JDBC集成Zepplin的实现方法

    Zepplin是一个非常好用的编辑器工具,通过自定义编码可以实现更多的业务逻辑,接下来通过本文给大家分享Kylin对接JDBC和Zepplin的操作代码,感兴趣的朋友跟随小编一起看看吧
    2021-05-05
  • Spring Boot 3.x 全新的热部署配置方式详解(IntelliJ IDEA 2023.1)

    Spring Boot 3.x 全新的热部署配置方式详解(IntelliJ ID

    这篇文章主要介绍了Spring Boot 3.x 全新的热部署配置方式(IntelliJ IDEA 2023.1),本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-07-07
  • Java获取mac地址的方法

    Java获取mac地址的方法

    这篇文章主要介绍了Java获取mac地址的方法,涉及java针对系统硬件及IO操作的相关技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-07-07
  • SpringCloud学习笔记之Feign远程调用

    SpringCloud学习笔记之Feign远程调用

    Feign是一个声明式的http客户端。其作用就是帮助我们优雅的实现http请求的发送。本文将具体为大家介绍一下Feign的远程调用,感兴趣的可以了解一下
    2021-12-12

最新评论