java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > spring Interceptor使用

spring中Interceptor的使用小结

作者：有梦想的攻城狮

Spring Interceptor是Spring MVC提供的一种机制,用于在请求处理的不同阶段插入自定义逻辑,通过实现HandlerInterceptor接口并注册拦截器,可以控制拦截器的执行顺序和路径匹配规则,下面就来详细的介绍一下,感兴趣的可以了解一下

一、Interceptor 的核心概念

Interceptor（拦截器） 是 Spring MVC 提供的一种机制，用于在请求处理的不同阶段插入自定义逻辑。其核心作用包括：

与 Filter 的区别：

特性Interceptor（拦截器）Filter（过滤器）
作用范围针对 Spring MVC 的控制器层作用于 Servlet 容器层面
依赖框架Spring MVC 管理Servlet 原生规范
数据访问可操作 ModelAndView仅能操作 HttpServletRequest/Response。

二、Interceptor 的创建与配置

  1. 实现拦截器类
    继承 HandlerInterceptor 接口，重写以下方法：
public class AuthInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        // 请求前处理（如权限校验）
        return true; // 返回 false 中断请求
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
        // 控制器执行后、视图渲染前处理（如修改 Model 数据）
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        // 请求完成后处理（如资源清理）
    }
}
  1. 注册拦截器
    通过 WebMvcConfigurer 的 addInterceptors 方法配置：
@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new AuthInterceptor())
                .addPathPatterns("/api/**")     // 拦截路径
                .excludePathPatterns("/login"); // 排除路径
    }
}

三、拦截器的执行顺序

假设注册了 Interceptor1 和 Interceptor2：

  1. preHandle 方法：按注册顺序执行（Interceptor1 → Interceptor2）。
  2. postHandle 方法：按注册逆序执行（Interceptor2 → Interceptor1）。
  3. afterCompletion 方法：按注册逆序执行（Interceptor2 → Interceptor1）。

中断场景：若某一拦截器的 preHandle 返回 false，后续拦截器和控制器均不执行，但已通过 preHandle 的拦截器的 afterCompletion 仍会执行。

四、典型应用场景

  1. 权限校验
    在 preHandle 中检查用户登录状态或角色权限，拒绝非法请求。

    if (request.getSession().getAttribute("user") == null) {
    response.sendRedirect("/login");
    return false;
}

  2. 日志记录
    记录请求路径、参数、耗时等信息：

    long startTime = System.currentTimeMillis();
request.setAttribute("startTime", startTime);
// 在 afterCompletion 中计算耗时

  3. 性能监控
    统计接口响应时间，优化慢请求。

  4. 数据预处理
    在 postHandle 中统一添加响应头或加密敏感数据。

五、注意事项与最佳实践

性能优化

常见问题排查

与 AOP 结合

六、完整示例

  1. 日志拦截器
public class LogInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        System.out.println("请求开始: " + request.getRequestURI());
        return true;
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        System.out.println("请求完成: " + request.getRequestURI());
    }
}
  1. 配置类
@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LogInterceptor()).addPathPatterns("/**");
        registry.addInterceptor(new AuthInterceptor())
                .addPathPatterns("/admin/**")
                .order(1); // 高优先级
    }
}

总结

Spring Interceptor 是处理请求生命周期横切逻辑的利器，通过灵活配置路径和优先级，可实现权限控制、日志记录等通用功能。结合 preHandle、postHandle 和 afterCompletion 的分阶段处理，能有效提升代码复用性和可维护性。

到此这篇关于spring中Interceptor的使用小结的文章就介绍到这了,更多相关spring Interceptor使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:
阅读全文