Filter和Interceptor详解(一文了解执行阶段及其流程)

news2025/5/29 7:23:56

Filter和Interceptor的区别

Filter(过滤器)和 Interceptor(拦截器)都是用于在请求处理前后插入额外逻辑的组件,下面依次介绍,并额外介绍Spring Gateway的过滤器(GlobalFilter/GatewayFilter)和Spring Security的过滤器(SecurityFilter

过滤器(Filter)

基本概念

  • 所属规范Java Servlet 规范(javax.servlet.Filter),只依赖于servlet,不需要依赖spring框架

  • 作用层级Web 容器层(Tomcat/Jetty 等)。

  • 拦截范围:所有 HTTP 请求(包括静态资源、JSP、Controller 等)。

  • 执行时机:在请求进入 DispatcherServlet 之前执行。

    HTTP Request → Tomcat → Filter1 → Filter2 → ... → DispatcherServlet → Interceptor → Controller
    

核心方法

public interface Filter {
    void init(FilterConfig filterConfig);  // 初始化
    void doFilter(ServletRequest request, ServletResponse response, FilterChain chain);  // 核心逻辑
    void destroy();  // 销毁
}

init(FilterConfig filterConfig)

  • 在过滤器实例被创建后由容器调用一次。
  • 用于读取配置参数、初始化资源。

doFilter(ServletRequest request, ServletResponse response, FilterChain chain)

  • 每次请求都会调用。
  • 可在调用 chain.doFilter() 前后添加逻辑:
    • chain.doFilter(request, response) 表示放行,进入下一个过滤器或目标资源(如 Servlet)。
    • 可以在放行前做请求预处理,放行后做响应后处理

destroy()

  • 服务器关闭或过滤器被移除前调用。
  • 用于释放资源。

自定义Filter

springboot项目中为例自定义日志Filter

public class LogFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) {
        System.out.println("LogFilter 初始化");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)throws IOException, ServletException {

        HttpServletRequest req = (HttpServletRequest) request;
        String path = req.getRequestURI();
        String ip = request.getRemoteAddr();

        long start = System.currentTimeMillis();
        System.out.println("[LogFilter] 请求路径: " + path + ", 来自 IP: " + ip);

        chain.doFilter(request, response); // 放行

        long duration = System.currentTimeMillis() - start;
        System.out.println("[LogFilter] 请求耗时: " + duration + " ms");
    }

    @Override
    public void destroy() {
        System.out.println("LogFilter 销毁");
    }
}


@Configuration
public class FilterConfig {

    @Bean
    public FilterRegistrationBean<LogFilter> logFilterRegistration() {
        FilterRegistrationBean<LogFilter> registration = new FilterRegistrationBean<>();
        registration.setFilter(new LogFilter());
        registration.addUrlPatterns("/*");         // 过滤所有请求
        registration.setName("logFilter");
        registration.setOrder(1);                  // 优先级,值越小越优先
        return registration;
    }
}

FilterRegistrationBean 是 Spring Boot 提供的一个工具类,用于在代码中显式注册一个自定义 Filter,而不依赖 @WebFilterweb.xml。它封装了 Filter 的注册信息,允许你控制:

  • 注册的 URL 路径(addUrlPatterns
  • 执行顺序(setOrder
  • 是否启用(setEnabled
  • 初始化参数(addInitParameter

拦截器(Interceptor)

基本概念

  • 所属框架:Spring MVC(HandlerInterceptor)。

  • 作用层级:Spring 框架层(仅拦截 Controller 请求)。

  • 拦截范围仅拦截 @RequestMapping 方法,不拦截静态资源。

  • 执行时机:在 DispatcherServlet 之后、Controller 之前执行。

    HTTP Request → DispatcherServlet → Interceptor.preHandle() → Controller → Interceptor.postHandle() → 视图渲染 → Interceptor.afterCompletion()
    

核心方法

public interface HandlerInterceptor {
    boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler);  // Controller 前执行
    void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView);  // Controller 后执行
    void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex);  // 请求完成后执行
}

preHandle

  • 时机: 在 Controller 的方法调用之前执行。
  • 返回值:
    • 返回 true:继续流程(如调用下一个拦截器或 Controller 方法)。
    • 返回 false:中断流程,请求不会传到 Controller。
  • 常见用途: 登录校验、权限验证、请求签名校验等。

postHandle

  • 时机: Controller 方法执行之后,视图渲染之前执行。
  • 作用: 可以修改 ModelAndView 中的数据或视图。

afterCompletion

  • 时机: 整个请求完成后(包括视图渲染后)执行。
  • 作用: 用于资源清理、日志记录、异常处理等。
  • 总会调用,除非服务器崩溃。

自定义Interceptor

// 实现 HandlerInterceptor
public class AuthInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        System.out.println("Interceptor: 请求前校验");
        return true; // true=放行,false=拦截
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, 
            Object handler, ModelAndView modelAndView) {
        System.out.println("Interceptor: 控制器执行后,视图渲染前");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, 
            Object handler, Exception ex) {
        System.out.println("Interceptor: 请求完成后(视图渲染完毕)");
    }
}

// 注册 Interceptor
@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new AuthInterceptor())
                .addPathPatterns("/api/**"); // 拦截 /api 开头的路径
    }
}

addInterceptors 是 Spring Boot 中用于注册自定义拦截器的方法,定义在 WebMvcConfigurer 接口中。

  • addInterceptor:注册你的拦截器实例
  • addPathPatterns:指定哪些 URL 会被拦截(支持通配符,如 /** 表示全部)
  • excludePathPatterns:指定哪些 URL 不被拦截

应用场景

Filter:(适用请求前统一处理)

  • 请求/响应预处理:修改请求头、请求体或响应头、响应体
  • 编码设置:统一设置请求和响应的字符编码
  • 跨域处理:添加 CORS 相关头信息
  • 登录验证:简单的身份验证(但不如Interceptor灵活)
  • 日志记录:记录原始请求信息
  • 静态资源过滤:对特定文件类型进行特殊处理
  • 数据压缩:对响应内容进行压缩

Interceptor(适用controller前后业务逻辑)

  • 业务逻辑拦截:如权限验证、操作日志记录
  • 用户认证:更细粒度的权限控制(如基于角色的访问控制)
  • 性能监控:记录方法执行时间
  • 参数校验:对Controller方法的参数进行校验
  • AOP功能:实现类似面向切面编程的功能

执行顺序

若有两个filter和两个interceptor,执行顺序如下,Filter.before是指放行前处理,Filter.after是指放行后处理。

Request →
  Filter1.before →
    Filter2.before →
      InterceptorA.preHandle →
        InterceptorB.preHandle →
          Controller →
        InterceptorB.postHandle →
      InterceptorA.postHandle →
    InterceptorB.afterCompletion →
  InterceptorA.afterCompletion →
Filter2.after →
Filter1.after →
Response ←

Spring Cloud Gateway

基本概念

  • 所属框架Spring Cloud Gateway,基于 WebFlux 的过滤器链(非 Servlet 体系)。

    WebFluxSpring Framework 5 引入的一个全新基于 Reactor 构建响应式编程框架,用于构建非阻塞、异步的 Web 应用程序。它是 Spring MVC 的补充,特别适合需要高并发、低延迟的场景(如实时数据处理、流式 API 或 I/O 密集型应用)。

  • 作用层级:API 网关层(在请求到达微服务前)。

  • 拦截范围:所有经过 Gateway 的请求(可路由到不同服务)。

  • 执行时机:在请求被转发到目标服务前执行。

    HTTP Request → WebFlux 底层 → GlobalFilter1 → GlobalFilter2 → GatewayFilter → 路由转发到目标服务
    
  • 过滤器类型

    • GlobalFilter:全局过滤器,对所有路由生效。
    • GatewayFilter:针对特定路由的过滤器。需要在路由规则中显式声明(通过 filters 字段)。
  • 特点

    • 非阻塞(基于 Reactor 模型)。
    • 可修改请求/响应(如添加 Header、重定向)。

核心接口

public interface GlobalFilter {
    Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}
  • ServerWebExchange exchange:封装了 HTTP 请求和响应的信息。
  • GatewayFilterChain chain:用于将请求传递给下一个过滤器。

自定义GatewayFilter

@Component
public class MyGlobalFilter implements GlobalFilter, Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 请求前逻辑
        System.out.println(">>> 请求路径:" + exchange.getRequest().getURI());

        return chain.filter(exchange).then(Mono.fromRunnable(() -> {
            // 响应后逻辑
            System.out.println("<<< 响应状态码:" + exchange.getResponse().getStatusCode());
        }));
    }

    @Override
    public int getOrder() {
        return 0; // 数值越小,优先级越高
    }
}

Spring Security

基本概念

  • 所属框架Spring Security,基于 Servlet 过滤器链FilterChainProxy)。

  • 作用层级:应用安全层(在请求到达 Controller 前)。

  • 拦截范围:所有进入 Spring MVC 的请求(可配置忽略静态资源)。

  • 执行时机:在 DispatcherServlet 之前

    HTTP Request  → Spring Security 过滤器链 → DispatcherServlet -> Controller
    
  • 特点

    • 阻塞式(基于 Servlet 规范)。
    • 专注于认证(Authentication)和授权(Authorization)。

核心过滤器链

Spring Security 的过滤器链(FilterChainProxy)包含多个 核心过滤器,例如:

过滤器类说明
SecurityContextPersistenceFilter加载与保存 SecurityContext
UsernamePasswordAuthenticationFilter表单登录认证
BasicAuthenticationFilterHTTP Basic 认证
BearerTokenAuthenticationFilterBearer Token(如 OAuth2 或 JWT)认证
ExceptionTranslationFilter处理认证异常和权限异常
FilterSecurityInterceptor最终权限校验逻辑
CsrfFilterCSRF 防护
LogoutFilter处理退出登录
AuthorizationFilter授权过滤器(Spring Security 6 引入)

如何使用这些核心过滤器?

@Bean
public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
    return http
        .csrf(csrf -> csrf.disable()) // 配置 CsrfFilter(禁用)
        .authorizeHttpRequests(auth -> auth
            .requestMatchers("/admin/**").hasRole("ADMIN") // 配置 FilterSecurityInterceptor 的权限规则
            .anyRequest().authenticated()
        )
        .formLogin(withDefaults()) // 开启 UsernamePasswordAuthenticationFilter
        .logout(withDefaults())    // 开启 LogoutFilter
        .build();
}
配置语句对应过滤器
csrf().disable()CsrfFilter
authorizeHttpRequests()FilterSecurityInterceptor
formLogin()UsernamePasswordAuthenticationFilter
logout()LogoutFilter

自定义过滤器

推荐继承 OncePerRequestFilter 类,因为 OncePerRequestFilter 可以确保每个请求只被过滤一次。

public class CustomFilter extends OncePerRequestFilter {

    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
            throws ServletException, IOException {
        // 在这里添加自定义逻辑
        System.out.println("CustomFilter is processing the request");

        // 继续执行过滤器链
        filterChain.doFilter(request, response);
    }
}


@Configuration
public class SecurityConfig {

    @Bean
    public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
        http
            .authorizeHttpRequests()
            .anyRequest().authenticated()
            .and()
            .addFilterBefore(new CustomFilter(), UsernamePasswordAuthenticationFilter.class); // 在UsernamePasswordAuthenticationFilter 之前添加自定义过滤器

        return http.build();
    }
}

执行流程总览

如果一个项目中集成了Spring Cloud GatewaySpring Security

Servlet FilterInterceptorSpring Gateway FilterSpring Security FilterChain的执行顺序

HTTP Request
    ├─ 0. 进入网关服务
    │
    ├─ 1. Spring Gateway Filter(GlobalFilter/GatewayFilter)
    │
    ├─ 2. Spring Security FilterChain(SecurityFilter)
    │
    ├─ 3. 路由转发到目标服务
    │
    ├─ 4. Servlet Filter(如 CharacterEncodingFilter)
    │
    ├─ 5. DispatcherServlet(Spring MVC 入口)
    │
    ├─ 6. HandlerInterceptor(preHandle)
    │
    ├─ 7. Controller 方法
    │
    ├─ 8. HandlerInterceptor(postHandle)
    │
    ├─ 9. 视图渲染(如 Thymeleaf)
    │
    └─ 10. HandlerInterceptor(afterCompletion)

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2387215.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

鸿蒙仓颉开发语言实战教程:实现商城应用详情页

昨天有朋友提到鸿蒙既然有了ArkTs开发语言&#xff0c;为什么还需要仓颉开发语言。其实这个不难理解&#xff0c;安卓有Java和Kotlin&#xff0c;iOS先后推出了Objective-C和Swift&#xff0c;鸿蒙有两种开发语言也就不奇怪了。而且仓颉是比ArkTs更加灵活的语言&#xff0c;虽然…

GitAny - 無需登入的 GitHub 最新倉庫檢索工具

地址&#xff1a;https://github.com/MartinxMax/gitany GitAny - 無需登入的 GitHub 專案搜尋工具 GitAny 是一款基於 Python 的工具&#xff0c;允許你在無需登入的情況下搜尋當天最新的 GitHub 專案。它支援模糊搜尋、條件篩選以及倉庫資料的視覺化分析。 安裝依賴 $ pip…

在飞牛nas系统上部署gitlab

在飞牛nas系统上部署gitlab需要使用docker进行部署&#xff0c;如下将介绍详细的部署流程。 文章目录 1. docker镜像2. 拉取镜像3. 运行容器4. 运行和访问gitlab5. 一些小配置5.1 url问题5.2 ssh端口5.3 其他配置 1. docker镜像 首先需要找一个gitlab的docker镜像地址&#x…

深入理解 Redis 哨兵模式

Redis 哨兵模式深度解析&#xff1a;从原理到实践的全流程指南 在分布式系统架构中&#xff0c;Redis 作为高性能的内存数据库&#xff0c;其哨兵模式&#xff08;Sentinel&#xff09;是保障服务高可用性的核心方案。本文将从基础概念、运行机制出发&#xff0c;结合具体配置…

[特殊字符]《Qt实战:基于QCustomPlot的装药燃面动态曲线绘制(附右键菜单/样式美化/完整源码)》

1、将qcustomplot.cpp qcustomplot.h放入工程目录下引入qcustomplot 2、代码 .h #if defined(_MSC_VER) #pragma execution_character_set(

力扣-最大连续一的个数

1.题目描述 2.题目链接 1004. 最大连续1的个数 III - 力扣&#xff08;LeetCode&#xff09; 3.代码解答 class Solution {public int longestOnes(int[] nums, int k) {int zero0,length0;for(int left0,right0;right<nums.length;right){if(nums[right]0){zero;}while…

无人机避障——深蓝学院浙大栅格地图以及ESDF地图内容

Occupancy Grid Map & Euclidean Signed Distance Field: 【注意】&#xff1a;目的是为了将有噪声的传感器收集起来&#xff0c;用于实时的建图。 Occupancy Grid Map&#xff1a; 概率栅格&#xff1a; 【注意】&#xff1a;由于传感器带有噪声&#xff0c;在实际中基于…

Postman基础操作

1.Postman是什么&#xff1f; Postman是接口测试的工具&#xff0c;简单来说它能模拟浏览器对服务器的某个接口发起请求并接收响应数据。 1.1 Postman工作原理 2.Postman发送请求 2.1 发送GET请求 我们知道GET请求是没用请求体的&#xff0c;所以我们需要将请求参数写在Param…

【MPC控制 - 从ACC到自动驾驶】3 MPC控制器设计原理与参数配置:打造ACC的“最强大脑”

【MPC控制 - 从ACC到自动驾驶】MPC控制器设计原理与参数配置&#xff1a;打造ACC的“最强大脑” 在Day 1&#xff0c;我们认识了ACC自适应巡航和MPC这位“深谋远虑的棋手”。Day 2&#xff0c;我们一起给汽车“画像”&#xff0c;建立了它的纵向动力学模型&#xff0c;并把它翻…

Unity3D仿星露谷物语开发52之菜单页面

1、目标 创建菜单页面&#xff0c;可通过Esc键开启或关闭。 当把鼠标悬停在上面时它会高亮&#xff0c;然后当点击按钮时标签页会被选择。 2、 创建PauseMenuCanvas &#xff08;1&#xff09;创建Canvas 在Hierarchy -> PersistentScene -> UI下创建新的Cavans命名为…

MySQL——复合查询表的内外连

目录 复合查询 回顾基本查询 多表查询 自连接 子查询 where 字句中使用子查询 单行子查询 多行子查询 多列子查询 from 字句中使用子查询 合并查询 实战OJ 查找所有员工入职时候的薪水情况 获取所有非manager的员工emp_no 获取所有员工当前的manager 表的内外…

小米玄戒O1架构深度解析(一):十核异构设计与缓存层次详解

前言 这两天&#xff0c;小米的全新SOC玄戒O1横空出世&#xff0c;引发了科技数码圈的一次小地震&#xff0c;那么小米的这颗所谓的自研SOC&#xff0c;内部究竟有着什么不为人知的秘密呢&#xff1f;我们一起一探究竟。 目录 前言1 架构总览1.1 基本构成1.2 SLC缺席的原因探…

[免费]微信小程序宠物医院管理系统(uni-app+SpringBoot后端+Vue管理端)【论文+源码+SQL脚本】

大家好&#xff0c;我是java1234_小锋老师&#xff0c;看到一个不错的微信小程序宠物医院管理系统(uni-appSpringBoot后端Vue管理端)&#xff0c;分享下哈。 项目视频演示 【免费】微信小程序宠物医院管理系统(uni-appSpringBoot后端Vue管理端) Java毕业设计_哔哩哔哩_bilibi…

ETL 工具与数据中台的关系与区别

ETL 工具和数据中台作为数据处理领域的关键概念&#xff0c;虽然存在一定的关联&#xff0c;但二者有着明显的区别。本文将深入剖析 ETL 工具与数据中台之不同。 一、ETL 工具概述 ETL 是数据仓库技术中的核心技术之一&#xff0c;其全称为 Extract&#xff08;抽取&#xff…

SQLMesh Typed Macros:让SQL宏更强大、更安全、更易维护

在SQL开发中&#xff0c;宏&#xff08;Macros&#xff09;是一种强大的工具&#xff0c;可以封装重复逻辑&#xff0c;提高代码复用性。然而&#xff0c;传统的SQL宏往往缺乏类型安全&#xff0c;容易导致运行时错误&#xff0c;且难以维护。SQLMesh 引入了 Typed Macros&…

Docker 使用镜像[SpringBoot之Docker实战系列] - 第537篇

历史文章&#xff08;文章累计530&#xff09; 《国内最全的Spring Boot系列之一》 《国内最全的Spring Boot系列之二》 《国内最全的Spring Boot系列之三》 《国内最全的Spring Boot系列之四》 《国内最全的Spring Boot系列之五》 《国内最全的Spring Boot系列之六》 《…

解锁MCP:AI大模型的万能工具箱

摘要&#xff1a;MCP&#xff08;Model Context Protocol&#xff0c;模型上下文协议&#xff09;是由Anthropic开源发布的一项技术&#xff0c;旨在作为AI大模型与外部数据和工具之间沟通的“通用语言”。它通过标准化协议&#xff0c;让大模型能够自动调用外部工具完成任务&a…

Error in beforeDestroy hook: “Error: [ElementForm]unpected width “

使用 element 的 form 时候报错&#xff1a; vue.runtime.esm.js:3065 Error: [ElementForm]unpected width at VueComponent.getLabelWidthIndex (element-ui.common.js:23268:1) at VueComponent.deregisterLabelWidth (element-ui.common.js:23281:1) at Vue…

私有知识库 Coco AI 实战(七):摄入本地 PDF 文件

是否有些本地文件要检索&#xff1f;没问题。我们先对 PDF 类的文件进行处理&#xff0c;其他的文件往后稍。 Coco Server Token 创建一个 token 备用。 PDF_Reader 直接写个 python 程序解析 PDF 内容&#xff0c;上传到 Coco Server 就行了。还记得以前都是直接写入 Coco …

【Unity3D】将自动生成的脚本包含到C#工程文件中

我们知道&#xff0c;在用C#开发中&#xff0c;通过vs编辑器新建的脚本&#xff0c;会自动包含到vs工程中&#xff0c;而通过外部创建&#xff0c;比如复制别的工程或代码创建的C#脚本不会包含到vs工程。 在我们的日常开发中&#xff0c;通常会自动创建C#脚本&#xff0c;特别…