BeanDefinition源码分析

BeanDefinition

摘要

BeanDefinition是spring ioc的核心部分，可以说spring管理的几乎所有bean都是BeanDefinition的子类。其包含的实例化bean需要的全部信息，例如类名、方法、父类信息、scope、各类注解等

类图

BeanDefinition.png

源码分析

可以看到BeanDefinition继承了两个接口

public interface BeanDefinition extends AttributeAccessor, BeanMetadataElement {

public interface AttributeAccessor {

    void setAttribute(String name, @Nullable Object value);
    @Nullable
    Object getAttribute(String name);
    @Nullable
    Object removeAttribute(String name);
    boolean hasAttribute(String name);
    String[] attributeNames();

AttributeAccessor 主要用于操作对象的内部属性

/**
 * Interface to be implemented by bean metadata elements
 * that carry a configuration source object.
 */
public interface BeanMetadataElement {

    @Nullable
    Object getSource();
}

BeanMetadataElement用于获取对象的元数据配置源信息

BeanDefinition 属性、方法列表

package org.springframework.beans.factory.config;

import xxx;

public interface BeanDefinition extends AttributeAccessor, BeanMetadataElement {

    //scope: "singleton"标示
    String SCOPE_SINGLETON = ConfigurableBeanFactory.SCOPE_SINGLETON;
    //scope: "prototype"标示
    String SCOPE_PROTOTYPE = ConfigurableBeanFactory.SCOPE_PROTOTYPE;
    //表示用户自定义bean
    int ROLE_APPLICATION = 0;
    //表示通过外部配置加载的bean
    int ROLE_SUPPORT = 1;
    //表示是spring框架的bean
    int ROLE_INFRASTRUCTURE = 2;
    //父类bean的类名
    String getParentName();
    //当前bean的名字
    void setBeanClassName(@Nullable String beanClassName);
    String getBeanClassName();
    //bean的scope
    void setScope(@Nullable String scope);
    String getScope();
    //bean是否是懒加载
    void setLazyInit(boolean lazyInit);
    boolean isLazyInit();
    //依赖bean列表
    String[] getDependsOn();
    //bean是否可以自动注入到其他bean中
    void setAutowireCandidate(boolean autowireCandidate);
    boolean isAutowireCandidate();
    //是否是优先注入的bean，用于当有多个实现bean时，优先注入
    void setPrimary(boolean primary);
    boolean isPrimary();
    //bean的工厂类
    void setFactoryBeanName(@Nullable String factoryBeanName);
    String getFactoryBeanName();
    //bean的工厂方法
    void setFactoryMethodName(@Nullable String factoryMethodName);
    String getFactoryMethodName();
    //构造方法的参数-值列表
    ConstructorArgumentValues getConstructorArgumentValues();
    default boolean hasConstructorArgumentValues() {
        return !getConstructorArgumentValues().isEmpty();
    }
    //属性值列表
    MutablePropertyValues getPropertyValues();
    default boolean hasPropertyValues() {
        return !getPropertyValues().isEmpty();
    }
    //init方法名
    void setInitMethodName(@Nullable String initMethodName);
    String getInitMethodName();
    //Destroy方法名
    void setDestroyMethodName(@Nullable String destroyMethodName);
    String getDestroyMethodName();
    //ROLE_APPLICATION
    //ROLE_SUPPORT
    //ROLE_INFRASTRUCTURE
    void setRole(int role);
    int getRole();
    //自定义bean的description
    void setDescription(@Nullable String description);
    String getDescription();
    //scope
    boolean isSingleton();
    boolean isPrototype();
    //是否抽象类
    boolean isAbstract();
    //bean的资源描述
    String getResourceDescription();
    //返回原始的BeanDefinition，允许检索装饰的bean，返回用户定义的原始bean
    BeanDefinition getOriginatingBeanDefinition();

}

常用的BeanDefinition实现类

GenericBeanDefinition

通用的BeanDefinition实现，有两个子类ScannedGenericBeanDefinition和AnnotatedGenericBeanDefinition

image.png

ScannedGenericBeanDefinition

实现了AnnotatedBeanDefinition，被ClassPathScanningCandidateComponentProvider. findCandidateComponents扫描出来的bean会被封装为此类型，有@Component和@Component的派生注解会被封装成此类型

AnnotatedGenericBeanDefinition

有@Configuration注解的类，会生成AnnotatedGenericBeanDefinition类型的Bean

ConfigurationClassBeanDefinition

在@Configuration注解的类中，使用@Bean注解实例化的Bean

RootBeanDefinition

通用的BeanDefinition，可单独使用，一般也作为其他BeanDefinition的父类

ChildBeanDefinition

从RootBeanDefinition 继承方法、参数、可重写父类方法，需要配合RootBeanDefinition一起使用