AI 助理
文档备案控制台
开发者社区 开发与运维 文章 正文

【Spring底层原理高级进阶】轻松掌握 Spring MVC 的拦截器机制：深入理解 HandlerInterceptor 接口和其实现类的用法

2024-03-07 485
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 【Spring底层原理高级进阶】轻松掌握 Spring MVC 的拦截器机制：深入理解 HandlerInterceptor 接口和其实现类的用法

老样子 先用一个生动的例子 来讲解 今天的主角 拦截器的作用

一天，我们的主角坤坤打算开一家篮球店，他兴致勃勃地准备了一切，从篮球装备到装修风格，都精心设计。他决定给自己的篮球店起名叫"坤坤篮球店"，希望能够吸引更多的篮球爱好者。


坤坤开业的第一天，篮球店迎来了很多顾客。他兴奋地迎接每个人，向他们介绍店里的产品和服务。然而，坤坤很快发现，有一些顾客可能并不是真正的篮球爱好者，而是想趁机捣乱或者做一些不合法的事情，也就是人们常说的“小黑子”


这时，他决定在篮球店的入口处设置三个聪明又可爱的坤家卫 人称“三只鸡脚”，它是坤坤的得力助手。这个鸡脚像个守门员，聪明地分辨出哪些人是真爱粉，哪些人只是小黑子，并义正言辞的嘲讽那些虚假的粉丝 并给予礼貌的问候“你最好是”。



每当有人进入篮球店，坤家卫会迅速判断他们的目的。如果是真正的篮球爱好者，拦截器会热情地引导他们到合适的偶像练习生区域，给予他们服务。在他们进行愉快的热舞之前，需要将舞台和背景板渲染成他们喜欢的模样。而对于那些可疑的人，拦截器会立即拦截他们，阻止他们进一步的行动。


最后在激情的热舞过后 会有剩余的坤家卫 打扫战场，作后续操作与资源清理


上面那个故事我们可以预见 坤坤篮球店的兴起  这离不开三位坤家卫的协作  既然如此 那么我们也走进SpringMVC的拦截器当中 深入了解其原理与机制


介绍

拦截器在 Spring MVC 中扮演着重要的角色，用于拦截请求和响应的处理过程，并允许开发人员在请求进入控制器之前或离开控制器之后执行自定义的逻辑。它提供了一种在请求的不同生命周期阶段插入自定义代码的机制。


与过滤器相比，拦截器更加专注于处理控制器级别的逻辑，它们与控制器紧密耦合，并且可以访问和修改控制器方法的参数和返回值。拦截器通常用于实现一些通用的横切关注点，如身份验证、权限检查、日志记录、性能监测等。


在 Spring MVC 中，拦截器通过实现 HandlerInterceptor 接口来定义。HandlerInterceptor 接口包含了三个核心方法：


  1. preHandle：在请求到达控制器之前被调用。可以用于进行一些前置处理，如身份验证、权限检查等。根据返回结果决定是否继续处理请求。


  1. postHandle：在控制器方法执行完成后，视图渲染之前被调用。可以对模型数据进行进一步的处理或修改。


  1. afterCompletion：在整个请求处理完成后被调用。用于进行一些资源清理操作或记录请求处理结果等。


这些方法在拦截器链中按照特定的顺序被调用。在多个拦截器存在的情况下，它们的执行顺序由拦截器的配置顺序决定。拦截器链的执行顺序是先进后出的，即先配置的拦截器最后执行。


通过编写自定义的 HandlerInterceptor 实现类，并将其配置到 Spring MVC 中，开发人员可以灵活地控制请求处理过程中的逻辑。拦截器提供了一种可插拔的机制，使得代码的复用性和可维护性得到提高，并且可以有效地实现横切关注点的功能。


具体实现：

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
 
public class CustomInterceptor implements HandlerInterceptor {
 
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 在请求到达控制器之前被调用
        // 可以进行一些前置处理，如身份验证、权限检查等
        // 返回false将阻止继续处理请求，返回true将允许继续处理请求
        String token = request.getHeader("Authorization");
        if (token == null || !isValidToken(token)) {
            response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
            return false;
        }
        return true;
    }
 
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 在控制器方法执行完成后，视图渲染之前被调用
        // 可以对模型数据进行进一步的处理或修改
        if (modelAndView != null) {
            modelAndView.addObject("customData", "Additional data");
        }
    }
 
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 在整个请求处理完成后被调用
        // 可以进行一些资源清理操作或记录请求处理结果等
        logRequestCompletion(request, response.getStatus());
    }
 
    private boolean isValidToken(String token) {
        // 验证token的逻辑
        // 返回true表示token有效，返回false表示token无效
        // 这里只是一个示例，实际业务逻辑需要根据具体需求实现
        return true;
    }
 
    private void logRequestCompletion(HttpServletRequest request, int status) {
        // 记录请求处理结果的逻辑
        // 这里只是一个示例，实际业务逻辑需要根据具体需求实现
        System.out.println("Request completed - URI: " + request.getRequestURI() + ", Status: " + status);
    }
}


那么，我们也可以创建一个自己的拦截器 来为业务服务：

  1. 创建一个Java类，实现HandlerInterceptor接口。例如，我们可以创建一个名为CustomInterceptor的类：
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
 
public class CustomInterceptor implements HandlerInterceptor {
 
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 实现preHandle方法，在请求到达控制器之前进行拦截和处理
        // 在这里可以实现需要的业务逻辑，例如身份验证、权限检查等
        // 返回true表示继续处理请求，返回false将阻止继续处理请求
        return true;
    }
 
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 实现postHandle方法，在控制器方法执行完成后进行拦截和处理
        // 在这里可以对模型数据进行进一步的处理或修改
    }
 
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 实现afterCompletion方法，在整个请求处理完成后进行拦截和处理
        // 在这里可以进行一些资源清理操作或记录请求处理结果等
    }
}
  1. 在CustomInterceptor类中，您可以根据需要实现preHandle、postHandle和afterCompletion方法来编写具体的业务逻辑。


  1. 注册拦截器到Spring MVC配置中。在Spring MVC的配置文件（如XML配置文件或Java配置类）中，通过配置InterceptorRegistry来注册自定义拦截器。以下是一个示例，假设您正在使用Java配置类：
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 
@Configuration
public class AppConfig implements WebMvcConfigurer {
 
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 注册自定义拦截器
        registry.addInterceptor(new CustomInterceptor()).addPathPatterns("/**");
    }
}

在上述示例中，我们通过addInterceptors方法向InterceptorRegistry注册了CustomInterceptor，并使用addPathPatterns方法指定了拦截的URL模式，这里使用"/**"表示拦截所有请求。


拦截器在实际项目中有多种应用场景，除了身份验证之外还有以下常见用途，以及我做过在业务中的具体实现：


  1. 日志记录：拦截器可以用于记录请求和响应的日志信息，包括请求的URL、参数、处理时间等。这对于跟踪和排查问题、性能优化以及统计分析非常有用。
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
 
public class LoggingInterceptor implements HandlerInterceptor {
 
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 记录请求的URL和参数
        String url = request.getRequestURL().toString();
        String queryString = request.getQueryString();
        System.out.println("Request URL: " + url);
        System.out.println("Request Parameters: " + queryString);
        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 {
        // 在这里可以记录请求处理时间等信息
    }
}
  1. 缓存管理：拦截器可以用于缓存管理，例如在请求到达控制器之前检查缓存中是否存在响应数据，如果存在则直接返回缓存数据，避免重复计算或查询数据库。
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
 
public class CacheInterceptor implements HandlerInterceptor {
 
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 检查缓存中是否存在响应数据
        String cacheKey = generateCacheKey(request);
        Object cachedData = getFromCache(cacheKey);
        if (cachedData != null) {
            // 直接返回缓存数据
            writeResponseData(response, cachedData);
            return false; // 终止请求继续处理
        }
        return true;
    }
 
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 在这里可以将响应数据缓存起来
        String cacheKey = generateCacheKey(request);
        Object responseData = extractResponseData(response);
        storeInCache(cacheKey, responseData);
    }
 
    private String generateCacheKey(HttpServletRequest request) {
        // 根据请求的URL、参数等生成唯一的缓存键
        // ...
    }
 
    private Object getFromCache(String cacheKey) {
        // 从缓存中获取数据
        // ...
    }
 
    private void writeResponseData(HttpServletResponse response, Object data) {
        // 将数据写入响应
        // ...
    }
 
    private Object extractResponseData(HttpServletResponse response) {
        // 从响应中提取数据
        // ...
    }
 
    private void storeInCache(String cacheKey, Object data) {
        // 将数据存入缓存
        // ...
    }
}
  1. 权限控制：除了身份验证，拦截器可以用于实现细粒度的权限控制。在preHandle方法中，可以检查当前用户是否具有访问某个资源或执行某个操作的权限，如果没有权限，则可以返回相应的错误信息或重定向到其他页面。
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
 
public class AuthorizationInterceptor implements HandlerInterceptor {
 
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 检查用户权限
        if (!hasPermission(request)) {
            // 没有权限，返回错误信息或重定向到其他页面
            response.sendRedirect("/error/unauthorized");
            return false; // 终止请求继续处理
        }
        return true;
    }
 
    private boolean hasPermission(HttpServletRequest request) {
        // 检查当前用户是否具有访问资源的权限
        // ...
    }
}
  1. 请求参数解析和预处理：拦截器可以用于解析请求参数，并进行一些预处理操作，例如数据格式转换、参数校验等。这有助于减轻控制器方法的负担，使其更专注于业务逻辑的处理。
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
 
public class RequestProcessingInterceptor implements HandlerInterceptor {
 
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 参数解析和预处理
        String param1 = request.getParameter("param1");
        String param2 = request.getParameter("param2");
        // 对参数进行处理或校验
        // ...
        return true;
    }
 
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 在这里可以对模型数据进行进一步处理或修改
    }
}
  1. 错误处理：拦截器可以用于全局的错误处理，捕获和处理异常。在afterCompletion方法中，可以对异常进行统一的处理，例如记录日志、发送通知等。
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
 
public class ErrorHandlingInterceptor implements HandlerInterceptor {
 
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
       // 在这里对异常进行统一处理
        if (ex != null) {
            // 记录日志或发送通知
            System.out.println("Exception occurred: " + ex.getMessage());
        }
    }
}


一些拦截器的注意事项和最佳实践包括：

  1. 尽量保持拦截器的逻辑简单和高效，避免过多的复杂业务处理。过多的业务逻辑应该放在控制器或服务层中处理。
  2. 注意拦截器的执行顺序，特别是在多个拦截器同时工作的情况下。可以使用@Order注解或实现Ordered接口来指定拦截器的执行顺序。
  3. 注意拦截器的性能影响。拦截器是链式调用的，每个拦截器都会对请求进行处理，因此需要谨慎处理拦截器的性能，避免不必要的操作和重复计算。
  4. 异常处理：拦截器应该对异常进行适当的处理和封装，以便能够正确地返回错误信息给客户端或进行统一的异常处理。
文章标签：
日志服务
Java
Spring
前端开发
缓存
数据安全/隐私保护
关键词：
Spring原理
Spring Spring mvc
Spring MVC
Spring拦截器
Spring MVC类
相关实践学习
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
图灵重生我名苏泽
目录
相关文章
Quan_Chen
|
前端开发 Java 测试技术
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RequestParam
本文介绍了 `@RequestParam` 注解的使用方法及其与 `@PathVariable` 的区别。`@RequestParam` 用于从请求中获取参数值（如 GET 请求的 URL 参数或 POST 请求的表单数据），而 `@PathVariable` 用于从 URL 模板中提取参数。文章通过示例代码详细说明了 `@RequestParam` 的常用属性，如 `required` 和 `defaultValue`，并展示了如何用实体类封装大量表单参数以简化处理流程。最后，结合 Postman 测试工具验证了接口的功能。
Quan_Chen
916 0
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RequestParam
一枚后端工程狮
|
9月前
|
前端开发 Java 微服务
《深入理解Spring》：Spring、Spring MVC与Spring Boot的深度解析
Spring Framework是Java生态的基石，提供IoC、AOP等核心功能；Spring MVC基于其构建，实现Web层MVC架构；Spring Boot则通过自动配置和内嵌服务器，极大简化了开发与部署。三者层层演进，Spring Boot并非替代，而是对前者的高效封装与增强，适用于微服务与快速开发，而深入理解Spring Framework有助于更好驾驭整体技术栈。
一枚后端工程狮
2226 5
Quan_Chen
|
JSON 前端开发 Java
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RequestBody
`@RequestBody` 是 Spring 框架中的注解，用于将 HTTP 请求体中的 JSON 数据自动映射为 Java 对象。例如，前端通过 POST 请求发送包含 `username` 和 `password` 的 JSON 数据，后端可通过带有 `@RequestBody` 注解的方法参数接收并处理。此注解适用于传递复杂对象的场景，简化了数据解析过程。与表单提交不同，它主要用于接收 JSON 格式的实体数据。
Quan_Chen
1603 0
Quan_Chen
|
前端开发 Java 微服务
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@PathVariable
`@PathVariable` 是 Spring Boot 中用于从 URL 中提取参数的注解，支持 RESTful 风格接口开发。例如，通过 `@GetMapping("/user/{id}")` 可以将 URL 中的 `{id}` 参数自动映射到方法参数中。若参数名不一致，可通过 `@PathVariable("自定义名")` 指定绑定关系。此外，还支持多参数占位符，如 `/user/{id}/{name}`，分别映射到方法中的多个参数。运行项目后，访问指定 URL 即可验证参数是否正确接收。
Quan_Chen
987 0
Quan_Chen
|
JSON 前端开发 Java
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RequestMapping
@RequestMapping 是 Spring MVC 中用于请求地址映射的注解，可作用于类或方法上。类级别定义控制器父路径，方法级别进一步指定处理逻辑。常用属性包括 value（请求地址）、method（请求类型，如 GET/POST 等，默认 GET）和 produces（返回内容类型）。例如：`@RequestMapping(value = "/test", produces = "application/json; charset=UTF-8")`。此外，针对不同请求方式还有简化注解，如 @GetMapping、@PostMapping 等。
Quan_Chen
936 0
Quan_Chen
|
JSON 前端开发 Java
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RestController
本文主要介绍 Spring Boot 中 MVC 开发常用的几个注解及其使用方式，包括 `@RestController`、`@RequestMapping`、`@PathVariable`、`@RequestParam` 和 `@RequestBody`。其中重点讲解了 `@RestController` 注解的构成与特点：它是 `@Controller` 和 `@ResponseBody` 的结合体，适用于返回 JSON 数据的场景。文章还指出，在需要模板渲染（如 Thymeleaf）而非前后端分离的情况下，应使用 `@Controller` 而非 `@RestController`
Quan_Chen
610 0
waylau
|
12月前
|
前端开发 Java API
Spring Cloud Gateway Server Web MVC报错“Unsupported transfer encoding: chunked”解决
本文解析了Spring Cloud Gateway中出现“Unsupported transfer encoding: chunked”错误的原因，指出该问题源于Feign依赖的HTTP客户端与服务端的`chunked`传输编码不兼容，并提供了具体的解决方案。通过规范Feign客户端接口的返回类型，可有效避免该异常，提升系统兼容性与稳定性。
waylau
822 0
Unfailed_realme
|
12月前
|
SQL Java 数据库连接
Spring、SpringMVC 与 MyBatis 核心知识点解析
我梳理的这些内容，涵盖了 Spring、SpringMVC 和 MyBatis 的核心知识点。 在 Spring 中，我了解到 IOC 是控制反转，把对象控制权交容器；DI 是依赖注入，有三种实现方式。Bean 有五种作用域，单例 bean 的线程安全问题及自动装配方式也清晰了。事务基于数据库和 AOP，有失效场景和七种传播行为。AOP 是面向切面编程，动态代理有 JDK 和 CGLIB 两种。 SpringMVC 的 11 步执行流程我烂熟于心，还有那些常用注解的用法。 MyBatis 里，#{} 和 ${} 的区别很关键，获取主键、处理字段与属性名不匹配的方法也掌握了。多表查询、动态
Unfailed_realme
366 0
糊涂糊涂123
|
12月前
|
JSON 前端开发 Java
第05课：Spring Boot中的MVC支持
第05课：Spring Boot中的MVC支持
糊涂糊涂123
441 0
WanderInk-20107
|
前端开发 IDE Java
Spring MVC 中因导入错误的 Model 类报错问题解析
在 Spring MVC 或 Spring Boot 开发中，若导入错误的 `Model` 类（如 `ch.qos.logback.core.model.Model`），会导致无法解析 `addAttribute` 方法的错误。正确类应为 `org.springframework.ui.Model`。此问题通常因 IDE 自动导入错误类引起。解决方法包括：删除错误导入、添加正确包路径、验证依赖及清理缓存。确保代码中正确使用 Spring 提供的 `Model` 接口以实现前后端数据传递。
WanderInk-20107
526 0

热门文章

最新文章

  • 1
    ASP.NET MVC4+BootStrap 实战(三)
  • 2
    《Pro ASP.NET MVC 3 Framework》学习笔记之二【领域模型的概念介绍及MVC模型绑定】
  • 3
    ASP.NET MVC3 Model验证总结
  • 4
    MVC Html.RenderPartial和Html.partial
  • 5
    asp.net mvc中的路径选择
  • 6
    基于SSM+MVC三层架构实现用户权限管理系统
  • 7
    【记录】ASP.NET MVC View 移动版浏览的奇怪问题
  • 8
    ASP.NET MVC4 音乐商店，Entity Framework 4.1 表名被自动转换成复数问题解决
  • 9
    MVC View中获取action、controller、area名称、参数
  • 10
    【转】Asp.Net MVC4 之Url路由
  • 1
    基于 Spring AI Alibaba + Nacos 的分布式 Multi-Agent 构建指南
    5391
  • 2
    Spring AI Alibaba Admin 开源！以数据为中心的 Agent 开发平台
    8194
  • 3
    Spring Boot自动装配
    713
  • 4
    【Spring Boot实战】EasyPoi神技：一篇搞定“一对多+图片”导入！
    2129
  • 5
    《深入理解Spring》性能监控与优化——构建高性能应用的艺术
    543
  • 6
    《深入理解Spring》单元测试——高质量代码的守护神
    1385
  • 7
    《深入理解Spring》定时任务——自动化调度的时间管理者
    1047
  • 8
    《深入理解Spring》事务管理——数据一致性的守护者
    587
  • 9
    《深入理解Spring》过滤器（Filter）——Web请求的第一道防线
    1669
  • 10
    《深入理解Spring》拦截器（Interceptor）——请求处理的艺术
    872

    • 相关课程

    更多
  • 全面讲解Spring Cloud Alibaba技术栈（知识精讲+项目实战）第四阶段
  • 精通Spring Cloud Alibaba
  • 微服务框架 Spring Cloud 快速入门
  • Java Web开发系列课程 - Spring框架入门
  • Spring Boot 2.5.x开发实战
  • Spring Cloud微服务架构设计与开发实战

    • 相关电子书

    更多
  • 云栖社区特邀专家徐雷Java Spring Boot开发实战系列课程（第20讲）：经典面试题与阿里等名企内部招聘求职面试技巧
  • 微服务架构模式与原理Spring Cloud开发实战
  • 阿里特邀专家徐雷Java Spring Boot开发实战系列课程（第18讲）：制作Java Docker镜像与推送到DockerHub和阿里云Docker仓库
    • 下一篇
    一条命令迁移，帮你实现 OpenClaw 与 Hermes Agent 记忆互通！