如何将BeanDefinition注册到IOC容器

2020-12-23

01 XML配置

<bean id="user" class="org.geekbang.thinking.in.spring.ioc.overview.domain.User">
  <property name="id" value="1"/>
  <property name="name" value="小马哥"/>
  <property name="city" value="HANGZHOU"/>
  <property name="workCities" value="BEIJING,HANGZHOU"/>
  <property name="lifeCities">
      <list>
          <value>BEIJING</value>
          <value>SHANGHAI</value>
      </list>
  </property>
  <property name="configFileLocation" value="classpath:/META-INF/user-config.properties"/>
</bean>

不多说，经常使用的一种方式

02 Java注解配置

// 3. 通过 @Import 来进行导入
@Import(AnnotationBeanDefinitionDemo.Config.class)
public class AnnotationBeanDefinitionDemo {

  public static void main(String[] args) {
      // 创建 BeanFactory 容器
      AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext();
      // 注册 Configuration Class（配置类）
      applicationContext.register(AnnotationBeanDefinitionDemo.class);
      // 启动 Spring 应用上下文
      applicationContext.refresh();
      // 按照类型依赖查找
      System.out.println("Config 类型的所有 Beans" + applicationContext.getBeansOfType(Config.class));
      System.out.println("User 类型的所有 Beans" + applicationContext.getBeansOfType(User.class));
      // 显示地关闭 Spring 应用上下文
      applicationContext.close();
  }

  // 2. 通过 @Component 方式
  @Component // 定义当前类作为 Spring Bean（组件）
  public static class Config {
      // 1. 通过 @Bean 方式定义
      /**
        * 通过 Java 注解的方式，定义了一个 Bean
        */
      @Bean(name = {"user", "xiaomage-user"})
      public User user() {
          User user = new User();
          user.setId(1L);
          user.setName("小马哥");
          return user;
      }
  }
}

注意，此处的Config类，Import了一次，又Component了一次，但是容器中是只有一个Bean的。
另外即使给了user一个别名，也是只有一个User类的Bean的。

03 Java API配置

命名方式 org.springframework.beans.factory.support.BeanDefinitionRegistry#registerBeanDefinition
非命名方式org.springframework.beans.factory.support.BeanDefinitionReaderUtils#registerWithGeneratedName

public class AnnotationBeanDefinitionDemo {

  public static void main(String[] args) {
      // 创建 BeanFactory 容器
      AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext();
      // 注册 Configuration Class（配置类）
      applicationContext.register(AnnotationBeanDefinitionDemo.class);

      // 通过 BeanDefinition 注册 API 实现
      // 1.命名 Bean 的注册方式
      registerUserBeanDefinition(applicationContext, "mercyblitz-user");
      // 2. 非命名 Bean 的注册方法
      registerUserBeanDefinition(applicationContext);

      // 启动 Spring 应用上下文
      applicationContext.refresh();
      // 按照类型依赖查找
      System.out.println("User 类型的所有 Beans" + applicationContext.getBeansOfType(User.class));
      // 显示地关闭 Spring 应用上下文
      applicationContext.close();
  }

  public static void registerUserBeanDefinition(BeanDefinitionRegistry registry, String beanName) {
      BeanDefinitionBuilder beanDefinitionBuilder = genericBeanDefinition(User.class);
      beanDefinitionBuilder
              .addPropertyValue("id", 1L)
              .addPropertyValue("name", "小马哥");

      // 判断如果 beanName 参数存在时
      if (StringUtils.hasText(beanName)) {
          // 注册 BeanDefinition
          registry.registerBeanDefinition(beanName, beanDefinitionBuilder.getBeanDefinition());
      } else {
          // 非命名 Bean 注册方法
          BeanDefinitionReaderUtils.registerWithGeneratedName(beanDefinitionBuilder.getBeanDefinition(), registry);
      }
  }

  public static void registerUserBeanDefinition(BeanDefinitionRegistry registry) {
      registerUserBeanDefinition(registry, null);
  }

  public static class Config {
      public User user() {
          User user = new User();
          user.setId(1L);
          user.setName("小马哥");
          return user;
      }
  }
}

输出结果：
User 类型的所有 Beans{mercyblitz-user=User{id=1, name=’小马哥’, city=null, workCities=null, lifeCities=null, configFileLocation=null, company=null, context=null, contextAsText=’null’, beanName=’mercyblitz-user’}, org.geekbang.thinking.in.spring.ioc.overview.domain.User#0=User{id=1, name=’小马哥’, city=null, workCities=null, lifeCities=null, configFileLocation=null, company=null, context=null, contextAsText=’null’, beanName=’org.geekbang.thinking.in.spring.ioc.overview.domain.User#0’}}
非命名的方式会在名称后面加#和一个递增的数字
仔细看一下，会发现非命名调用的方法里面就多了一个生成BeanName的方法，

public static String registerWithGeneratedName(AbstractBeanDefinition definition, BeanDefinitionRegistry registry)
    throws BeanDefinitionStoreException {

  String generatedName = generateBeanName(definition, registry, false);
  registry.registerBeanDefinition(generatedName, definition);
  return generatedName;
}

generateBeanName方法里判断是否是isInnerBean来区分命名方式，关于isInnerBean的具体含义，注释里说的不是很清楚
(whether the given bean definition will be registered as inner bean or as top-level bean (allowing for special name generation
for inner beans versus top-level beans)

if (isInnerBean) {
  // Inner bean: generate identity hashcode suffix.
  id = generatedBeanName + GENERATED_BEAN_NAME_SEPARATOR + ObjectUtils.getIdentityHexString(definition);
}
else {
  // Top-level bean: use plain class name with unique suffix if necessary.
  return uniqueBeanName(generatedBeanName, registry);
}

public static String uniqueBeanName(String beanName, BeanDefinitionRegistry registry) {
  String id = beanName;
  int counter = -1;

  // Increase counter until the id is unique.
  while (counter == -1 || registry.containsBeanDefinition(id)) {
    counter++;
    id = beanName + GENERATED_BEAN_NAME_SEPARATOR + counter;
  }
  return id;
}

通过方法注释(Turn the given bean name into a unique bean name for the given bean factory,appending a unique counter as suffix if necessary.)可以看到一个Bean只是在当前bean factory中才是唯一的，而且数字后缀也不是必须的。
然后还是调用命名方式同样的方法，方法如下：
org.springframework.beans.factory.support.DefaultListableBeanFactory#registerBeanDefinition