【Java教程】Day23-10 Spring Boot开发：添加Filter

在Spring Boot中，我们可以非常方便地添加过滤器（Filter），而不需要像传统的Spring应用那样繁琐地配置 web.xml。Spring Boot的设计理念是简化配置，减少样板代码，因此它提供了对Filter的自动注册功能，让我们能够在不修改任何配置文件的情况下，轻松添加自定义Filter。

本文将详细介绍如何在Spring Boot中添加Filter，以及如何控制Filter的执行顺序。

---

1. Spring Boot中的Filter基础

在Spring Boot中，Filter的注册和管理变得非常简单。通过FilterRegistrationBean，Spring Boot会自动扫描并注册所有类型为FilterRegistrationBean的Bean，而我们只需要在应用程序中创建一个Filter类并通过FilterRegistrationBean将其注册到Servlet容器中。

1.1 FilterRegistrationBean的作用

FilterRegistrationBean是Spring Boot提供的一个便捷类，它用于注册自定义的Filter。通过该类，我们不仅能定义过滤器，还能指定过滤器的执行顺序和要匹配的URL模式。

2. 编写并注册Filter

2.1 示例：AuthFilter的注册

首先，我们来看看如何注册一个简单的AuthFilter。我们会创建一个AuthFilterRegistrationBean，并将Filter注册到Spring Boot的Servlet容器中。

java@Componentpublic class AuthFilterRegistrationBean extends FilterRegistrationBean<Filter> {        @Autowired    private UserService userService;​    @Override    public Filter getFilter() {        setOrder(10);  // 设置Filter执行顺序，值小的先执行        return new AuthFilter();    }​    class AuthFilter implements Filter {        @Override        public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {            // 这里可以添加认证逻辑            System.out.println("AuthFilter is working");            chain.doFilter(request, response);        }    }}

 

在上面的代码中：

• FilterRegistrationBean继承了Filter接口，用于创建和注册Filter。

• 在getFilter()方法中返回我们自定义的Filter实例（AuthFilter）。

• setOrder(10)指定了过滤器的执行顺序，值越小的Filter越先执行。

2.2 示例：ApiFilter的注册与URL模式匹配

接下来，我们实现一个专门过滤/api/*路径的ApiFilter。我们通过设置URL模式来确保该Filter只会作用于指定的URL。

java@Componentpublic class ApiFilterRegistrationBean extends FilterRegistrationBean<Filter> {​    @PostConstruct    public void init() {        setOrder(20);  // 设置ApiFilter的执行顺序        setFilter(new ApiFilter());        setUrlPatterns(List.of("/api/*"));  // 只匹配/api/*路径    }​    class ApiFilter implements Filter {        @Override        public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {            System.out.println("ApiFilter is filtering /api/*");            chain.doFilter(request, response);        }    }}

 

在ApiFilterRegistrationBean中：

• 通过setFilter()方法设置Filter实例。

• 使用setUrlPatterns(List.of("/api/*"))来指定只拦截/api/*路径的请求。

2.3 自动注册Filter

Spring Boot会自动扫描所有的FilterRegistrationBean类型的Bean，并将返回的Filter注册到Servlet容器中。因此，只要我们将上述的AuthFilterRegistrationBean和ApiFilterRegistrationBean标注为@Component，Spring Boot会自动完成注册。

3. 设置Filter的执行顺序

Spring Boot允许我们控制多个Filter的执行顺序。当我们有多个Filter时，setOrder()方法可以帮助我们决定它们的执行顺序，值小的Filter会先执行。

• setOrder(10)：表示AuthFilter会优先于ApiFilter执行。

• setOrder(20)：ApiFilter会在AuthFilter后执行。

4. 小结

通过FilterRegistrationBean，Spring Boot简化了Filter的注册和配置过程，我们无需再像传统的Spring应用中那样修改web.xml。同时，Spring Boot支持我们为多个Filter指定执行顺序，使得Filter的管理更加灵活。

5. 练习

• 尝试在Spring Boot项目中添加多个Filter，并分别设置它们的执行顺序。

• 实现一个自定义Filter，拦截特定URL路径，并输出日志信息。

 

 

---

 

通过本文的学习，您应该能够在Spring Boot项目中快速添加和配置Filter，并控制它们的执行顺序，从而实现更细粒度的请求处理和过滤。