Spring: OncePerRequestFilter

文章目录

一、介绍
二、使用

一、介绍

OncePerRequestFilter是Spring Boot中的一个过滤器抽象类，它在Spring Security中也得到了广泛的应用。这个过滤器抽象类的主要目的是确保在每次外部请求时只执行一次过滤操作，对于服务器内部之间的forward等请求，则不会再次执行过滤方法。

这个类设计的初衷是为了兼容不同的web容器，因为实际上并非所有的容器都会在一次请求中只过滤一次。Servlet版本的不同也可能导致执行过程的不同。

在具体使用中，可以通过继承OncePerRequestFilter并实现其doFilterInternal方法来定义自己的过滤逻辑。当请求被调度给一个Servlet时，RequestDispatcher可能会将其转发给另一个Servlet，而在这个过程中，由于OncePerRequestFilter的存在，可以确保请求只会被过滤一次。

此外，OncePerRequestFilter还提供了enabled属性，用于控制是否开启该拦截器实例。默认情况下，enabled属性为true，表示拦截器处于开启状态。如果不需要某个拦截器工作，可以将enabled属性设置为false。

总的来说，OncePerRequestFilter在Spring Boot和Spring Security中扮演着重要的角色，它可以帮助我们确保在每次请求时只执行一次过滤操作，从而提高应用的性能和稳定性。

二、使用

在Spring Boot应用程序中，如果你想使用OncePerRequestFilter来拦截和处理HTTP请求，你需要创建一个继承自OncePerRequestFilter的类，并实现doFilterInternal方法。然后，你需要在Spring配置中注册这个过滤器，以便Spring容器能够管理它并将其添加到过滤器链中。

以下是使用OncePerRequestFilter的步骤：

创建自定义过滤器
首先，创建一个新的Java类，让它继承自OncePerRequestFilter，并覆盖doFilterInternal方法。在这个方法中，你可以编写自己的过滤逻辑。

import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.filter.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);  
  }  
```
}
注册自定义过滤器
然后，你需要在Spring配置中注册这个过滤器。这可以通过Java配置或XML配置来完成。在Spring Boot中，通常使用Java配置。

使用Java配置

在你的Spring Boot应用程序中，可以创建一个配置类，并使用@Bean注解来注册你的过滤器。然后，你可以通过实现WebMvcConfigurer接口来添加这个过滤器到Spring的过滤器链中。

复制代码

import org.springframework.beans.factory.annotation.Bean;  
import org.springframework.context.annotation.Configuration;  
import org.springframework.web.filter.OncePerRequestFilter;  
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;  
  
@Configuration  
public class WebConfig implements WebMvcConfigurer {  
  
    @Bean  
    public OncePerRequestFilter customFilter() {  
        return new CustomFilter();  
    }  
  
    @Override  
    public void addFilters(FilterRegistrationBean<?>... filterRegistrationBeans) {  
        // 如果你有其他的FilterRegistrationBean要添加，可以在这里做  
        // 但是对于OncePerRequestFilter，通常不需要手动注册为FilterRegistrationBean  
        // Spring Boot会自动将其添加到过滤器链中  
    }  
  
    // 如果你需要更细粒度的控制（比如指定过滤器的顺序），可以实现FilterRegistrationBean  
    // 并使用addFilterRegistrations方法添加它们  
}

注意：在Spring Boot 2.x及更高版本中，通常不需要实现addFilters或addFilterRegistrations方法，因为Spring Boot会自动检测并注册@Bean定义的过滤器。