22. Spring Boot 拦截器HandlerInterceptor【从零开始学Spring Boot】

在Spring Boot框架中，拦截器（HandlerInterceptor）是一种强大的机制，用于在请求处理前后执行自定义逻辑。在本文中，我们将深入探讨Spring Boot中的拦截器，了解其工作原理、如何实现以及实际应用。 Spring MVC是Spring Boot的核心组件，负责处理HTTP请求。拦截器在Spring MVC中扮演着关键角色，它允许我们在请求被控制器处理之前和之后执行额外的操作。这在日志记录、权限验证、性能监控等场景下非常有用。 Spring Boot的拦截器基于`org.springframework.web.servlet.HandlerInterceptor`接口，该接口包含三个方法： 1. `preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)`：这个方法在目标处理器执行之前调用，返回值为布尔类型。如果返回`true`，则表示请求将继续处理；如果返回`false`，则请求将被中断。这是一个理想的地方进行权限检查或初始化操作。 2. `postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)`：此方法在目标处理器执行后，但在视图渲染之前调用。你可以在这个方法中修改ModelAndView对象，或者做一些后处理操作。 3. `afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)`：此方法在整个请求处理完成后调用，无论是否有异常发生。可以用来进行资源清理或记录响应时间。 实现拦截器，我们需要创建一个类并实现`HandlerInterceptor`接口。下面是一个简单的示例： ```java import org.springframework.stereotype.Component; import org.springframework.web.servlet.HandlerInterceptor; import org.springframework.web.servlet.ModelAndView; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; @Component public class CustomInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) { // 执行预处理逻辑，例如登录检查 System.out.println("开始处理请求"); return true; } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) { // 执行后处理逻辑，例如更新视图数据 System.out.println("请求处理完毕，准备渲染视图"); } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) { // 执行完成处理，例如记录请求耗时 System.out.println("请求处理结束"); } } ``` 接下来，我们需要配置拦截器。在Spring Boot应用中，通常在`WebMvcConfigurer`接口的实现类中添加拦截器： ```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 WebConfig implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new CustomInterceptor()); } } ``` 通过上述配置，我们的自定义拦截器就生效了。需要注意的是，Spring Boot 2.x推荐使用`WebMvcConfigurer`而不是`WebMvcConfigurerAdapter`，因为后者在Spring Framework 5.0中已被废弃。 在实际项目中，我们可以根据需要添加多个拦截器，并调整它们的执行顺序。通过`registry.addInterceptor().order(int order)`方法，可以设置拦截器的优先级，数字越小，优先级越高。 总结来说，Spring Boot的拦截器提供了一种灵活的方式，让我们能够在请求生命周期的不同阶段插入自定义逻辑。结合标签“源码”和“工具”，可以进一步研究Spring MVC的源代码，了解其内部实现，也可以开发工具辅助拦截器的调试和管理，提高开发效率和应用性能。在压缩包文件"spring-boot-hello2"中，可能包含了示例代码或者完整的Spring Boot项目，供学习和实践使用。