關於@webFilter使用@Order無效問題

本文轉載自查看原文 2018-08-26 17:58 3885 日常積累/ springboot

前言

在SpringBoot系列文章的《第七章：過濾器、監聽器、攔截器》中，小技巧中指出，可使用@Order設置過濾器的執行順序。由於沒有自己求證過，看了相關材料后，想當然的寫進了文章中，這個進行更正下。

通過過濾器名稱和設置@Order的方法都是不行的。抱歉了，各位。之后在編寫文章時，會本着負責且持着大膽猜測小心求證的態度，會對相關事項進行核對的！再次，抱歉，誤導了大家

這里要感謝簡書網友：形而上學本尊，指出此錯誤！再次感謝！

正確設置排序方式
淺談ServletComponentScan注解的啟動方式
總結
最后
老生常談

正確設置排序方式

《第七章：過濾器、監聽器、攔截器》也有指出，利用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