关于@webFilter使用@Order无效问题

深藏阁楼爱情的钟 2021-06-10 20:38 418阅读 0赞

## 正确设置排序方式 ##

> 利用`FilterRegistrationBean`可以设置排序顺序。那是否还有其他方式呢。有的，只是这种方案不是很优雅。这里简单说明下。

**先说结论：可以通过`过滤器`的类名进行约定排序。**

## 浅谈ServletComponentScan注解的启动方式 ##

> 既然遇到了，那就简单分析下使用`@WebFilter`和`@ServletComponentScan`的启动方式吧。

首先我们来看下，注解`@ServletComponentScan`(删除了相关注解):

@Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Import(ServletComponentScanRegistrar.class)
    public @interface ServletComponentScan {
    
        @AliasFor("basePackages")
        String[] value() default {};
    
        @AliasFor("value")
        String[] basePackages() default {};
    
        Class<?>[] basePackageClasses() default {};
    
    }

简单来说，此注解就是指定扫描路径的，通过`value`、`basePackages`或者`basePackageClasses`。主要还是看下`ServletComponentScanRegistrar`类，这才是关键。

class ServletComponentScanRegistrar implements ImportBeanDefinitionRegistrar {
    
        private static final String BEAN_NAME = "servletComponentRegisteringPostProcessor";
    
        @Override
        public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
            // 获取包路径
            Set<String> packagesToScan = getPackagesToScan(importingClassMetadata);
            // 若已注册，则更新，否则新增
            if (registry.containsBeanDefinition(BEAN_NAME)) {
                updatePostProcessor(registry, packagesToScan);
            } else {
                addPostProcessor(registry, packagesToScan);
            }
        }
    
        private void updatePostProcessor(BeanDefinitionRegistry registry, Set<String> packagesToScan) {
            BeanDefinition definition = registry.getBeanDefinition(BEAN_NAME);
            ValueHolder constructorArguments = definition.getConstructorArgumentValues().getGenericArgumentValue(Set.class);
            @SuppressWarnings("unchecked")
            Set<String> mergedPackages = (Set<String>) constructorArguments.getValue();
            mergedPackages.addAll(packagesToScan);
            constructorArguments.setValue(mergedPackages);
        }
    
        private void addPostProcessor(BeanDefinitionRegistry registry, Set<String> packagesToScan) {
            GenericBeanDefinition beanDefinition = new GenericBeanDefinition();
            // 设置类
            beanDefinition.setBeanClass(ServletComponentRegisteringPostProcessor.class);
            // 设置构造函数参数
            beanDefinition.getConstructorArgumentValues().addGenericArgumentValue(packagesToScan);
            beanDefinition.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
            // 注册
            registry.registerBeanDefinition(BEAN_NAME, beanDefinition);
        }
    
        private Set<String> getPackagesToScan(AnnotationMetadata metadata) {
            // 获取注解ServletComponentScan的属性信息
            AnnotationAttributes attributes = AnnotationAttributes
                    .fromMap(metadata.getAnnotationAttributes(ServletComponentScan.class.getName()));
            // 获取属性basePackages和basePackageClasses
            String[] basePackages = attributes.getStringArray("basePackages");
            Class<?>[] basePackageClasses = attributes.getClassArray("basePackageClasses");
            Set<String> packagesToScan = new LinkedHashSet<String>();
            packagesToScan.addAll(Arrays.asList(basePackages));
            // basePackageClasses 最后也是根据basePackageClasses来获取塔对应的包路径
            for (Class<?> basePackageClass : basePackageClasses) {
                packagesToScan.add(ClassUtils.getPackageName(basePackageClass));
            }
            // 默认不填写时，获取的是被注解类所在包路径，所以一般放在启动类上
            if (packagesToScan.isEmpty()) {
                packagesToScan.add(ClassUtils.getPackageName(metadata.getClassName()));
            }
            return packagesToScan;
        }
    }

可以看见，它是一个`ImportBeanDefinitionRegistrar`的实现类，`ImportBeanDefinitionRegistrar`可以动态地装载`Bean`。再来看看`ServletComponentRegisteringPostProcessor`类，此类是个`BeanFactoryPostProcessor`，BeanFactory的后置处理器，简单理解就是扩展点吧。启动的时候会调用`postProcessBeanFactory`方法。  
`ServletComponentRegisteringPostProcessor`源码就不贴了，简单来说，它的作用就是：扫描被`@WebServlet`、`@WebFilter`及`@WebListener`的类，最后通过对应的`ServletRegistrationBean`、`FilterRegistrationBean`及`ServletListenerRegistrationBean`进行注册。看见这些是不是很熟悉了。

//部分代码
        static {
            List<ServletComponentHandler> servletComponentHandlers = new ArrayList<ServletComponentHandler>();
            servletComponentHandlers.add(new WebServletHandler());
            servletComponentHandlers.add(new WebFilterHandler());
            servletComponentHandlers.add(new WebListenerHandler());
            HANDLERS = Collections.unmodifiableList(servletComponentHandlers);
        }

关键看这个方法`scanPackage`:

private void scanPackage(
                ClassPathScanningCandidateComponentProvider componentProvider,
                String packageToScan) {
            for (BeanDefinition candidate : componentProvider
                    .findCandidateComponents(packageToScan)) {
                if (candidate instanceof ScannedGenericBeanDefinition) {
                    for (ServletComponentHandler handler : HANDLERS) {
                        handler.handle(((ScannedGenericBeanDefinition) candidate),
                                (BeanDefinitionRegistry) this.applicationContext);
                    }
                }
            }
        }

可以看见，通过`componentProvider.findCandidateComponents(packageToScan)`方法获取到对应的注解类，同时判断是否为以上说的三种，最后调用其`doHandle`方法完成注册功能。以下是`WebFilterHandler`的`doHandler`方法。

![WebFilterHandler][]

现在，我们看看`findCandidateComponents`方法怎么获取对应注解类的。

![findCandidateComponents][]

断点之后，可以看见是`AnnotationConfigEmbeddedWebApplicationContext`类，

![format_png][]

继续断点进去，最后是使用`PathMatchingResourcePatternResolver`类进行资源获取的。

![format_png 1][]

通过递归的方式，获取所有的类：  
![format_png 2][]

最后关键就是这个`Arrays.sort(dirContents)`了。所以简单来说，可以通过class类名来达到排序效果。但这种方案要限制类名，还是使用`FilterRegistrationBean`之类的来设置吧。

## 总结 ##

> 写的可能有点乱也有点水，⊙﹏⊙‖∣。主要还是想纠正下原先的错误，O\_\_O…。**知其然知其所以然，还有很长的路要走。没有写里面的细节，只是大致讲解了下。有兴趣的可以自行跟踪看看。**

## 最后 ##

> 目前互联网上很多大佬都有`SpringBoot`系列教程，如有雷同，请多多包涵了。**原创不易，码字不易**，还希望大家多多支持。若文中有所错误之处，还望提出，谢谢。

[WebFilterHandler]: /images/20210527/f66877b183c1456d87ce873cc822d7a7.png
[findCandidateComponents]: /images/20210527/47ca0c82a96d4d0ca9fa3fb2d1a0d147.png
[format_png]: /images/20210527/015c046eac5145c0aa433f9d43ffa49c.png
[format_png 1]: /images/20210527/49ea243697e94e52ba2e6226b54d5edc.png
[format_png 2]: /images/20210527/b60e8d39ad1b4c72a256e402ddc6d298.png