基于注解SpringBoot ApplicationContext的getBean使用方法

​原文：https://www.jianshu.com/p/01bee649a0c9

我们知道可以通过ApplicationContext的getBean方法来获取Spring容器中已初始化的bean。getBean一共有以下四种方法原型：

• getBean(String name)

• getBean(Class type)

• getBean(String name,Class type)

• getBean(String name,Object[] args)

下来我们分别来探讨以上四种方式获取bean的区别。

其中实体类Person定义如下：

public class Person {

    private String name;
    private int age;

    public Person(){}
    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "Person [name=" + name + ", age=" + age + "]";
    }

}

1. getBean(String name)

参数name表示IOC容器中已经实例化的bean的id或者name,且无论是id还是name都要求在IOC容器中是唯一的不能重名。那么这种方法就是通过id或name去查找获取bean.获取bean的参考代码如下：

​public class SpringContextHolder 
        implements ApplicationContextAware, DisposableBean {

    private static ApplicationContext applicationContext = null;

    @SuppressWarnings("unchecked")
    public static <T> T getBean(String name) {
        assertContextInjected();
        return (T) applicationContext.getBean(name);
    }

}

2. getBean(Class type)

参数Class type表示要加载的Bean的类型。如果该类型没有继承任何父类(Object类除外)和实现接口的话，那么要求该类型的bean在IOC容器中也必须是唯一的。比如applicationContext.xml配置两个类型完全一致的bean,且都没有配置id和name属性。

public class SpringContextHolder 
        implements ApplicationContextAware, DisposableBean {

    private static ApplicationContext applicationContext = null;

    public static <T> T getBean(Class<T> requiredType) {
        assertContextInjected();
        return applicationContext.getBean(requiredType);
    }

}

getBean(String name)和getBean(Class type)的异同点。

• 相同点：都要求id或者name或者类型在容器中的唯一性。
• 不同点：getBean(String name)获得的对象需要类型转换而getBean(Class type)获得的对象无需类型转换。

3. getBean(String name,Class type)

这种方式比较适合当类型不唯一时，再通过id或者name来获取bean。

public class SpringContextHolder 
        implements ApplicationContextAware, DisposableBean {

    private static ApplicationContext applicationContext = null;

    public static <T> T getBean(String name, Class<T> requiredType) {
        assertContextInjected();
        return applicationContext.getBean(name, requiredType);
    }

}

4. getBean(String name,Object[] args)（没实际使用过，只是推测）

这种方式本质还是通过bean的id或者name来获取bean,通过第二个参数Object[] args可以给bean的属性赋值，赋值的方式有两种：构造方法和工厂方法。但是通过这种方式获取的bean必须把scope属性设置为prototype，也就是非单例模式。

如果想通过工厂注入属性，配置有如下fanctory:

public class PersonFactory {

    // 静态工厂注入
    @Bean
    public static Person getPersonInstance(String name, int age) throws Exception {
        Person p = (Person) Class.forName("com.bean.Person").newInstance();
        Method m = p.getClass().getMethod("setName", java.lang.String.class);
        m.invoke(p, name);
        m = p.getClass().getMethod("setAge", int.class);
        m.invoke(p, age);
        return p;
    }

}

获取bean的参考代码如下：

public class SpringContextHolder 
        implements ApplicationContextAware, DisposableBean {

    private static ApplicationContext applicationContext = null;

    public static <T> T getBean(String name, Object[] args) {
        assertContextInjected();
        return applicationContext.getBean(name, args);
    }

}

5. 如果不知道已经实例化的bean的id或者name可以使用如下代码查看

• getBeanDefinitionNames()
  获取所有已经实例化的bean的id或者name
• getBeanNamesForType(Class<?> annotationType)
  获取指定类型的bean的id或者name

追加我的 springContextHoler 完整代码，getBean 函数如上

@Slf4j
public class SpringContextHolder implements ApplicationContextAware, DisposableBean {
    private static ApplicationContext applicationContext = null;

    /**
     * 检查ApplicationContext不为空.
     */
    private static void assertContextInjected() {
        if (applicationContext == null) {
            throw new IllegalStateException("applicaitonContext属性未注入, 请在applicationContext" +
                    ".xml中定义SpringContextHolder或在SpringBoot启动类中注册SpringContextHolder.");
        }
    }

    /**
     * 清除SpringContextHolder中的ApplicationContext为Null.
     */
    private static void clearHolder() {
        log.debug("清除SpringContextHolder中的ApplicationContext:"
                + applicationContext);
        applicationContext = null;
    }

    @Override
    public void destroy() {
        SpringContextHolder.clearHolder();
    }

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        if (SpringContextHolder.applicationContext != null) {
            log.warn("SpringContextHolder中的ApplicationContext被覆盖, 原有ApplicationContext为:" + SpringContextHolder.applicationContext);
        }
        SpringContextHolder.applicationContext = applicationContext;
    }

}