Spring Beans 02 - Java Bean Config 读取

组件

annotation读取主要涉及以下组件

  • AnnotatedBeanDefinitionReader - 读取并注册指定class(es)
  • ClassPathBeanDefinitionScanner - 扫描注册指定package 下的bean
  • AnnotationConfigUtils - 注册相关BeanFactoryPostProcessor,提供一些common的annotation处理

以及 @Configuration 处理相关的组件

  • ConfigurationClassBeanDefinitionReader - 解析处理 Configuration Bean
  • ConfigurationClassPostProcessor - 处理 @Configuration
  • ComponentScanAnnotationParser - 处理 @ComponentScan
  • ContextNamespaceHandler & ComponentScanBeanDefinitionParser - 处理xml配置中的 component-scan

以及一些辅助类

  • BeanNameGenerator (AnnotationBeanNameGenerator)
  • ScopeMetadataResolver (AnnotationScopeMetadataResolver)
  • ConditionEvaluator 处理 @Conditional

Annotation & BeanDefinition

为了在BeanDefinition中承载annotation, AnnotatedBeanDefinitionReaderClassPathBeanDefinitionScanner 分别使用了 实现了AnnotatedBeanDefinitionAnnotatedGenericBeanDefinitionScannedGenericBeanDefinition

AnnotatedBeanDefinition

AnnotatedBeanDefinition 通过AnnotationMetadata 来暴露annotation及class信息。

public interface AnnotatedBeanDefinition extends BeanDefinition {
    AnnotationMetadata getMetadata();
    MethodMetadata getFactoryMethodMetadata();
}

AnnotationMetadata

AnnotationMetadata 继承了 ClassMetadataAnnotatedTypeMetadata。暴露的接口均以String 的形式表现 annotation 和 class 信息,以便独立于(先于) ClassLoader 读取存储这些metadata。

AnnotatedGenericBeanDefinition使用了 StandardAnnotationMetadata 通过java reflection 获取 annotation/class 信息。
ScannedGenericBeanDefinition 则使用了 AnnotationMetadataReadingVisitor 通过 ASM 读取 annotation/class 信息。

AnnotatedBeanDefinition读取注册

AnnotatedBeanDefinition读取有两种方式
一是使用 AnnotatedBeanDefinitionReader ,传入bean的Class进行读取注册
一是使用 ClassPathBeanDefinitionScanner 扫描classpath 找出符合条件的class进行注册

这一个步骤等价于XmlBeanDefinitionReader 从XMl中读取注册bean。而具体处理@Configuration @Import 等等的操作会留给 ConfigurationClassPostProcessor 处理。这样也使得xml 读取的bean,如果需要,同样可以使用 @Configuration 等annotation。

AnnotatedBeanDefinitionReader

初始化

AnnotatedBeanDefinitionReader 创建时会用 AnnotationConfigUtils.registerAnnotationConfigProcessors(BeanDefinitionRegistry) 向registry 注册annotation 相关的BeanFactoryPostProcessor

registerBean

AnnotatedBeanDefinitionReader 的读取很简单。由于 Java Config 不涉及像XML Config 中的 constructor-arg, property-value 等等的配置,所以只需要关注一些Bean基本的属性即可。

    <T> void doRegisterBean(Class<T> annotatedClass, @Nullable Supplier<T> instanceSupplier, @Nullable String name,
            @Nullable Class<? extends Annotation>[] qualifiers, BeanDefinitionCustomizer... definitionCustomizers) {
    // 1. 创建 AnnotatedGenericBeanDefinition
        AnnotatedGenericBeanDefinition abd = new AnnotatedGenericBeanDefinition(annotatedClass);
        
        // 2. 检查 @Conditional
        if (this.conditionEvaluator.shouldSkip(abd.getMetadata())) {
            return;
        }

    ...
    
    // 3. 检查设置Scope
        ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(abd);
        abd.setScope(scopeMetadata.getScopeName());
        
        // 4. 获取Bean Name
        String beanName = (name != null ? name : this.beanNameGenerator.generateBeanName(abd, this.registry));
    
    // 5. 处理 @Lazy, @Primary, @DependesOn, @Role, D@escription
        AnnotationConfigUtils.processCommonDefinitionAnnotations(abd);
    ...

    // 6. 向registry 注册
        BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(abd, beanName);
        definitionHolder = AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry);
        BeanDefinitionReaderUtils.registerBeanDefinition(definitionHolder, this.registry);
    }

ClassPathBeanDefinitionScanner

初始化

  1. 设置filters,主要是添加了 new AnnotationTypeFilter(Component.class) 来过滤有 @Comonent 的class
  2. 设置ResourcePatternResolver, 用来读取class 文件
  3. 设置MetadataReaderFactoryCachingMetadataReaderFactory,对应生成 SimpleMetadataReader类型的MetadataReader
  4. 读取之前执行时生成的 componentsIndex
    public ClassPathBeanDefinitionScanner(BeanDefinitionRegistry registry, boolean useDefaultFilters,
            Environment environment, @Nullable ResourceLoader resourceLoader) {

        this.registry = registry;

        if (useDefaultFilters) {
            registerDefaultFilters();
        }
        setEnvironment(environment);
        setResourceLoader(resourceLoader);
    }
    
    public void setResourceLoader(@Nullable ResourceLoader resourceLoader) {
        this.resourcePatternResolver = ResourcePatternUtils.getResourcePatternResolver(resourceLoader);
        this.metadataReaderFactory = new CachingMetadataReaderFactory(resourceLoader);
        this.componentsIndex = CandidateComponentsIndexLoader.loadIndex(this.resourcePatternResolver.getClassLoader());
    }

scan

doScan(String... basePackages)

  1. 调用 findCandidateComponents 扫描获得所有能通过filter 的class的 BeanDefinition
  2. 类似 AnnotatedBeanDefinitionReader 一样处理和注册bean

findCandidateComponents(String basePackage)

findCandidateComponents 从 componentsIndex 读取或者直接扫描classpath

    public Set<BeanDefinition> findCandidateComponents(String basePackage) {
        if (this.componentsIndex != null && indexSupportsIncludeFilters()) {
            return addCandidateComponentsFromIndex(this.componentsIndex, basePackage);
        }
        else {
            return scanCandidateComponents(basePackage);
        }
    }

scanCandidateComponents(String basePackage)

  1. 使用ResourcePatternResolver加载所有在 classpath*:{basepakcage}/**/*.class 上的class。
  2. 遍历class Resource,对每个resource, 生成SimpleMetadataReader 读取resource
  3. ScannedGenericBeanDefinition 存储通过 metaReader 获取的 AnnotationMetaData 生成 BeanDefinition

classpath*:classpath: 的区别在于:
classpath*:会搜索所有classpath 上满足条件的class, classpath: 只会找到满足条件的第一个。``classpath:`如果没有找到的话会break

// ClassPathScanningCandidateComponentProvider
// with try..catch, else {}, logging removed
private Set<BeanDefinition> scanCandidateComponents(String basePackage) {
    Set<BeanDefinition> candidates = new LinkedHashSet<>();
    String packageSearchPath = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX +
            resolveBasePackage(basePackage) + '/' + this.resourcePattern;
    Resource[] resources = getResourcePatternResolver().getResources(packageSearchPath);
    for (Resource resource : resources) {
        if (resource.isReadable()) {
            MetadataReader metadataReader = getMetadataReaderFactory().getMetadataReader(resource);
            if (isCandidateComponent(metadataReader)) {
                ScannedGenericBeanDefinition sbd = new ScannedGenericBeanDefinition(metadataReader);
                sbd.setResource(resource);
                sbd.setSource(resource);
                if (isCandidateComponent(sbd)) {
                    candidates.add(sbd);
                }
            }
        }
    }
    return candidates;
}

// ScannedGenericBeanDefinition
public ScannedGenericBeanDefinition(MetadataReader metadataReader) {
    Assert.notNull(metadataReader, "MetadataReader must not be null");
    this.metadata = metadataReader.getAnnotationMetadata();
    setBeanClassName(this.metadata.getClassName());
}

SimpleMetadataReader

使用了repackage 的 ASM

  1. 使用 ClassReader 读入class 文件
  2. 利用AnnotationMetadataReadingVisitorClassReader 读取 annotation/class 信息
//SimpleMetadataReader
    SimpleMetadataReader(Resource resource, @Nullable ClassLoader classLoader) throws IOException {
        InputStream is = new BufferedInputStream(resource.getInputStream());
        ClassReader classReader;
        try {
            classReader = new ClassReader(is);
        }
        catch (IllegalArgumentException ex) {
            throw new NestedIOException("ASM ClassReader failed to parse class file - " +
                    "probably due to a new Java class file version that isn't supported yet: " + resource, ex);
        }
        finally {
            is.close();
        }

        AnnotationMetadataReadingVisitor visitor = new AnnotationMetadataReadingVisitor(classLoader);
        classReader.accept(visitor, ClassReader.SKIP_DEBUG);

        this.annotationMetadata = visitor;
        // (since AnnotationMetadataReadingVisitor extends ClassMetadataReadingVisitor)
        this.classMetadata = visitor;
        this.resource = resource;
    }
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,636评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,890评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,680评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,766评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,665评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,045评论 1 276
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,515评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,182评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,334评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,274评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,319评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,002评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,599评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,675评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,917评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,309评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,885评论 2 341

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,562评论 18 139
  • 1.1 Spring IoC容器和bean简介 本章介绍了Spring Framework实现的控制反转(IoC)...
    起名真是难阅读 2,566评论 0 8
  • 1.1 spring IoC容器和beans的简介 Spring 框架的最核心基础的功能是IoC(控制反转)容器,...
    simoscode阅读 6,689评论 2 22
  • 本文是我自己在秋招复习时的读书笔记,整理的知识点,也是为了防止忘记,尊重劳动成果,转载注明出处哦!如果你也喜欢,那...
    波波波先森阅读 12,267评论 6 86
  • 小公主远道而来探望小蛇宋。 你我她坐在几个平方的小小房间,看满墙的摩天轮,旋转木马说笑话。外婆,妈妈和女儿。 我总...
    唐四月阅读 221评论 0 0