深入理解 Spring MVC 拦截器：增强应用程序的功能和可维护性

最新推荐文章于 2024-11-15 14:09:57 发布

知行小栈

最新推荐文章于 2024-11-15 14:09:57 发布

阅读量1.3k

点赞数 43

分类专栏： Spring 文章标签： spring mvc java

本文链接：https://blog.csdn.net/LearnerDL/article/details/138978143

版权

Spring 专栏收录该内容

11 篇文章 0 订阅

订阅专栏

前言

在现代的 Web 应用程序开发中，拦截器是一种强大的工具，能够在请求处理的不同阶段执行特定的操作，从而增强应用程序的功能和可维护性。在 Spring MVC 框架中，拦截器起着至关重要的作用。本文将探讨 Spring MVC 拦截器的工作原理、用途以及如何使用它们来提升应用程序的性能和可扩展性。

一、什么是 Spring MVC 拦截器

Spring MVC 拦截器是一种机制，允许开发人员在请求到达控制器之前或之后执行预定的操作。它们实现了 HandlerInterceptor 接口，并可以注册到 Spring MVC 框架中，以拦截匹配特定 URL 模式的请求。拦截器通常用于执行各种任务，如身份验证、日志记录、性能监控、异常处理等。

二、Spring MVC 拦截器的作用

请求预处理：拦截器允许在请求到达控制器之前执行预处理操作。这包括参数验证、用户身份验证、日志记录等。通过在 preHandle 方法中实现逻辑，可以在请求处理之前执行任何必要的操作。
后处理和修改响应：拦截器还允许在请求处理之后、视图渲染之前进行后处理。这使得开发人员可以修改处理器的执行结果或添加额外的处理逻辑。
资源清理和异常处理：拦截器的 afterCompletion 方法允许在请求处理完成后进行资源清理操作。这对于释放资源、关闭连接等工作非常有用。同时，还可以在这里处理请求过程中发生的异常，以确保资源的正确释放。
统一处理逻辑：拦截器可以用于实现一些统一的处理逻辑，如权限控制、日志记录、国际化等。通过将这些逻辑抽象到拦截器中，可以提高代码的重用性和可维护性，同时确保这些逻辑在整个应用程序中得到一致的应用。

三、Spring MVC 拦截器工作原理

workspace (15).jpg

Spring MVC 拦截器的工作原理可以概括为以下几个步骤：

请求到达 DispatcherServlet：当客户端发送请求时，请求首先到达 Spring MVC 应用的前端控制器 DispatcherServlet。
拦截器链的执行：DispatcherServlet 在处理请求时，会调用注册在拦截器链中的拦截器。拦截器链是按照配置的顺序执行的。
preHandle 方法的执行：在拦截器链执行过程中，每个拦截器的 preHandle 方法被调用。在 preHandle 方法中，拦截器可以对请求进行预处理，并决定是否继续处理请求或中断请求处理流程。
- 如果 preHandle 方法返回 true，则表示拦截器允许请求继续向下执行，请求会继续传递给下一个拦截器
- 如果 preHandle 方法返回 false，则表示拦截器不允许请求继续执行，请求处理流程会在此中断，并且 DispatcherServlet 不会将请求转发给处理器（Controller）。
处理器执行：如果所有拦截器的 preHandle 方法都返回 true，请求会继续向下执行，最终进入到相应的处理器（Controller）中。
postHandle 方法的执行：当处理器执行完成后，拦截器链中的每个拦截器的 postHandle 方法会被调用。在 postHandle 方法中，拦截器可以对处理器执行结果进行后处理，如修改 ModelAndView 对象。
视图渲染：在处理器执行完成后，DispatcherServlet 将处理器执行结果（通常是 ModelAndView 对象）传递给视图解析器，解析器会根据处理器返回的视图名解析出对应的视图对象，并将模型数据填充到视图中。
afterCompletion 方法的执行：最后，视图渲染完成后，拦截器链中的每个拦截器的 afterCompletion 方法会被调用。在 afterCompletion 方法中，拦截器可以进行资源清理等操作。

四、Spring MVC 拦截器使用流程

要使用 Spring MVC 拦截器，首先需要创建一个类，实现 HandlerInterceptor 接口，并实现其中的方法：preHandle、postHandle 和 afterCompletion。然后，将拦截器注册为 Spring MVC 的一个组件，并指定要拦截的 URL 模式。

自定义拦截器

public class CustomInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 在请求处理之前执行的操作
        System.out.println("Pre-handle method is called");

        // 返回 true 继续执行，返回 false 中断执行
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 在请求处理之后、视图渲染之前执行的操作
        System.out.println("Post-handle method is called");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 在视图渲染完成之后执行的操作
        System.out.println("After completion method is called");
    }
}

注册拦截器

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 拦截所有的请求
        registry.addInterceptor(new CustomHandlerInterceptor()).addPathPatterns("/**");
    }
}

测试效果：

五、拦截路径

拦截器的拦截路径配置非常灵活，可以根据需要进行精确匹配或者模糊匹配。

5.1 精确匹配路径

使用 addPathPatterns() 方法来指定需要拦截的路径模式。这个方法接受一个或多个路径模式作为参数，只有当请求的路径与指定的路径模式完全匹配时，拦截器才会生效。

@Override
public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(new MyInterceptor())
        .addPathPatterns("/admin/**"); // 只拦截以 /admin 开头的请求
}

5.2 模糊匹配路径

除了精确匹配路径，我们还可以使用通配符和正则表达式来匹配多个路径。

通配符 * ：匹配路径中的任意字符（除了路径分隔符 /）
通配符 **：匹配任意路径级别的任意字符
通配符 ?：匹配路径中的一个字符

@Override
public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(new MyInterceptor())
            .addPathPatterns("/api/*/user/**") // 匹配 /api/v1/user、/api/v2/user 等路径
            .addPathPatterns("/resources/**") // 匹配 /resources/css、/resources/js 等路径
            .addPathPatterns("/admin/**") // 匹配 /admin/dashboard、/admin/profile 等路径
            .addPathPatterns("/user?"); // 匹配 /user，但不匹配 /users
}

六、拦截器配置

6.1 排除路径

有时候，我们希望拦截器对大部分路径生效，但对某些路径进行排除。可以使用 excludePathPatterns() 方法来指定需要排除的路径模式。

@Override
public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(new MyInterceptor())
    .addPathPatterns("/api/**") // 匹配所有 /api 开头的路径
    .excludePathPatterns("/api/login"); // 排除 /api/login 路径
}

6.2 多个拦截器配置

如果有多个拦截器，可以按照需要依次添加到拦截器链中，它们的执行顺序与注册的顺序相同。

@Override
public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(new LoggerInterceptor())
    .addPathPatterns("/**"); // 添加日志记录拦截器
    registry.addInterceptor(new AuthInterceptor())
    .addPathPatterns("/admin/**"); // 添加权限验证拦截器，只拦截 /admin 开头的路径
}