使用FactoryBean向Spring容器中注册bean

1.FactoryBean概述

一般情况下，Spring是通过反射机制利用bean的class属性指定实现类来实例化bean的。在某些情况下，实例化bean过程比较复杂，如果按照传统的方式，那么则需要在标签中提供大量的配置信息，配置方式的灵活性是受限的，这时采用编码的方式可以得到一个更加简单的方案。Spring为此提供了一个org.springframework.bean.factory.FactoryBean的工厂类接口，用户可以通过实现该接口定制实例化bean的逻辑。

FactoryBean接口对于Spring框架来说占有非常重要的地位，Spring自身就提供了70多个FactoryBean接口的实现。它们隐藏了实例化一些复杂bean的细节，给上层应用带来了便利。从Spring 3.0开始，FactoryBean开始支持泛型，即接口声明改为FactoryBean的形式。

public interface FactoryBean<T> {
  
	String OBJECT_TYPE_ATTRIBUTE = "factoryBeanObjectType";

  // 返回由FactoryBean创建的bean实例，如果isSingleton()返回true，那么该实例会放到Spring容器中单实例缓存池中
	@Nullable
	T getObject() throws Exception;
  
  // 返回FactoryBean创建的bean实例的类型
	@Nullable
	Class<?> getObjectType();

  // 返回由FactoryBean创建的bean实例的作用域是singleton还是prototype
	default boolean isSingleton() {
		return true;
	}
}

这里，需要注意的是：通过 getBean()方法返回的不是FactoryBean本身，而是FactoryBean#getObject()方法所返回的对象，相当于FactoryBean#getObject()代理了getBean()方法。

2.FactoryBean案例

创建一个ColorFactoryBean类，它得实现FactoryBean接口，如下所示

package com.tianxia.springannotation.config.configImport;

import com.tianxia.springannotation.entity.Color;
import org.springframework.beans.factory.FactoryBean;

/**
 * 创建一个Spring定义的FactoryBean
 * T（泛型）：指定我们要创建什么类型的对象
 * @author liqb
 * @date 2023-04-24 11:54
 **/
public class ColorFactoryBean implements FactoryBean<Color> {

    /**
     * 返回一个Color对象，这个对象会添加到容器中
     * @author liqb
     * @date 2023-04-24 11:55
     * @return
     * @throws Exception
     */
    @Override
    public Color getObject() throws Exception {
        return null;
    }

    /**
     * 返回这个对象的类型
     * @author liqb
     * @date 2023-04-24 11:56
     * @return
     */
    @Override
    public Class<?> getObjectType() {
        return null;
    }

    /**
     * 如果返回true，那么代表这个bean是单实例，在容器中只会保存一份；
     * 如果返回false，那么代表这个bean是多实例，每次获取都会创建一个新的bean
     * @author liqb
     * @date 2023-04-24 11:56
     * @return
     */
    @Override
    public boolean isSingleton() {
        return false;
    }
}

编写测试代码

/**
 * 测试FactoryBean创建bean对象
 * @author liqb
 * @date 2023-04-24 12:00
 */
public void testFactoryBean() {
    AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(MainConfig03.class);
    String[] definitionNames = applicationContext.getBeanDefinitionNames();
    for (String name : definitionNames) {
        System.out.println(name);
    }

    // 工厂bean获取的是调用getObject方法创建的对象
    Object bean2 = applicationContext.getBean("colorFactoryBean");
    Object bean3 = applicationContext.getBean("colorFactoryBean");
    System.out.println("bean的类型：" + bean2.getClass());
    System.out.println(bean2 == bean3);
}

输出的结果信息如下所示：

3.如何在Spring容器中获取到FactoryBean对象本身呢？

/**
 * 测试FactoryBean创建bean对象
 * @author liqb
 * @date 2023-04-24 12:00
 */
public void testFactoryBean() {
    AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(MainConfig03.class);
    String[] definitionNames = applicationContext.getBeanDefinitionNames();
    for (String name : definitionNames) {
        System.out.println(name);
    }

    // 工厂bean获取的是调用getObject方法创建的对象
    Object bean2 = applicationContext.getBean("colorFactoryBean");
    Object bean3 = applicationContext.getBean("colorFactoryBean");
    System.out.println("bean的类型：" + bean2.getClass());
    System.out.println(bean2 == bean3);

    Object bean4 = applicationContext.getBean("&colorFactoryBean");
    System.out.println(bean4.getClass());
}