【Java 中级】一文精通 Spring MVC - 拦截器（十二）

拼搏现实的明天。 2024-05-04 08:08 55阅读 0赞

![在这里插入图片描述][f7a0dc2415b547878dee79ea3dc67ce4.png]

> ?**博主介绍**： 博主从事应用安全和大数据领域，有8年研发经验，5年面试官经验，Java技术专家，WEB架构师，阿里云专家博主，华为云云享专家，51CTO 专家博主

⛪️ 个人社区：[个人社区][Link 1]  
? 个人主页：[个人主页][Link 2]  
? 专栏地址： ✅ [Java 高阶][Java]  
?八股文专题：[剑指大厂，手撕 Java 八股文][Java 1]

#### 文章目录 ####

*   *   *  1. 什么是拦截器
         *  2. 拦截器的优缺点
         *  3. 拦截器的应用场景
         *  4. 有哪些拦截器
         *  5. 自定义拦截器
         *  6. 定义多个拦截器
         *  7. 拦截器的执行原理
         *  8. 拦截器和过滤器的区别
         *  9. 使用拦截器实现登录权限拦截

#### 1. 什么是拦截器 ####

拦截器（Interceptor）是一种在软件开发中常用的概念，它可以在处理请求和响应过程中进行拦截和干预。拦截器通常用于在请求到达目标之前或响应返回给客户端之前，对请求或响应进行预处理或后处理。

在Web开发中，拦截器可以用于实现各种功能，如身份验证、日志记录、异常处理、性能监控等。当请求到达服务器时，拦截器可以对请求进行检查和验证，并在需要时中断请求或进行重定向。同样地，拦截器也可以对响应进行处理，例如添加响应头、修改响应内容等。

拦截器通常以链式结构组织，每个拦截器都有机会在请求处理过程中进行操作。当一个请求被发送时，它会依次经过拦截器链中的每个拦截器，每个拦截器都可以对请求进行处理或干预。这种链式结构使得拦截器的功能可以被灵活组合和扩展。

拦截器是一种常见的开发工具，用于在请求和响应过程中实现各种功能和处理逻辑。它在许多框架和平台中都有广泛应用，提供了一种方便和可扩展的方式来处理请求和响应。

#### 2. 拦截器的优缺点 ####

拦截器的使用具有一些优点和缺点，下面是它们的一些常见特点：

优点：

1.  可重用性：拦截器可以在多个请求或响应中重复使用，提高了代码的复用性和可维护性。
2.  灵活性：拦截器可以根据需要进行配置和组合，以实现不同的功能和处理逻辑。
3.  解耦合：拦截器可以将不同的功能和处理逻辑分离，使得代码更加模块化和可测试。
4.  可扩展性：拦截器可以方便地进行扩展和定制，以满足特定的需求和业务场景。

缺点：

1.  性能影响：由于拦截器需要在请求和响应过程中进行额外的处理，可能会对性能产生一定的影响。特别是当拦截器链较长或拦截器逻辑较复杂时，可能会导致请求处理时间增加。
2.  过度使用：如果拦截器使用不当或过度使用，可能会导致代码变得复杂和难以理解。因此，需要合理地选择和使用拦截器，避免滥用。
3.  依赖关系：拦截器可能依赖于特定的框架或平台，这可能会导致代码的耦合性增加。如果需要更换框架或平台，可能需要重新编写或调整拦截器代码。

#### 3. 拦截器的应用场景 ####

拦截器在软件开发中有广泛的应用场景，以下是一些常见的应用场景：

1.  身份验证和权限控制：拦截器可以用于验证用户身份和权限，确保只有授权用户可以访问特定的资源或执行敏感操作。
2.  日志记录和监控：拦截器可以用于记录请求和响应的日志信息，包括请求参数、响应状态等，以便进行故障排查、性能分析和系统监控。
3.  异常处理和错误处理：拦截器可以捕获和处理请求处理过程中的异常，例如处理未捕获的异常、返回自定义的错误页面或错误信息等。
4.  缓存和性能优化：拦截器可以用于实现缓存机制，例如将经常请求的数据缓存在内存或其他存储介质中，以提高系统的响应速度和性能。
5.  数据转换和格式化：拦截器可以用于对请求和响应的数据进行转换和格式化，例如将请求参数转换为特定的数据类型，或将响应数据格式化为特定的格式。
6.  请求重定向和路由：拦截器可以根据特定的条件或规则，对请求进行重定向或路由到不同的处理器或控制器，以实现请求的动态路由和分发。
7.  安全防护和防御：拦截器可以用于实现安全防护措施，例如防止恶意请求、防止跨站脚本攻击（XSS）、防止SQL注入等。

#### 4. 有哪些拦截器 ####

拦截器的具体种类和功能会根据不同的开发框架和平台而有所差异。以下是一些常见的拦截器类型：

1.  HTTP拦截器：用于在HTTP请求和响应的过程中进行拦截和处理，可以实现身份验证、日志记录、异常处理等功能。在Java中，常见的HTTP拦截器包括Servlet过滤器、Spring的HandlerInterceptor等。
2.  AOP拦截器：AOP（面向切面编程）拦截器可以在方法调用或程序执行的特定切点上进行拦截和处理。它可以用于实现日志记录、性能监控、事务管理等功能。在Java中，常见的AOP拦截器包括Spring的AspectJ、Java动态代理等。
3.  ORM拦截器：ORM（对象关系映射）拦截器可以拦截数据库操作，例如拦截SQL语句的执行、拦截数据的读写等。它可以用于实现缓存、数据加密、数据校验等功能。在Java中，常见的ORM拦截器包括Hibernate的拦截器、MyBatis的拦截器等。
4.  安全拦截器：安全拦截器用于实现安全防护和权限控制，可以拦截恶意请求、验证用户身份、检查权限等。在Java中，常见的安全拦截器包括Spring Security的拦截器、Apache Shiro的拦截器等。
5.  日志拦截器：日志拦截器用于记录系统运行时的日志信息，可以拦截请求和响应的日志，以便进行故障排查和系统监控。在Java中，常见的日志拦截器包括Log4j、Logback等。

#### 5. 自定义拦截器 ####

在Spring MVC中，您可以通过实现HandlerInterceptor接口来创建自定义拦截器。以下是创建自定义拦截器的一般步骤：

1.  创建一个类并实现HandlerInterceptor接口，该接口包含了三个方法：preHandle、postHandle和afterCompletion。您可以根据需要选择实现这些方法。
2.  在自定义拦截器中，您可以在preHandle方法中进行请求的预处理操作。例如，您可以进行身份验证、权限检查等操作，并根据需要决定是否继续处理请求。
3.  在postHandle方法中，您可以对请求进行后处理操作。例如，您可以修改响应数据、添加额外的响应头等。
4.  在afterCompletion方法中，您可以进行一些清理操作。该方法会在请求处理完成后被调用，无论请求是否成功都会执行。
5.  注册自定义拦截器。在Spring MVC配置文件中，您可以通过实现WebMvcConfigurer接口，并重写addInterceptors方法来注册您的自定义拦截器。

下面是一个简单的示例：

public class CustomInterceptor implements HandlerInterceptor {
        
    
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        
            // 在请求处理之前进行预处理操作
            // 进行身份验证、权限检查等操作
            // 返回true表示继续处理请求，返回false表示中断请求处理
            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 {
        
            // 在请求完成后进行清理操作
        }
    }

在Spring MVC配置文件中注册自定义拦截器：

@Configuration
    public class WebMvcConfig implements WebMvcConfigurer {
        
    
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
        
            registry.addInterceptor(new CustomInterceptor()).addPathPatterns("/**");
        }
    }

通过以上步骤，您可以创建并注册自定义拦截器，并在Spring MVC应用程序中使用它来实现特定的功能和处理逻辑。

#### 6. 定义多个拦截器 ####

在Spring MVC中，您可以定义多个拦截器来按顺序执行不同的拦截逻辑。以下是定义多个拦截器的步骤：

1.  创建多个实现了HandlerInterceptor接口的拦截器类，每个拦截器类都需要实现preHandle、postHandle和afterCompletion方法。
2.  在每个拦截器类中实现自己的拦截逻辑。您可以根据需要进行身份验证、日志记录、权限检查等操作。
3.  在Spring MVC配置文件中注册拦截器。您可以通过实现WebMvcConfigurer接口，并重写addInterceptors方法来注册多个拦截器。
4.  指定拦截器的执行顺序。在addInterceptors方法中，您可以使用InterceptorRegistry的addInterceptor方法按照需要的顺序注册拦截器。

下面是一个示例：

public class CustomInterceptor1 implements HandlerInterceptor {
        
        // 实现拦截器1的逻辑
    }
    
    public class CustomInterceptor2 implements HandlerInterceptor {
        
        // 实现拦截器2的逻辑
    }
    
    @Configuration
    public class WebMvcConfig implements WebMvcConfigurer {
        
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
        
            registry.addInterceptor(new CustomInterceptor1()).addPathPatterns("/**");
            registry.addInterceptor(new CustomInterceptor2()).addPathPatterns("/**");
        }
    }

在上面的示例中，我们定义了两个拦截器CustomInterceptor1和CustomInterceptor2，并在addInterceptors方法中按照需要的顺序注册了这两个拦截器。这样，当请求到达时，首先会执行CustomInterceptor1的拦截逻辑，然后再执行CustomInterceptor2的拦截逻辑。

#### 7. 拦截器的执行原理 ####

拦截器是一种在软件开发中常用的概念，它用于拦截并处理请求或响应。在Web开发中，拦截器通常用于在请求到达目标处理程序之前或响应返回给客户端之前执行一些额外的操作。

拦截器的执行原理可以简单概括为以下几个步骤：

1.  定义拦截器：首先，你需要定义一个拦截器类，该类实现了拦截器接口。拦截器接口通常包含预定义的方法，例如在请求处理之前执行的方法、在请求处理之后执行的方法等。
2.  注册拦截器：将拦截器注册到应用程序的配置中。这样，当请求到达时，应用程序就会根据配置找到相应的拦截器。
3.  拦截请求：当请求到达时，拦截器会拦截该请求并执行预定义的操作。这些操作可以包括身份验证、日志记录、性能监控等。
4.  传递给目标处理程序：在拦截器执行完操作后，它会将请求传递给目标处理程序。目标处理程序是实际处理请求的组件，它可能是一个控制器、一个服务等。
5.  拦截响应：在目标处理程序完成请求处理后，拦截器可以再次拦截响应并执行一些操作。这些操作可以包括修改响应内容、添加额外的响应头等。

#### 8. 拦截器和过滤器的区别 ####

拦截器和过滤器是在软件开发中常用的两种概念，它们都用于对请求进行处理，但在实现和使用上存在一些区别。

1.  执行位置：拦截器是在目标处理程序调用前后进行拦截和处理，而过滤器是在请求进入Web容器之前和响应离开容器之前进行拦截和处理。
2.  作用范围：拦截器通常是针对特定的目标处理程序或请求处理器进行拦截和处理，而过滤器可以对整个应用程序的请求进行拦截和处理。
3.  实现方式：拦截器通常是通过实现拦截器接口或继承拦截器类来实现的，而过滤器是基于Servlet规范中的Filter接口来实现的。
4.  功能灵活性：拦截器提供了更灵活的功能扩展和处理能力，可以在请求处理前后执行额外的操作，例如身份验证、日志记录、性能监控等。而过滤器主要用于请求的预处理和响应的后处理，功能相对较为简单。
5.  依赖关系：拦截器通常依赖于框架或容器的支持，例如Spring框架中的拦截器需要通过配置和注册才能生效。而过滤器是基于Servlet容器的规范实现的，不依赖于具体的框架。

#### 9. 使用拦截器实现登录权限拦截 ####

使用拦截器实现登录权限拦截是一种常见的做法，可以确保只有已登录用户才能访问受保护的资源。下面是一个简单的示例，演示如何使用拦截器实现登录权限拦截：

1.  创建一个拦截器类，实现拦截器接口。在该类中，可以定义在请求处理之前执行的方法（preHandle）、在请求处理之后执行的方法（postHandle）和在响应返回之后执行的方法（afterCompletion）。
2.  在preHandle方法中，检查用户是否已登录。如果用户已登录，则返回true，允许请求继续处理；如果用户未登录，则返回false，拦截请求并进行相应的处理（例如重定向到登录页面）。
3.  注册拦截器，在应用程序的配置中将拦截器注册到适当的位置。这通常涉及到配置拦截器的URL路径模式，以及指定拦截器的优先级顺序。
4.  当请求到达时，拦截器会拦截请求并调用preHandle方法进行权限检查。如果权限检查通过，则请求会继续传递给目标处理程序进行实际处理；如果权限检查未通过，则请求会被拦截并进行相应的处理。

以下是一个简单的示例代码，用于演示如何使用拦截器实现登录权限拦截：

public class LoginInterceptor implements HandlerInterceptor {
        
    
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        
            // 检查用户是否已登录，例如通过检查Session中是否存在登录信息
            if (request.getSession().getAttribute("user") != null) {
        
                return true; // 用户已登录，允许请求继续处理
            } else {
        
                response.sendRedirect("/login"); // 用户未登录，重定向到登录页面
                return false; // 拦截请求
            }
        }
    
        // 其他方法 postHandle() 和 afterCompletion() 可根据需要进行实现
    }

在应用程序的配置中注册拦截器：

@Configuration
    public class AppConfig extends WebMvcConfigurerAdapter {
        
    
        @Autowired
        private LoginInterceptor loginInterceptor;
    
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
        
            registry.addInterceptor(loginInterceptor)
                    .addPathPatterns("/protected/**") // 配置需要拦截的URL路径模式
                    .excludePathPatterns("/login"); // 配置排除的URL路径模式
        }
    }

在上述示例中，拦截器会拦截所有以"/protected"开头的URL路径，并排除了"/login"路径。当用户访问受保护的资源时，拦截器会检查用户是否已登录，如果未登录，则重定向到登录页面。如果已登录，则允许请求继续处理。

>  精彩专栏推荐订阅：在下方专栏??  
>  ✅ [2023年华为OD机试真题（A卷&B卷）+ 面试指导 ][2023_OD_A_B_ _]  
>  ✅ [ 精选100套 Java 项目案例 ][_100_ Java _]  
>  ✅ [面试需要避开的坑（活动）][Link 3]  
>  ✅ [你找不到的核心代码][Link 4]  
>  ✅ [带你手撕 Spring][Spring]  
>  ✅ [Java 初阶][Java 2]

![在这里插入图片描述][7b7478e55aa24a948b358051ef941b6a.webp_pic_center]

[f7a0dc2415b547878dee79ea3dc67ce4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/04/bb0770f03fdd49d4bdb13435fa18ad19.png
[Link 1]: https://bbs.csdn.net/forums/45c04d3f41cc4dadaf312be1d1379b45?category=10003
[Link 2]: https://jiliu.blog.csdn.net/
[Java]: https://blog.csdn.net/qq_37967783/category_12399402.html
[Java 1]: https://blog.csdn.net/qq_37967783/article/details/130940512
[2023_OD_A_B_ _]: https://blog.csdn.net/qq_37967783/category_12389634.html
[_100_ Java _]: https://blog.csdn.net/qq_37967783/category_12388267.html
[Link 3]: https://blog.csdn.net/qq_37967783/category_12380337.html
[Link 4]: https://blog.csdn.net/qq_37967783/category_12391346.html
[Spring]: https://blog.csdn.net/qq_37967783/category_12391987.html
[Java 2]: https://blog.csdn.net/qq_37967783/category_9902143.html
[7b7478e55aa24a948b358051ef941b6a.webp_pic_center]: https://img-blog.csdnimg.cn/7b7478e55aa24a948b358051ef941b6a.webp#pic_center