手把手教你SpringBoot过滤器N种注册方式

SpringBoot中过滤器(Filter)是一个常用的技术，它可以在执行控制器前或后，对请求或响应进行拦截，完成一些特定的功能，例如安全控制、日志记录和数据的预处理等。在SpringBoot中，有多种方式注册过滤器，下面介绍其中的N种方法：

方式一：通过FilterRegistrationBean注册过滤器

在SpringBoot中，可以通过添加过滤器的FilterRegistrationBean来实现注册过滤器的作用。详细步骤如下：

1. 创建一个过滤器类，例如MyFilter，在该类中实现过滤器的方法doFilter()、init()和destroy()；

public class MyFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("My Filter init...");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        System.out.println("My Filter doFilter begin...");
        chain.doFilter(request, response); //将请求和响应传递给下一个过滤器或控制器
        System.out.println("My Filter doFilter end...");
    }

    @Override
    public void destroy() {
        System.out.println("My Filter destroy...");
    }
}

1. 在SpringBoot应用的配置类中，创建并配置一个FilterRegistrationBean类型的Bean，并将MyFilter作为参数传入该Bean中；

@Configuration
public class WebConfig {

    @Bean
    public FilterRegistrationBean<MyFilter> myFilterRegistration() {
        FilterRegistrationBean<MyFilter> registrationBean = new FilterRegistrationBean<>();
        registrationBean.setFilter(new MyFilter());
        registrationBean.addUrlPatterns("/");
        registrationBean.setOrder(1);
        return registrationBean;
    }
}

其中，addUrlPatterns()方法用于指定过滤器要处理的请求路径，setOrder()方法用于设置过滤器的执行顺序；

方式二：通过@WebFilter注解注册过滤器

在SpringBoot中，可以通过在过滤器类上添加@WebFilter注解来实现注册过滤器的作用。详细步骤如下：

1. 创建一个过滤器类，例如MyFilter，在该类中实现过滤器的方法doFilter()、init()和destroy()；

@WebFilter(filterName = "myFilter2", urlPatterns = "/*")
public class MyFilter2 implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("My Filter2 init...");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        System.out.println("My Filter2 doFilter begin...");
        chain.doFilter(request, response); //将请求和响应传递给下一个过滤器或控制器
        System.out.println("My Filter2 doFilter end...");
    }

    @Override
    public void destroy() {
        System.out.println("My Filter2 destroy...");
    }
}

其中，filterName属性用于指定过滤器的名称，urlPatterns属性用于指定过滤器要处理的请求路径；

1. 添加@ServletComponentScan注解

需要在SpringBootApplication类中加入@ServletComponentScan注解来扫描过滤器类。

@SpringBootApplication
@ServletComponentScan
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

这样，就完成了通过注解注册过滤器的过程。

示例1：使用FilterRegistrationBean注册过滤器

示例代码如下：

@Configuration
public class WebConfig {

    @Bean
    public FilterRegistrationBean<MyFilter> myFilterRegistration() {
        FilterRegistrationBean<MyFilter> registrationBean = new FilterRegistrationBean<>();
        registrationBean.setFilter(new MyFilter());
        registrationBean.addUrlPatterns("/");
        registrationBean.setOrder(1);
        return registrationBean;
    }
}

public class MyController {

    @GetMapping("/")
    public String index() {
        System.out.println("MyController index...");
        return "index";
    }
}

在注册了MyFilter过滤器之后，当请求经过该过滤器时，会在控制台打印如下的日志信息：

"My Filter2 init..."
"My Filter2 doFilter begin..."
"MyController index..."
"My Filter2 doFilter end..."
"My Filter2 destroy..."

示例2：使用@WebFilter注解注册过滤器

示例代码如下：

@WebServlet(name = "myFilter2", urlPatterns = "/*")
public class MyFilter2 implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("My Filter2 init...");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        System.out.println("My Filter2 doFilter begin...");
        chain.doFilter(request, response); //将请求和响应传递给下一个过滤器或控制器
        System.out.println("My Filter2 doFilter end...");
    }

    @Override
    public void destroy() {
        System.out.println("My Filter2 destroy...");
    }
}

public class MyController {

    @GetMapping("/")
    public String index() {
        System.out.println("MyController index...");
        return "index";
    }
}

在添加了@ServletComponentScan注解并创建了MyController控制器之后，当请求经过该过滤器时，也会在控制台打印如下的日志信息：

"My Filter2 init..."
"My Filter2 doFilter begin..."
"MyController index..."
"My Filter2 doFilter end..."
"My Filter2 destroy..."

总结

SpringBoot提供了多种方式注册过滤器，包括通过FilterRegistrationBean注册过滤器、通过@WebFilter注解注册过滤器等。这些注册方式可以根据具体的需求选择使用，例如通过FilterRegistrationBean注册过滤器可以为过滤器指定执行顺序，而通过@WebFilter注解注册过滤器则更加简单方便，适合于小型的项目。