SpringBoot新增拦截器详解

目录

一、拦截器使用

二、SpringMvc拦截器接口

三、SpringBoot集成拦截器

---

拦截器（Interceptor）通常是指在软件开发中用于处理请求和响应的中间件组件。拦截器的主要目的是在请求进入某个处理流程或在响应返回给客户端之前执行一些额外的操作或逻辑。

一、拦截器使用

1. 认证和授权：拦截器可以用于验证用户的身份并检查他们是否有权限执行某个操作。这对于构建安全的应用程序非常重要。

2. 日志记录：拦截器可以用于记录请求和响应的信息，以便进行故障排除、监控和分析。

3. 数据转换：拦截器可以在请求和响应之间进行数据格式的转换，例如将JSON数据转换为XML格式或反之。

4. 性能监控：拦截器可以用于测量请求处理的性能，以便找出潜在的性能瓶颈。

5. 缓存：拦截器可以用于检查是否存在缓存的副本并返回它们，以减轻服务器的负载。

6. 异常处理：拦截器可以捕获和处理请求处理过程中出现的异常，以便提供更友好的错误信息或执行恢复操作。

二、SpringMvc拦截器接口

在Spring MVC框架中，拦截器通常通过实现 HandlerInterceptor 接口来创建。这个接口定义了三个方法，允许你在请求处理前、请求处理后和请求完成后执行自定义逻辑：

• preHandle(HttpServletRequest request, HttpServletResponse response, Object handler): 在请求处理前执行，可以用于认证、授权等前置操作。

• postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView): 在请求处理后视图渲染之前执行，可以用于修改ModelAndView对象。

• afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex): 在请求完成后执行，无论是否发生异常都会执行，通常用于资源清理操作。

三、SpringBoot集成拦截器

在 Spring Boot 中集成拦截器也非常简单，它基本上遵循了 Spring MVC 的方式，因为 Spring Boot 构建在 Spring MVC 之上。

创建一个拦截器类：首先，你需要创建一个类来实现 HandlerInterceptor 接口或其子接口，然后实现相应的拦截逻辑。这个类会包含 preHandle、postHandle 和 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 MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 在请求处理前执行的逻辑，例如认证和权限检查
        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 Boot 应用程序中。这可以通过创建一个配置类来完成。在这个配置类中，使用 addInterceptors 方法来添加拦截器，并指定要拦截的路径。

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 MyInterceptorConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor())
                .addPathPatterns("/secure/**") // 配置拦截的路径
                .excludePathPatterns("/public/**"); // 配置不拦截的路径
    }
}

 在这个示例中，MyInterceptor 被注册为拦截器，它会拦截以 "/secure/" 开头的路径，但不会拦截以 "/public/" 开头的路径。

拦截器可以用于实现认证、授权、日志记录、性能监控等各种用途，帮助你在请求处理过程中执行自定义逻辑。