Spring原理学习系列之六:IOC原理之BeanDefinition注册

简介: 本文主要介绍了BeanDefinition以及BeanDefinition的注册,BeanDefinition是Spring处理Bean的统一的数据结构,BeanDefinitionRegistry的实现类对BeanDefinition完成了注册操作,注册最终结果保存在beanDefinitionMap这个ConcurrentHashMap中。今天的内容就到这里了,我们下次再会了哦。

引言

在上一篇文章中,我们大致介绍了Bean创建、Bean加载的流程,但是由于文章篇幅所限,不能事无巨细的进行详细介绍。后续本系列的文章将对这部分的内容进行庖丁解牛,尽可能的将IOC中比较重要的细节说明清楚,以便于自己以及花时间阅读本文的读者可以加深对于Spring IOC的深入理解。

  • BeanDefinition
  • BeanDefinitionRegistry
  • 总结


一、BeanDefinition

纳尼,你还要说Spring IOC,之前的文章你还没有说够嘛?


谁让Spring中关于IOC这部分的内容这么多呢,前面的文章还没有说的很细。所以只能继续慢慢往下唠叨了。废话不多说,我们来继续IOC。


BeanDefinition是用来描述Spring中的Bean,是包装Bean的数据结构。其源码如下所示:

public interface BeanDefinition extends AttributeAccessor, BeanMetadataElement {
  //标准单例作用域的作用域标识符:“singleton”,对于扩展的bean工厂可能支持更多的作用域
  String SCOPE_SINGLETON = ConfigurableBeanFactory.SCOPE_SINGLETON;
  //标准原型作用域的范围标识符:“prototype”
  String SCOPE_PROTOTYPE = ConfigurableBeanFactory.SCOPE_PROTOTYPE;
  //表示BeanDefinition是应用程序主要部分的角色提示,通常对应于用户定义的bean
  int ROLE_APPLICATION = 0;
  //表示BeanDefinition是某些大型配置的支持部分的角色提示,通常是一个外部ComponentDefinition。
  //当查看某个特定的ComponentDefinition时,认为bean非常重要,
  //以便在查看应用程序的整体配置时能够意识到这一点
  int ROLE_SUPPORT = 1;
  //角色提示表明一个BeanDefinition是提供一个完全背景的角色,并且与最终用户没有关系。
  //这个提示用于注册完全是ComponentDefinition内部工作的一部分的bean
  int ROLE_INFRASTRUCTURE = 2;
  //1、当前Bean父类名称
  //如果父类存在,设置这个bean定义的父定义的名称
  void setParentName(@Nullable String parentName);
  //如果父类存在,则返回当前Bean的父类的名称
  @Nullable
  String getParentName();
  //2、当前Bean的className
  //指定此bean定义的bean类名称。
  //类名称可以在bean factory后期处理中修改,通常用它的解析变体替换原来的类名称
  void setBeanClassName(@Nullable String beanClassName);
  //返回此bean定义的当前bean类名称
  //需要注意的是,这不一定是在运行时使用的实际类名,以防子类定义覆盖/继承其父类的类名
  //此外,这可能只是调用工厂方法的类,或者它 在调用方法的工厂bean引用的情况下甚至可能是空的
  //因此,不要认为这是在运行时定义的bean类型,而只是将其用于在单独的bean定义级别进行解析
  @Nullable
  String getBeanClassName();
  //3、bean作用域
  //覆盖此bean的目标范围,指定一个新的范围名称
  void setScope(@Nullable String scope);
  //返回此bean的当前目标作用域的名称,如果没有确定,返回null
  @Nullable
  String getScope();
  //懒加载
  //设置这个bean是否应该被延迟初始化。如果{false},那么这个bean将在启动时由bean工厂实例化,
  //这些工厂执行单例的立即初始化。
  //懒加载 <bean lazy-init="true/false">
  void setLazyInit(boolean lazyInit);
  //返回这个bean是否应该被延迟初始化,即不是在启动时立即实例化。只适用于单例bean。
  boolean isLazyInit();
  //5.依赖关系设置
  //设置这个bean依赖被初始化的bean的名字。 bean工厂将保证这些bean首先被初始化。
  //<bean depends-on="">
  void setDependsOn(@Nullable String... dependsOn);
  //返回这个bean依赖的bean名称
  @Nullable
  String[] getDependsOn();
  //6.是否是自动转配设置
  //设置这个bean是否是获得自动装配到其他bean的候选人。
  //需要注意是,此标志旨在仅影响基于类型的自动装配。
  //它不会影响按名称的显式引用,即使指定的bean没有标记为autowire候选,也可以解决这个问题。
  //因此,如果名称匹配,通过名称的自动装配将注入一个bean。
  void setAutowireCandidate(boolean autowireCandidate);
  //返回这个bean是否是自动装配到其他bean的候选者。就是是否在其他类中使用autowired来注入当前Bean的
  //是否为被自动装配 <bean autowire-candidate="true/false">
  boolean isAutowireCandidate();
  //7.主候选Bean
  //是否为主候选bean    使用注解:@Primary
  void setPrimary(boolean primary);
  //返回这个bean是否是主要的autowire候选者
  boolean isPrimary();
  //8.定义创建该Bean对象的工厂类
  //指定要使用的工厂bean(如果有的话), 这是调用指定的工厂方法的bean的名称
  void setFactoryBeanName(@Nullable String factoryBeanName);
  //如果有返回工厂bean的名字
  @Nullable
  String getFactoryBeanName();
  //9.创建该Bean对象的工厂方法
  //如果有,指定工厂方法。这个方法先将通过构造函数参数被调用,或者如果参数,将调用该方法的无参数构造
  void setFactoryMethodName(@Nullable String factoryMethodName);
  //如果存在,返回工厂方法名
  @Nullable
  String getFactoryMethodName();
  //10.返回此bean的构造函数参数值
  //返回此bean的构造函数参数值
  ConstructorArgumentValues getConstructorArgumentValues();
  default boolean hasConstructorArgumentValues() {
    return !getConstructorArgumentValues().isEmpty();
  }
  //11.获取属性
  MutablePropertyValues getPropertyValues();
  default boolean hasPropertyValues() {
    return !getPropertyValues().isEmpty();
  }
  //12.设置初始方法
  void setInitMethodName(@Nullable String initMethodName);
  @Nullable
  String getInitMethodName();
  void setDestroyMethodName(@Nullable String destroyMethodName);
  @Nullable
  String getDestroyMethodName();
  void setRole(int role);
  //13.当前Bean的角色
  //获取这个bean的角色
  int getRole();
  void setDescription(@Nullable String description);
  //14.可读描述
  //返回对bean定义的可读描述
  @Nullable
  String getDescription();
  //返回该bean定义来自的资源的描述
  @Nullable
  String getResourceDescription();
  //返回原始的BeanDefinition;如果没有,则返回null。允许检索装饰的bean定义
  @Nullable
  BeanDefinition getOriginatingBeanDefinition();
  //15.当前Bean的基本特性
  //是否是单例的
  boolean isSingleton();
  //是否是多例的
  boolean isPrototype();
  //是否是抽象类
  boolean isAbstract();
}

从上面的属性和方法分析可以看出,BeanDefinition对于一个Bean的描述做了比较完整的一套约束。这为后续的实现类提供了最基本的职责和属性。BeanDefinition只是一个接口,它的具体实现如下所示:

image.png

二、BeanDefinitionRegistry

BeanDefinitionRegistry 继承了 AliasRegistry 接口,其核心子类有三个:SimpleBeanDefinitionRegistry、DefaultListableBeanFactory以及GenericApplicationContext,类机构图如下所示:

image.png

AliasRegistry 作为 BeanDefinitionRegistry 的顶层接口,它的作用主要为别名管理的通用型接口, AliasRegistry 定义了一些别名管理的方法。

public interface AliasRegistry {
  void registerAlias(String name, String alias);
  void removeAlias(String alias);
  boolean isAlias(String name);
  String[] getAliases(String name);
}

BeanDefinitionRegistry 接口在实现AliasRegistry之外还定义了关于 BeanDefinition 注册、注销、查询等一系列的操作。

public interface BeanDefinitionRegistry extends AliasRegistry {
  // 向注册表中注册一个新的 BeanDefinition 实例
  void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
      throws BeanDefinitionStoreException;
   // 移除注册表中已注册的 BeanDefinition 实例
  void removeBeanDefinition(String beanName) throws NoSuchBeanDefinitionException;
   // 从注册中取得指定的 BeanDefinition 实例
  BeanDefinition getBeanDefinition(String beanName) throws NoSuchBeanDefinitionException;
   // 判断 BeanDefinition 实例是否在注册表中(是否注册)
  boolean containsBeanDefinition(String beanName);
  // 取得注册表中所有 BeanDefinition 实例的 beanName(标识)
  String[] getBeanDefinitionNames();
  // 返回注册表中 BeanDefinition 实例的数量
  int getBeanDefinitionCount();
  // beanName(标识)是否被占用
  boolean isBeanNameInUse(String beanName);
}

我们可以看下BeanDefinitionRegistry的类实现结构如下所示:

image.png

这里关注下实现类GenericApplicationContext,其中比较重要的方法为registerBeanDefinition,它完成了BeanDefinition的注册 :

public class GenericApplicationContext extends AbstractApplicationContext implements BeanDefinitionRegistry {
  private final DefaultListableBeanFactory beanFactory;
  ...
  @Override
  public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
      throws BeanDefinitionStoreException {
    this.beanFactory.registerBeanDefinition(beanName, beanDefinition);
  }
  ...
}

注册过程实际是通过DefaultListableBeanFactoryregisterBeanDefinition来完成注册动作:

@Override
  public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
      throws BeanDefinitionStoreException {
    Assert.hasText(beanName, "Bean name must not be empty");
    Assert.notNull(beanDefinition, "BeanDefinition must not be null");
    if (beanDefinition instanceof AbstractBeanDefinition) {
      try {
        ((AbstractBeanDefinition) beanDefinition).validate();
      }
      catch (BeanDefinitionValidationException ex) {
        throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName,
            "Validation of bean definition failed", ex);
      }
    }
    BeanDefinition existingDefinition = this.beanDefinitionMap.get(beanName);
    if (existingDefinition != null) {
      if (!isAllowBeanDefinitionOverriding()) {
        throw new BeanDefinitionOverrideException(beanName, beanDefinition, existingDefinition);
      }
      else if (existingDefinition.getRole() < beanDefinition.getRole()) {
        // e.g. was ROLE_APPLICATION, now overriding with ROLE_SUPPORT or ROLE_INFRASTRUCTURE
        if (logger.isInfoEnabled()) {
          logger.info("Overriding user-defined bean definition for bean '" + beanName +
              "' with a framework-generated bean definition: replacing [" +
              existingDefinition + "] with [" + beanDefinition + "]");
        }
      }
      else if (!beanDefinition.equals(existingDefinition)) {
        if (logger.isDebugEnabled()) {
          logger.debug("Overriding bean definition for bean '" + beanName +
              "' with a different definition: replacing [" + existingDefinition +
              "] with [" + beanDefinition + "]");
        }
      }
      else {
        if (logger.isTraceEnabled()) {
          logger.trace("Overriding bean definition for bean '" + beanName +
              "' with an equivalent definition: replacing [" + existingDefinition +
              "] with [" + beanDefinition + "]");
        }
      }
      this.beanDefinitionMap.put(beanName, beanDefinition);
    }
    else {
      if (hasBeanCreationStarted()) {
        // Cannot modify startup-time collection elements anymore (for stable iteration)
        synchronized (this.beanDefinitionMap) {
          this.beanDefinitionMap.put(beanName, beanDefinition);
          List<String> updatedDefinitions = new ArrayList<>(this.beanDefinitionNames.size() + 1);
          updatedDefinitions.addAll(this.beanDefinitionNames);
          updatedDefinitions.add(beanName);
          this.beanDefinitionNames = updatedDefinitions;
          if (this.manualSingletonNames.contains(beanName)) {
            Set<String> updatedSingletons = new LinkedHashSet<>(this.manualSingletonNames);
            updatedSingletons.remove(beanName);
            this.manualSingletonNames = updatedSingletons;
          }
        }
      }
      else {
        // Still in startup registration phase
        this.beanDefinitionMap.put(beanName, beanDefinition);
        this.beanDefinitionNames.add(beanName);
        this.manualSingletonNames.remove(beanName);
      }
      this.frozenBeanDefinitionNames = null;
    }
    if (existingDefinition != null || containsSingleton(beanName)) {
      resetBeanDefinition(beanName);
    }
  }

其实上面这么多代码最重要的就是:

private final Map<String, BeanDefinition> beanDefinitionMap = new ConcurrentHashMap<>(256);
this.beanDefinitionMap.put(beanName, beanDefinition);

三、总结

本文主要介绍了BeanDefinition以及BeanDefinition的注册,BeanDefinition是Spring处理Bean的统一的数据结构,BeanDefinitionRegistry的实现类对BeanDefinition完成了注册操作,注册最终结果保存在beanDefinitionMap这个ConcurrentHashMap中。今天的内容就到这里了,我们下次再会了哦。


相关文章
|
3月前
|
缓存 Java 开发者
【Spring】原理:Bean的作用域与生命周期
本文将围绕 Spring Bean 的作用域与生命周期展开深度剖析,系统梳理作用域的类型与应用场景、生命周期的关键阶段与扩展点,并结合实际案例揭示其底层实现原理,为开发者提供从理论到实践的完整指导。
|
3月前
|
人工智能 Java 开发者
【Spring】原理解析:Spring Boot 自动配置
Spring Boot通过“约定优于配置”的设计理念,自动检测项目依赖并根据这些依赖自动装配相应的Bean,从而解放开发者从繁琐的配置工作中解脱出来,专注于业务逻辑实现。
|
2月前
|
XML Java 测试技术
《深入理解Spring》:IoC容器核心原理与实战
Spring IoC通过控制反转与依赖注入实现对象间的解耦,由容器统一管理Bean的生命周期与依赖关系。支持XML、注解和Java配置三种方式,结合作用域、条件化配置与循环依赖处理等机制,提升应用的可维护性与可测试性,是现代Java开发的核心基石。
|
2月前
|
XML Java 应用服务中间件
【SpringBoot(一)】Spring的认知、容器功能讲解与自动装配原理的入门,带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章,讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门,还有其他常用的Springboot注解!如果想要了解SpringBoot,那么就进来看看吧!
367 2
|
4月前
|
Java 关系型数据库 数据库
深度剖析【Spring】事务:万字详解,彻底掌握传播机制与事务原理
在Java开发中,Spring框架通过事务管理机制,帮我们轻松实现了这种“承诺”。它不仅封装了底层复杂的事务控制逻辑(比如手动开启、提交、回滚事务),还提供了灵活的配置方式,让开发者能专注于业务逻辑,而不用纠结于事务细节。
|
5月前
|
缓存 安全 Java
Spring 框架核心原理与实践解析
本文详解 Spring 框架核心知识,包括 IOC(容器管理对象)与 DI(容器注入依赖),以及通过注解(如 @Service、@Autowired)声明 Bean 和注入依赖的方式。阐述了 Bean 的线程安全(默认单例可能有安全问题,需业务避免共享状态或设为 prototype)、作用域(@Scope 注解,常用 singleton、prototype 等)及完整生命周期(实例化、依赖注入、初始化、销毁等步骤)。 解析了循环依赖的解决机制(三级缓存)、AOP 的概念(公共逻辑抽为切面)、底层动态代理(JDK 与 Cglib 的区别)及项目应用(如日志记录)。介绍了事务的实现(基于 AOP
176 0
|
5月前
|
Java Spring 容器
SpringBoot自动配置的原理是什么?
Spring Boot自动配置核心在于@EnableAutoConfiguration注解,它通过@Import导入配置选择器,加载META-INF/spring.factories中定义的自动配置类。这些类根据@Conditional系列注解判断是否生效。但Spring Boot 3.0后已弃用spring.factories,改用新格式的.imports文件进行配置。
893 0
|
6月前
|
人工智能 Java 测试技术
Spring Boot 集成 JUnit 单元测试
本文介绍了在Spring Boot中使用JUnit 5进行单元测试的常用方法与技巧,包括添加依赖、编写测试类、使用@SpringBootTest参数、自动装配测试模块(如JSON、MVC、WebFlux、JDBC等),以及@MockBean和@SpyBean的应用。内容实用,适合Java开发者参考学习。
634 0
|
2月前
|
JavaScript Java Maven
【SpringBoot(二)】带你认识Yaml配置文件类型、SpringMVC的资源访问路径 和 静态资源配置的原理!
SpringBoot专栏第二章,从本章开始正式进入SpringBoot的WEB阶段开发,本章先带你认识yaml配置文件和资源的路径配置原理,以方便在后面的文章中打下基础
286 5
|
2月前
|
Java 测试技术 数据库连接
【SpringBoot(四)】还不懂文件上传?JUnit使用?本文带你了解SpringBoot的文件上传、异常处理、组件注入等知识!并且带你领悟JUnit单元测试的使用!
Spring专栏第四章,本文带你上手 SpringBoot 的文件上传、异常处理、组件注入等功能 并且为你演示Junit5的基础上手体验
840 2