Spring Boot 中 Filter 的核心机制与实践指南
在 Web 应用程序中，开发者常常需要在请求到达控制器前或响应返回客户端前执行某些通用任务，如日志记录、身份认证、跨域配置等。Filter 是完成这类任务的重要机制。
一、Filter 概述
Filter 属于 Java Servlet 规范的一部分，运行于 Web 容器中，能够在请求传递至目标资源前后实施拦截与处理。
常见的应用场景包括：
- 访问日志输出
- 安全认证校验
- XSS 攻击防护
- CORS 跨域策略设置
- 响应内容压缩（如 GZIP）
二、Spring Boot 中使用 Filter 的方法
1. 利用 @WebFilter 和 @ServletComponentScan
这是一种标准 Servlet 方式，适用于简单场景。
@WebFilter(filterName = "requestTraceFilter", urlPatterns = "/*")
public class RequestTraceFilter implements Filter {
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
System.out.println("请求开始处理");
chain.doFilter(request, response);
System.out.println("响应已返回");
}
}
在主启动类上添加扫描注解：
@SpringBootApplication
@ServletComponentScan
public class MyApplication {
public static void main(String[] args) {
SpringApplication.run(MyApplication.class, args);
}
}
2. 使用 @Bean 注册 Filter（推荐做法）
该方式具备更高的灵活性，并且能更好地集成到 Spring 上下文中。
@Configuration
public class WebFilterConfig {
@Bean
public FilterRegistrationBean<RequestTraceFilter> loggingFilter() {
FilterRegistrationBean<RequestTraceFilter> filterReg = new FilterRegistrationBean<>();
filterReg.setFilter(new RequestTraceFilter());
filterReg.addUrlPatterns("/*");
filterReg.setOrder(2); // 数字越小优先级越高
return filterReg;
}
}
三、控制 Filter 执行顺序
当存在多个 Filter 时，可通过 FilterRegistrationBean 提供的 setOrder() 方法来设定它们的执行顺序。数值较小者将被优先调用。
四、Filter 与 Interceptor 的区别对比
| 特性 | Filter | Interceptor |
|---|---|---|
| 所属体系 | Servlet 规范 | Spring MVC 框架 |
| 作用对象 | 所有 HTTP 请求（含静态资源） | 仅 Controller 层请求 |
| 适用场景 | 统一认证、日志、字符编码等 | 业务前置校验、参数封装等 |
| 生命周期管理 | Servlet 容器负责 | Spring 容器负责 |
| 注册方式 | 注解或注册 Bean | 继承接口并注入 |
五、典型应用示例
1. 记录请求路径信息
public class AccessLogFilter implements Filter {
@Override
public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain)
throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) req;
System.out.println("收到请求：" + request.getRequestURI());
chain.doFilter(req, resp);
}
}
2. 基础 Token 校验逻辑
public class AuthenticationFilter implements Filter {
@Override
public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain)
throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) req;
String authHeader = request.getHeader("Authorization");
if ("secret-key".equals(authHeader)) {
chain.doFilter(req, resp);
} else {
HttpServletResponse response = (HttpServletResponse) resp;
response.setStatus(HttpServletResponse.SC_FORBIDDEN);
response.getWriter().write("无效凭证");
}
}
}
六、总结
Filter 在构建健壮的 Web 应用过程中扮演着关键角色。了解其实现原理及不同注册方式有助于提升系统的可维护性和扩展性。相比 Interceptor，Filter 更贴近底层，适合用于全局性的预处理和后置增强操作。
