添加Filter

我们在Spring中已经学过了集成Filter,本质上就是通过代理,把Spring管理的Bean注册到Servlet容器中,不过步骤比较繁琐,需要配置web.xml

在Spring Boot中,添加一个Filter更简单了,可以做到零配置。我们来看看在Spring Boot中如何添加Filter

Spring Boot会自动扫描所有的FilterRegistrationBean类型的Bean,然后,将它们返回的Filter自动注册到Servlet容器中,无需任何配置。

我们还是以AuthFilter为例,首先编写一个AuthFilterRegistrationBean,它继承自FilterRegistrationBean

  1. @Order(10)
  2. @Component
  3. public class AuthFilterRegistrationBean extends FilterRegistrationBean<Filter> {
  4. @Autowired
  5. UserService userService;
  6. @Override
  7. public Filter getFilter() {
  8. return new AuthFilter();
  9. }
  10. class AuthFilter implements Filter {
  11. ...
  12. }
  13. }

FilterRegistrationBean本身不是Filter,它实际上是Filter的工厂。Spring Boot会调用getFilter(),把返回的Filter注册到Servlet容器中。因为我们可以在FilterRegistrationBean中注入需要的资源,然后,在返回的AuthFilter中,这个内部类可以引用外部类的所有字段,自然也包括注入的UserService,所以,整个过程完全基于Spring的IoC容器完成。

再注意到AuthFilterRegistrationBean标记了一个@Order(10),因为Spring Boot支持给多个Filter排序,数字小的在前面,所以,多个Filter的顺序是可以固定的。

我们再编写一个ApiFilter,专门过滤/api/*这样的URL。首先编写一个ApiFilterRegistrationBean

  1. @Order(20)
  2. @Component
  3. public class ApiFilterRegistrationBean extends FilterRegistrationBean<Filter> {
  4. @PostConstruct
  5. public void init() {
  6. setFilter(new ApiFilter());
  7. setUrlPatterns(List.of("/api/*"));
  8. }
  9. class ApiFilter implements Filter {
  10. ...
  11. }
  12. }

这个ApiFilterRegistrationBeanAuthFilterRegistrationBean又有所不同。因为我们要过滤URL,而不是针对所有URL生效,因此,在@PostConstruct方法中,通过setFilter()设置一个Filter实例后,再调用setUrlPatterns()传入要过滤的URL列表。

练习

添加Filter - 图1下载练习:添加Filter并指定顺序 (推荐使用IDE练习插件快速下载)

小结

在Spring Boot中添加Filter更加方便,并且支持对多个Filter进行排序。

读后有收获可以支付宝请作者喝咖啡,读后有疑问请加微信群讨论:

添加Filter - 图2 添加Filter - 图3