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

時間 2019-11-06

標籤關於 webfilter 使用 order 無效問題简体版

原文原文鏈接

前言

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

經過過濾器名稱和設置@Order的方法都是不行的。抱歉了，各位。以後在編寫文章時，會本着負責且持着大膽猜想當心求證的態度，會對相關事項進行覈對的！再次，抱歉，誤導了你們web

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

正確設置排序方式

《第七章：過濾器、監聽器、攔截器》也有指出，利用FilterRegistrationBean能夠設置排序順序。那是否還有其餘方式呢。有的，只是這種方案不是很優雅。這裏簡單說明下。springboot

先說結論：能夠經過過濾器的類名進行約定排序。微信

淺談ServletComponentScan註解的啓動方式

既然遇到了，那就簡單分析下使用@WebFilter和@ServletComponentScan的啓動方式吧。app

首先咱們來看下，註解@ServletComponentScan(刪除了相關注解):ide

@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進行註冊。看見這些是否是很熟悉了。post

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

關鍵看這個方法scanPackage:this

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方法。