本文是对 Spring Bean 实例化(Instantiation)方式的总结。常见的实例 bean 的方式有五种,它们都有 XML、Java 注解和 Java API 三种配置方式。所谓 Java API 指的是通过最底层的 BeanDenifition 的方式注册,无论是 XML 还是 Java 注解,最终被解析成 BeanDefinition。

  • 常规方式
    • 通过无参构造器(配置元信息:XML、Java 注解和 Java API)
    • 通过有参构造器(配置元信息:XML、Java 注解和 Java API)
    • 通过 FactoryBean(配置元信息:XML、Java 注解和 Java API)
    • 通过静态工厂方法(配置元信息:XML 和 Java API)
    • 通过实例工厂方法(配置元信息:XML 和 Java API)
  • 特殊方式

    • 通过 ServiceLoaderFactoryBean(配置元信息:XML、Java 注解和Java API )
    • 通过 AutowireCapableBeanFactory#createBean(java.lang.Class, int, boolean)
    • 通过 BeanDefinitionRegistry#registerBeanDefinition(String, BeanDefinition):核心 API

      1. 五种创建方式

      1.1 无参构造器

      无参构造器的实例化方法,我们分 XML、Java 注解和 Java API 三种配置方式进行讲解。
      (1)XML 配置
      1. <bean id="user" class="com.binarylei.spring.ioc.domain.User">
      2. <property name="id" value="1"/>
      3. <property name="name" value="binarylei"/>
      4. </bean>
      (2)Java 注解
      1. @Bean
      2. public User user() {
      3. return new User();
      4. }
      (3) Java API
      1. // 1.通过 BeanDefinitionBuilder 构建
      2. BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(User.class);
      3. // 通过属性设置
      4. beanDefinitionBuilder.addPropertyValue("id", 1)
      5. .addPropertyValue("name", "binarylei");
      6. BeanDefinition beanDefinition = beanDefinitionBuilder.getBeanDefinition();
      7. // 2. 通过 AbstractBeanDefinition 以及派生类
      8. GenericBeanDefinition genericBeanDefinition = new GenericBeanDefinition();
      9. genericBeanDefinition.setBeanClass(User.class);
      10. MutablePropertyValues propertyValues = new MutablePropertyValues();
      11. propertyValues.add("id", 1)
      12. .add("name", "binarylei");
      13. genericBeanDefinition.setPropertyValues(propertyValues);

      1.2 有参构造器

      有参构造器的实例化方法,我们也分 XML、Java 注解和 Java API 三种配置方式进行讲解。
      (1)XML 配置
      1. <bean id="user2" class="com.binarylei.spring.ioc.domain.User">
      2. <constructor-arg index="0" value="1"/>
      3. <constructor-arg index="1" value="binarylei"/>
      4. </bean>
      (2)Java 注解
      1. @Bean
      2. public User user2(long id, String name) {
      3. return new User(id, name);
      4. }
      (3) Java API
      1. BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(User.class);
      2. beanDefinitionBuilder.addConstructorArgValue(1)
      3. .addConstructorArgValue("binarylei");
      4. BeanDefinition beanDefinition = beanDefinitionBuilder.getBeanDefinition();
      思考:对比无参构造器,有参构造器实例化对象时,为什么不需要指定参数名称?
  • 无参构造器:通过 setter 方法注入,必须指定字段名称。注入顺序是不定的。

  • 有参构造器:可以通过参数个数和参数类型匹配具体的构造函数,一旦确定了构造函数,参数的顺序也就固定了。
  • 这里其实也就构造器注入和 setter 方法注入的一个区别,构造器注入是有序的,setter 注入是无序的。而且构造器注入可以将参数设置为 final,从而保证 bean 的不变性。
  • 构造注入无法解决循环依赖的问题。如果 setter 注入,则可以通过提前暴露 bean 的方式解决循环依赖。当然,这其实也不是一个很大的问题,因为如果出现循环依赖,那么我们首先想到的应该是重构我们的代码,而不是想办法绕过。
    注意:只有单例才能解决循环依赖。

    1.3 FactoryBean

    (1)XML 配置
    1. <bean id="user3" class="com.binarylei.spring.ioc.factory.UserFactoryBean"/>
    (2)Java 注解
    1. @Bean
    2. public UserFactoryBean user3() {
    3. return new UserFactoryBean();
    4. }
    (3) Java API
    1. BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(User.class);
    2. beanDefinitionBuilder.addConstructorArgValue(1)
    3. .addConstructorArgValue("binarylei");
    4. BeanDefinition beanDefinition = beanDefinitionBuilder.getBeanDefinition();
    思考:为什么要有 FactoryBean?
    Spring 是面向 POJO 编程,一般我们自己的项目都是通过属性或字段注入的方式创建 bean,也用不到 FactoryBean。但很多复杂的对象,通过 xml 的方式配置非常复杂,特别是第三方框架,如 Spring 整合 Mybatis 的 SqlSessionFactoryBean。

    1.4 静态工厂

    (1)XML 配置
    1. <bean id="user4" class="com.binarylei.spring.ioc.domain.User" factory-method="createUser"/>
    (2)Java 注解
    1. @Bean
    2. public User user3() {
    3. return User.createUser();
    4. }
    (3) Java API
    1. public BeanDefinition createBeanDefinition4() {
    2. BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(User.class);
    3. beanDefinitionBuilder.setFactoryMethod("createUser");
    4. return beanDefinitionBuilder.getBeanDefinition();
    5. }

    1.5 实例工厂

    (1)XML 配置
    1. <bean id="userFactory" class="com.binarylei.spring.ioc.bean.factory.DefaultUserFactory"/>
    2. <bean id="user5" class="com.binarylei.spring.ioc.domain.User" factory-bean="userFactory" factory-method="createUser"/>
    (2)Java 注解
    1. @Bean
    2. public User UserFactory() {
    3. return new DefaultUserFactory();
    4. }
    5. @Bean
    6. public User user5(UserFactory userFactory) {
    7. return UserFactory.createUser();
    8. }
    (3) Java API
    1. public BeanDefinition createBeanDefinition5() {
    2. BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(User.class);
    3. beanDefinitionBuilder.setFactoryMethodOnBean("createUser", "userFacory");
    4. return beanDefinitionBuilder.getBeanDefinition();
    5. }
    思考:静态工厂和实例工厂有什么区别?
  1. 静态工厂直接调用静态方法,不会初始化工厂类,而实例工厂会先实例化工厂类再初始化 bean。
  2. 同理,调用 beanFactory.getBeansOfType() 如果无法通过 BeanDefinition 获取对象类型,可能会先获取 bean 实例来获取 bean 对象类型,如果是静态方法可以???待补充…

    2. 其它创建方式

    2.1 ServiceFactoryBean

    通过 Java SPI 加载类。有 ServiceLoaderFactoryBean(加载 ServiceLoader)、ServiceFactoryBean(加载单个对象)、ServiceListFactoryBean(加载全部对象) 三类。
    Spring Bean 基础(02)bean 五种创建方式 - 图1
    ServiceFactoryBean 实现非常简单,我们直接看使用方法:

  3. 配置 META-INF/services 配置 com.binarylei.spring.ioc.bean.factory.UserFactory 文件

    1. com.binarylei.spring.ioc.bean.factory.DefaultUserFactory
  4. 配置 xml 文件

    1. <bean id="userFactoryServiceLoader" class="org.springframework.beans.factory.serviceloader.ServiceFactoryBean">
    2. <property name="serviceType" value="com.binarylei.spring.ioc.bean.factory.UserFactory" />
    3. </bean>

    更多关于 AbstractFactoryBean 参考:Spring 循环引用(三)AbstractFactoryBean 如何解决循环依赖

    2.2 AutowireCapableBeanFactory#createBean

    1. UserManager userManager = (UserManager) autowireCapableBeanFactory.createBean(
    2. UserManager.class, AutowireCapableBeanFactory.AUTOWIRE_BY_TYPE, false);

    说明: 不推荐使用。通过 createBean 方法可以正常进行依赖注入等,但创建的对象都是多例,而且不会注册到 Spring 容器中,通过 beanFactory.getBeanDefinitionNames() 也不查到对应的 BeanDefinition 信息。

    2.3 BeanDefinitionRegistry#registerBeanDefinition

    Spring 官方大量采用 registerBeanDefinition 进行扩展,如 AnnotationConfigUtils#registerAnnotationConfigProcessors

    1. public static Set<BeanDefinitionHolder> registerAnnotationConfigProcessors(
    2. BeanDefinitionRegistry registry, @Nullable Object source) {
    3. if (!registry.containsBeanDefinition(AUTOWIRED_ANNOTATION_PROCESSOR_BEAN_NAME)) {
    4. RootBeanDefinition def = new RootBeanDefinition(AutowiredAnnotationBeanPostProcessor.class);
    5. def.setSource(source);
    6. beanDefs.add(registerPostProcessor(registry, def, AUTOWIRED_ANNOTATION_PROCESSOR_BEAN_NAME));
    7. }
    8. ...
    9. }
    10. // 将 BeanDefinition 注册到容器中
    11. private static BeanDefinitionHolder registerPostProcessor(
    12. BeanDefinitionRegistry registry, RootBeanDefinition definition, String beanName) {
    13. definition.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
    14. registry.registerBeanDefinition(beanName, definition);
    15. return new BeanDefinitionHolder(definition, beanName);
    16. }

    说明: 推荐使用。通过 BeanDefinition 方式向容器中注入 bean,Spring 所有的扩展也都是采用向 Spring 容器中注入 BeanDefinition。


每天用心记录一点点。内容也许不重要,但习惯很重要!