如何定义 Spring Boot 过滤器？

我就是我 2023-09-27 08:36 150阅读 0赞

### **1. 概述** ###

在这个快速教程中，我们将探索如何在 Spring Boot 的帮助下定义自定义过滤器并指定它们的调用顺序。

### **2. 定义过滤器和调用顺序** ###

让我们从创建两个过滤器开始：

1.  *TransactionFilter* – 启动和提交事务
2.  *RequestResponseLoggingFilter* – 记录请求和响应

为了创建过滤器，我们只需要实现*Filter*接口：

@Component
    @Order(1)
    public class TransactionFilter implements Filter {
    
        @Override
        public void doFilter(
          ServletRequest request, 
          ServletResponse response, 
          FilterChain chain) throws IOException, 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());
        }
    
        // other methods 
    }

@Component
    @Order(2)
    public class RequestResponseLoggingFilter implements Filter {
    
        @Override
        public void doFilter(
          ServletRequest request, 
          ServletResponse response, 
          FilterChain chain) throws IOException, 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());
        }
    
        // other methods
    }

为了让 Spring 识别过滤器，我们需要将其定义为带有*@Component*注解的 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 webapp 中定义自定义过滤器。

与往常一样，可以[在 GitHub 上][GitHub]找到代码片段。

[GitHub]: https://github.com/eugenp/tutorials/tree/master/spring-boot-modules/spring-boot-basic-customization