SpringBoot.12.SpringBoot中的拦截器

转x33g5p2x  于2022-04-11 转载在 Spring  
字(11.2k)|赞(0)|评价(0)|浏览(461)

前言

拦截器（Interceptor）主要是针对特定处理器进行拦截的。也就是说它拦截的对象是我们的Controller请求。我们可以将Controller中的通用代码进行抽取放在拦截器中，就这一点来讲功能跟我们之前讲的AOP类似（Interceptor底层就是利用AOP来实现的）。在实际开发中Interceptor通常用来做权限校验（现在都有成熟的权限校验框架。比如轻量级的Shiro，还有Spring推出的Spring Security ）

拦截器

介绍

拦截器（Interceptor）实现对每一个请求处理前后进行相关的业务处理，类似与servlet中的Filter。
SpringMVC 中的 Interceptor 拦截请求是通过 HandlerInterceptor 接口来实现的。

拦截器可以通过以下几种方式进行实现：

  1. 实现 SpringMVC 的 HandlerInterceptor 接口；
  2. 继承实现了 HandlerInterceptor 接口的类，比如 SpringMVC 已经提供的实现了HandlerInterceptor 接口的抽象类 HandlerInterceptorAdapter；
  3. 实现 SpringMVC 的 WebRequestInterceptor 接口；
  4. 继承实现了 WebRequestInterceptor 的类；

具体实现

1.新建项目

在上一节SpringBoot.11.IDEA中如何快速复制当前父项目中的一个Module为新的项目中我们已经准备好了Module – springboot-08-interceptor。如下图所示：

2.MyInterceptor01.java
  1. package com.christy.config.interceptors;
  3. import org.slf4j.Logger;
  4. import org.slf4j.LoggerFactory;
  5. import org.springframework.web.servlet.HandlerInterceptor;
  6. import org.springframework.web.servlet.ModelAndView;
  8. import javax.servlet.http.HttpServletRequest;
  9. import javax.servlet.http.HttpServletResponse;
  11. /**
  12.  * 自定义拦截器
  13.  * @Author Christy
  14.  * @Date 2021/9/28 10:20
  15.  **/
  16. public class MyInterceptor01 implements HandlerInterceptor {
  18.     private static final Logger log = LoggerFactory.getLogger(MyInterceptor01.class);
  20.     /**
  21.      * 
  22.      * @author Christy
  23.      * @date 2021/9/28 10:22
  24.      * @param request
  25.      * @param response
  26.      * @param handler 当前请求请求的控制器方法对象  InterceptorController#sayHello
  27.      * @return boolean
  28.      *          true：表示放行当前请求
  29.      *          false：终端当前请求 例如做权限校验时如果校验不通过我们可以使用response.sendRedirect(request.getContextPath()+"/login.suffix");跳转到登录界面
  30.      */
  31.     @Override
  32.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
  33.         log.info("==========MyInterceptor01==========handler=========" + handler);
  34.         log.info("==========MyInterceptor01==========preHandle=========");
  35.         return true;
  36.     }
  38.     /**
  39.      *
  40.      * @author Christy
  41.      * @date 2021/9/28 10:28
  42.      * @param request
  43.      * @param response
  44.      * @param handler 当前请求请求的控制器方法对象  InterceptorController#sayHello
  45.      * @param modelAndView 模型和视图  当前请求访问方法的 modelandview 对象
  46.      * @return void
  47.      */
  48.     @Override
  49.     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
  50.         log.info("==========MyInterceptor01==========postHandle=========");
  51.     }
  53.     /**
  54.      *
  55.      * @author Christy
  56.      * @date 2021/9/28 10:29
  57.      * @param request
  58.      * @param response
  59.      * @param handler 当前请求请求的控制器方法对象  InterceptorController#sayHello
  60.      * @param ex      如果控制器出现异常时异常对象
  61.      * @return void
  62.      */
  63.     @Override
  64.     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
  65.         log.info("==========MyInterceptor01==========ex========={}", ex);
  66.         log.info("==========MyInterceptor01==========afterCompletion=========");
  67.     }
  68. }
3.配置拦截器

我们进入到MyWebMvcConfigurer.java中，按快捷键Alt+Insert，选择Implement Methods…或者直接按快捷键Alt+Shift+P。如下图所示：

在Select Methods to Implement中选择addIntefceptors()这个方法。如下图所示：

修改MyWebMvcConfigurer.java内容如下所示：

  1. import com.christy.config.interceptors.MyInterceptor01;
  2. import com.christy.constants.FileConstants;
  3. import org.springframework.context.annotation.Configuration;
  4. import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
  5. import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
  6. import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
  8. /**
  9.  * @Author Christy
  10.  * @Date 2021/9/15 16:24
  11.  **/
  12. @Configuration
  13. public class MyWebMvcConfigurer implements WebMvcConfigurer {
  15.     /**
  16.      * 配置拦截器
  17.      * addInterceptor()： 指定拦截器
  18.      * addPathPatterns("/**")：拦截所有Controller请求
  19.      * excludePathPatterns("/file/**")：排除文件操作的请求路径
  20.      * order()：指定拦截器执行顺序 int 类型数字: 默认按照自然排序执行 数字相同时,按照配置顺序执行
  21.      */
  22.     @Override
  23.     public void addInterceptors(InterceptorRegistry registry) {
  24.         registry.addInterceptor(new MyInterceptor01())
  25.                 .addPathPatterns("/interceptor/**")
  26.                 .excludePathPatterns("/file/**")
  27.                 .order(1);
  28.     }
  30.     @Override
  31.     public void addResourceHandlers(ResourceHandlerRegistry registry) {
  32.         /**
  33.          * 文件上传到服务器后并不能在项目中直接访问，需要将磁盘路径映射成虚拟路径使用http://domain/的方式才可以
  34.          */
  35.         String os = System.getProperty("os.name");
  36.         if(os.toLowerCase().startsWith("win")){
  37.             // Windows虚拟路径映射本地磁盘
  38.             registry.addResourceHandler(FileConstants.fileVirtualPath + "**").addResourceLocations("file:" + FileConstants.fileWindowsPath);
  39.         } else {
  40.             // Linux虚拟路径映射本地磁盘
  41.             registry.addResourceHandler(FileConstants.fileVirtualPath + "**").addResourceLocations("file:" + FileConstants.fileLinuxPath);
  42.         }
  43.     }
  44. }
4.InterceptorController.java
  1. import org.slf4j.Logger;
  2. import org.slf4j.LoggerFactory;
  3. import org.springframework.web.bind.annotation.RequestMapping;
  4. import org.springframework.web.bind.annotation.RestController;
  6. /**
  7.  * @Author Christy
  8.  * @Date 2021/9/28 10:44
  9.  **/
  10. @RestController
  11. @RequestMapping("/interceptor")
  12. public class InterceptorController {
  14.     private static final Logger log = LoggerFactory.getLogger(InterceptorController.class);
  16.     @RequestMapping("sayHello")
  17.     public String sayHello(){
  18.         log.info("Hello Interceptor…");
  19.         return "interceptor";
  20.     }
  21. }
5.测试

启动项目，浏览器访问http://localhost:8808/interceptor/sayHello，注意观察页面和控制台输出：

我们改造一下sayHello()方法抛出一个异常，如下所示：

  1. @RequestMapping("sayHello")
  2. public String sayHello(){
  3.   log.info("Hello Interceptor…");
  4.   int i = 1/0;
  5.   return "interceptor";
  6. }

重新启动项目，浏览器访问http://localhost:8808/interceptor/sayHello，注意观察页面和控制台输出：

多个拦截器的执行顺序

1.MyInterceptor01.java

我们修改一下MyInterceptor01.java如下：

  1. import org.slf4j.Logger;
  2. import org.slf4j.LoggerFactory;
  3. import org.springframework.web.servlet.HandlerInterceptor;
  4. import org.springframework.web.servlet.ModelAndView;
  6. import javax.servlet.http.HttpServletRequest;
  7. import javax.servlet.http.HttpServletResponse;
  9. /**
  10.  * 自定义拦截器
  11.  * @Author Christy
  12.  * @Date 2021/9/28 10:20
  13.  **/
  14. public class MyInterceptor01 implements HandlerInterceptor {
  16.     private static final Logger log = LoggerFactory.getLogger(MyInterceptor01.class);
  18.     @Override
  19.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
  20.         log.info("==========MyInterceptor01==========1=========");
  21.         return true;
  22.     }
  24.     @Override
  25.     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
  26.         log.info("==========MyInterceptor01==========2=========");
  27.     }
  29.     @Override
  30.     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
  31.         log.info("==========MyInterceptor01==========3=========");
  32.     }
  33. }
2.MyInterceptor02.java
  1. import org.slf4j.Logger;
  2. import org.slf4j.LoggerFactory;
  3. import org.springframework.web.servlet.HandlerInterceptor;
  4. import org.springframework.web.servlet.ModelAndView;
  6. import javax.servlet.http.HttpServletRequest;
  7. import javax.servlet.http.HttpServletResponse;
  9. /**
  10.  * 自定义拦截器
  11.  * @Author Christy
  12.  * @Date 2021/9/28 10:20
  13.  **/
  14. public class MyInterceptor02 implements HandlerInterceptor {
  16.     private static final Logger log = LoggerFactory.getLogger(MyInterceptor02.class);
  18.     @Override
  19.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
  20.         log.info("==========MyInterceptor02==========4=========");
  21.         return true;
  22.     }
  24.     @Override
  25.     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
  26.         log.info("==========MyInterceptor02==========5=========");
  27.     }
  29.     @Override
  30.     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
  31.         log.info("==========MyInterceptor02==========6=========");
  32.     }
  33. }
3.MyWebMvcConfigurer.java
  1. import com.christy.config.interceptors.MyInterceptor01;
  2. import com.christy.config.interceptors.MyInterceptor02;
  3. import com.christy.constants.FileConstants;
  4. import org.springframework.context.annotation.Configuration;
  5. import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
  6. import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
  7. import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
  9. /**
  10.  * @Author Christy
  11.  * @Date 2021/9/15 16:24
  12.  **/
  13. @Configuration
  14. public class MyWebMvcConfigurer implements WebMvcConfigurer {
  16.     /**
  17.      * 配置拦截器
  18.      * addInterceptor()： 指定拦截器
  19.      * addPathPatterns("/**")：拦截所有Controller请求
  20.      * excludePathPatterns("/file/**")：排除文件操作的请求路径
  21.      * order()：指定拦截器执行顺序 int 类型数字: 默认按照自然排序执行 数字相同时,按照配置顺序执行
  22.      */
  23.     @Override
  24.     public void addInterceptors(InterceptorRegistry registry) {
  25.         registry.addInterceptor(new MyInterceptor01())
  26.                 .addPathPatterns("/interceptor/**")
  27.                 .excludePathPatterns("/file/**")
  28.                 .order(1);
  30.         registry.addInterceptor(new MyInterceptor02())
  31.                 .addPathPatterns("/interceptor/**")
  32.                 .excludePathPatterns("/file/**")
  33.                 .order(2);
  34.     }
  36.     @Override
  37.     public void addResourceHandlers(ResourceHandlerRegistry registry) {
  38.         /**
  39.          * 文件上传到服务器后并不能在项目中直接访问，需要将磁盘路径映射成虚拟路径使用http://domain/的方式才可以
  40.          */
  41.         String os = System.getProperty("os.name");
  42.         if(os.toLowerCase().startsWith("win")){
  43.             // Windows虚拟路径映射本地磁盘
  44.             registry.addResourceHandler(FileConstants.fileVirtualPath + "**").addResourceLocations("file:" + FileConstants.fileWindowsPath);
  45.         } else {
  46.             // Linux虚拟路径映射本地磁盘
  47.             registry.addResourceHandler(FileConstants.fileVirtualPath + "**").addResourceLocations("file:" + FileConstants.fileLinuxPath);
  48.         }
  49.     }
  50. }
4.测试

重新启动项目，浏览器访问http://localhost:8808/interceptor/sayHello，注意观察控制台输出：

多个拦截器注册以后按照注册的顺序以栈式结构存储，上面我们配置了两个拦截器，MyInterceptor01先入栈，MyInterceptor02后入栈；所以当请求来了之后：

首先，进入MyInterceptor01的preHandle打印输出1，再进入MyInterceptor02的preHandle打印输出4；这是一个入栈的过程

其次访问方法主体打印输出方法体内的logger

然后，进入MyInterceptor02的postHandle打印输出5，再进入MyInterceptor01的postHandle打印输出2；这是一个出栈的过程

最后，进入MyInterceptor02的afterCompletion打印输出6，再进入MyInterceptor01的afterCompletion打印输出3；这也是一个出栈的过程

按照上面的描述如果我们更换两个拦截器的顺序，让MyInterceptor02先入栈，MyInterceptor01后入栈；那么打印的结果应该是4->1->2->5->3->6。

我们修改MyWebMvcConfigurer.java的代码更换两个拦截器的顺序如下：

  1. import com.christy.config.interceptors.MyInterceptor01;
  2. import com.christy.config.interceptors.MyInterceptor02;
  3. import com.christy.constants.FileConstants;
  4. import org.springframework.context.annotation.Configuration;
  5. import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
  6. import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
  7. import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
  9. /**
  10.  * @Author Christy
  11.  * @Date 2021/9/15 16:24
  12.  **/
  13. @Configuration
  14. public class MyWebMvcConfigurer implements WebMvcConfigurer {
  16.     /**
  17.      * 配置拦截器
  18.      * addInterceptor()： 指定拦截器
  19.      * addPathPatterns("/**")：拦截所有Controller请求
  20.      * excludePathPatterns("/file/**")：排除文件操作的请求路径
  21.      * order()：指定拦截器执行顺序 int 类型数字: 默认按照自然排序执行 数字相同时,按照配置顺序执行
  22.      */
  23.     @Override
  24.     public void addInterceptors(InterceptorRegistry registry) {
  25.         registry.addInterceptor(new MyInterceptor01())
  26.                 .addPathPatterns("/interceptor/**")
  27.                 .excludePathPatterns("/file/**")
  28.                 .order(2);
  30.         registry.addInterceptor(new MyInterceptor02())
  31.                 .addPathPatterns("/interceptor/**")
  32.                 .excludePathPatterns("/file/**")
  33.                 .order(1);
  34.     }
  36.     @Override
  37.     public void addResourceHandlers(ResourceHandlerRegistry registry) {
  38.         /**
  39.          * 文件上传到服务器后并不能在项目中直接访问，需要将磁盘路径映射成虚拟路径使用http://domain/的方式才可以
  40.          */
  41.         String os = System.getProperty("os.name");
  42.         if(os.toLowerCase().startsWith("win")){
  43.             // Windows虚拟路径映射本地磁盘
  44.             registry.addResourceHandler(FileConstants.fileVirtualPath + "**").addResourceLocations("file:" + FileConstants.fileWindowsPath);
  45.         } else {
  46.             // Linux虚拟路径映射本地磁盘
  47.             registry.addResourceHandler(FileConstants.fileVirtualPath + "**").addResourceLocations("file:" + FileConstants.fileLinuxPath);
  48.         }
  49.     }
  50. }

然后重启项目，浏览器访问http://localhost:8808/interceptor/sayHello，注意观察控制台输出：

版权说明 : 本文为转载文章, 版权归原作者所有 版权申明

原文链接 : https://hardy.blog.csdn.net/article/details/121069343

内容来源于网络，如有侵权，请联系作者删除！

Javaspringspring全家桶

相关文章

    查看更多

    热门标签

    更多
    JavaquerypythonNode开发语言requestUtil数据库Table后端算法LoggerMessageElementParser

    最新文章

    更多
    • 蜀ICP备13028337号-1 大数据知识库 https://www.saoniuhuo.com © All rights reserved
    • 本站内容来源互联网,如果侵犯您的权益请联系我们删除, 联系方式：448109455@qq.com