spring源码之扫描前设置

扫描前设置 🛹

- 源码
- - 源码说明
  - 总结

启动一个springboot项目

源码

org.springframework.context.annotation.ComponentScanAnnotationParser#parse


public Set<BeanDefinitionHolder> parse(AnnotationAttributes componentScan, String declaringClass) {
    // 创建ClassPathBeanDefinitionScanner，将Bean定义注册到BeanFactory中
    ClassPathBeanDefinitionScanner scanner = new ClassPathBeanDefinitionScanner(this.registry,
        componentScan.getBoolean("useDefaultFilters"), this.environment, this.resourceLoader);

    // 根据组件扫描的注解属性，设置Bean名称生成器
    Class<? extends BeanNameGenerator> generatorClass = componentScan.getClass("nameGenerator");
    boolean useInheritedGenerator = (BeanNameGenerator.class == generatorClass);
    scanner.setBeanNameGenerator(useInheritedGenerator ? this.beanNameGenerator :
        BeanUtils.instantiateClass(generatorClass));

    // 根据组件扫描的注解属性，设置ScopedProxy模式或Scope元数据解析器
    ScopedProxyMode scopedProxyMode = componentScan.getEnum("scopedProxy");
    if (scopedProxyMode != ScopedProxyMode.DEFAULT) {
        scanner.setScopedProxyMode(scopedProxyMode);
    }
    else {
        Class<? extends ScopeMetadataResolver> resolverClass = componentScan.getClass("scopeResolver");
        scanner.setScopeMetadataResolver(BeanUtils.instantiateClass(resolverClass));
    }

    // 根据组件扫描的注解属性，设置扫描资源的模式
    scanner.setResourcePattern(componentScan.getString("resourcePattern"));

    // 根据组件扫描的注解属性，设置包含的和排除的过滤器
    for (AnnotationAttributes includeFilterAttributes : componentScan.getAnnotationArray("includeFilters")) {
        List<TypeFilter> typeFilters = TypeFilterUtils.createTypeFiltersFor(includeFilterAttributes, this.environment,
            this.resourceLoader, this.registry);
        for (TypeFilter typeFilter : typeFilters) {
            scanner.addIncludeFilter(typeFilter);
        }
    }
    for (AnnotationAttributes excludeFilterAttributes : componentScan.getAnnotationArray("excludeFilters")) {
        List<TypeFilter> typeFilters = TypeFilterUtils.createTypeFiltersFor(excludeFilterAttributes, this.environment,
            this.resourceLoader, this.registry);
        for (TypeFilter typeFilter : typeFilters) {
            scanner.addExcludeFilter(typeFilter);
        }
    }

    // 根据组件扫描的注解属性，设置是否懒加载
    boolean lazyInit = componentScan.getBoolean("lazyInit");
    if (lazyInit) {
        scanner.getBeanDefinitionDefaults().setLazyInit(true);
    }

    // 根据组件扫描的注解属性，设置需要扫描的基础包
    Set<String> basePackages = new LinkedHashSet<>();
    String[] basePackagesArray = componentScan.getStringArray("basePackages");
    for (String pkg : basePackagesArray) {
        String[] tokenized = StringUtils.tokenizeToStringArray(this.environment.resolvePlaceholders(pkg),
            ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS);
        Collections.addAll(basePackages, tokenized);
    }
    for (Class<?> clazz : componentScan.getClassArray("basePackageClasses")) {
        basePackages.add(ClassUtils.getPackageName(clazz));
    }
    if (basePackages.isEmpty()) {
        basePackages.add(ClassUtils.getPackageName(declaringClass));
    }

    // 排除指定的类
    scanner.addExcludeFilter(new AbstractTypeHierarchyTraversingFilter(false, false) {
        @Override
        protected boolean matchClassName(String className) {
            return declaringClass.equals(className);
        }
    });
    // 扫描指定的基础包，返回符合条件的Bean定义
    return scanner.doScan(StringUtils.toStringArray(basePackages));
	}

源码说明

该方法的目的是通过解析给定的组件扫描注解属性，扫描指定的基础包中的类，并将这些类的Bean定义注册到BeanFactory中。
参数componentScan是组件扫描注解属性。
参数declaringClass是要扫描的基础包，如果组件扫描注解属性没有指定基础包，则使用该参数作为默认值。
创建一个ClassPathBeanDefinitionScanner对象，它将负责扫描类并将Bean定义注册到BeanFactory中。
设置Bean名称生成器，根据组件扫描的注解属性。
根据组件扫描的注解属性，设置ScopedProxy模式或Scope元数据解析器。
根据组件扫描的注解属性，设置扫描资源的模式通过表达式进行匹配我们的class, 当然你也自己配置
根据组件扫描的注解属性，设置包含的和排除的过滤器。
根据组件扫描的注解属性，设置是否懒加载。
根据组件扫描的注解属性，设置需要扫描的基础包。不设置则默认使用 @ComponentScan 注解的路径作为扫描路径启动默认已经帮我们配置, 所以直接扫描启动类路径下的类
排除指定的类。
扫描指定的基础包，返回符合条件的Bean定义。