如何在 Spring Boot 中定义 Filter？

baeldung 2024-01-08

1. 概述

在本篇快速教程中，我们将探讨如何在 Spring Boot 中定义自定义过滤器（Filter），并指定它们的调用顺序。

2. 定义过滤器及其调用顺序

首先，我们创建两个过滤器：

• TransactionFilter：用于开启和提交事务
• RequestResponseLoggingFilter：用于记录请求和响应

要创建一个过滤器，只需实现 Filter 接口即可：

@Component
@Order(1)
public class TransactionFilter implements Filter {

    @Override
    public void doFilter(
      ServletRequest request, 
      ServletResponse response, 
      FilterChain chain) throws ServletException {
 
        HttpServletRequest req = (HttpServletRequest) request;
        LOG.info(
          "Starting a transaction for req : {}", 
          req.getRequestURI());
 
        chain.doFilter(request, response);
        LOG.info(
          "Committing a transaction for req : {}", 
          req.getRequestURI());
    }

    // 其他方法...
}

@Component
@Order(2)
public class RequestResponseLoggingFilter implements Filter {

    @Override
    public void doFilter(
      ServletRequest request, 
      ServletResponse response, 
      FilterChain chain) throws ServletException {
 
        HttpServletRequest req = (HttpServletRequest) request;
        HttpServletResponse res = (HttpServletResponse) response;
        LOG.info(
          "Logging Request  {} : {}", req.getMethod(), 
          req.getRequestURI());
        chain.doFilter(request, response);
        LOG.info(
          "Logging Response :{}", 
          res.getContentType());
    }

    // 其他方法...
}

为了让 Spring 能够识别该过滤器，我们需要使用 @Component 注解将其声明为 Spring Bean。

此外，为了确保过滤器按照正确的顺序执行，我们需要使用 @Order 注解来指定优先级（数值越小，优先级越高）。

2.1 基于 URL 模式的过滤器

在上述示例中，我们的过滤器默认会应用于应用程序中的所有 URL。但有时我们可能希望某个过滤器仅作用于特定的 URL 模式。

此时，我们需要从过滤器类中移除 @Component 注解，并通过 FilterRegistrationBean 来注册该过滤器：

@Bean
public FilterRegistrationBean<RequestResponseLoggingFilter> loggingFilter(){
    FilterRegistrationBean<RequestResponseLoggingFilter> registrationBean 
      = new FilterRegistrationBean<>();
        
    registrationBean.setFilter(new RequestResponseLoggingFilter());
    registrationBean.addUrlPatterns("/users/*");
    registrationBean.setOrder(2);
        
    return registrationBean;    
}

注意：在这种情况下，我们必须显式地通过 setOrder() 方法设置执行顺序。

现在，该过滤器将仅对匹配 /users/* 模式的路径生效。

要为过滤器设置 URL 模式，可以使用 addUrlPatterns() 或 setUrlPatterns() 方法。

3. 快速示例

现在我们创建一个简单的端点，并向其发送 HTTP 请求：

@RestController
@RequestMapping("/users")
public class UserController {
    
    @GetMapping()
    public List<User> getAllUsers() {
        // ...
    }
}

调用该 API 时，应用日志如下所示：

23:54:38 INFO  com.spring.demo.TransactionFilter - Starting Transaction for req :/users
23:54:38 INFO  c.s.d.RequestResponseLoggingFilter - Logging Request  GET : /users
...
23:54:38 INFO  c.s.d.RequestResponseLoggingFilter - Logging Response :application/json;charset=UTF-8
23:54:38 INFO  com.spring.demo.TransactionFilter - Committing Transaction for req :/users

这证实了过滤器确实按照我们期望的顺序被调用了。

4. 结论

在本文中，我们简要总结了如何在 Spring Boot Web 应用程序中定义自定义过滤器。