Spring容器获取Bean的9种方式 | 京东云技术团队-低调大师

Spring容器获取Bean的9种方式 | 京东云技术团队

2023-07-04 304

1 前言

随着SpringBoot的普及，Spring的使用也越来越广，在某些场景下，我们无法通过注解或配置的形式直接获取到某个Bean。比如，在某一些工具类、设计模式实现中需要使用到Spring容器管理的Bean，此时就需要直接获取到对应的Bean。

本文为大家整理汇总了常见的获取Bean的方式，并提供一些优劣分析，方便大家在使用到时有更好的选择。同时，也会为大家适当的普及和拓展一些相关知识。

2 Spring的IoC容器

在Spring中，Bean的实例化、定位、配置应用程序中的对象及建立对象间的依赖关系，都是在IoC容器中进行的。因此，要在Spring中获取Bean，本质上就是从IoC容器当中获取Bean。

在Spring中，BeanFactory是IoC容器的实际代表者，该接口提供了IoC容器最基本功能。同时，Spring还提供了另外一种类型的容器：ApplicationContext容器。

ApplicationContext容器包括BeanFactory容器的所有功能（BeanFactory的子接口），提供了更多面向应用的功能，它提供了国际化支持和框架事件体系，更易于创建实际应用。

一般情况，我们称BeanFactory为IoC容器，称ApplicationContext为应用上下文。但有时为了方便，也将ApplicationContext称为Spring容器。

通常不建议使用BeanFactory，但BeanFactory 仍然可以用于轻量级的应用程序，如移动设备或基于applet的应用程序，其中它的数据量和速度是显著。

2.1 BeanFactory与ApplicationContext的区别

BeanFactory是Spring框架的基础设施，面向Spring本身。ApplicationContext则面向使用Spring框架的开发者，几乎所有的应用场景都可以直接使用ApplicationContext，而非底层的BeanFactory。

另外，ApplicationContext的初始化和BeanFactory有一个重大的区别：

BeanFactory在初始化容器时，并未实例化Bean，直到第一次访问某个Bean时才实例目标Bean。这样，我们就不能发现一些存在的Spring的配置问题。如果Bean的某一个属性没有注入，BeanFacotry加载后，直至第一次使用调用getBean方法才会抛出异常。

而ApplicationContext则在初始化应用上下文时就实例化所有单实例的Bean，相对应的，ApplicationContext的初始化时间会比BeanFactory长一些。

了解了上述的基本理论知识之后，我们就可以尝试从IoC容器当中获取Bean对象了。

3 Bean获取方式

3.1 方式一：通过BeanFactory获取

通过BeanFactory来获取Bean。基于xml配置文件的时代，可以通过如下方式获得BeanFactory，再通过BeanFactory来获得对应的Bean。

BeanFactory beanFactory = new XmlBeanFactory(new ClassPathResource("applicationContext.xml"));
User user = (User) beanFactory.getBean("user");

有一定编程年龄的程序员，应该对此还有一些印象。这种写法估计也只会出现在古老的项目当中。鉴于xml形式配置文件已经被基于注解形式所替代，同时XmlBeanFactory也被标注为废弃。此种方式不推荐使用。

其实，不推荐的理由还有一个，在上面已经提到，尽量不要使用BeanFactory，而应该使用ApplicationContext。

3.2 方式二：通过BeanFactoryAware获取

在上面的方式中，XmlBeanFactory已经被废弃，但可以通过其他方式来获得BeanFactory，然后再从BeanFactory中获得指定的Bean。获取BeanFactory实例最简单的方式就是实现BeanFactoryAware接口。

BeanFactoryAware接口源码：

public interface BeanFactoryAware extends Aware {

 /**
  * 初始化回调方法，Spring会自动将BeanFactory注入进去，接收之后即可使用BeanFactory
  */
 void setBeanFactory(BeanFactory beanFactory) throws BeansException;
}

BeanFactoryAware属于
org.springframework.beans.factory.Aware根标记接口，使用setter注入来在应用程序上下文启动期间获取对象。Aware接口是回调，监听器和观察者设计模式的混合，它表示Bean有资格通过回调方式被Spring容器通知。

示例如下：

@Component
public class BeanFactoryHelper implements BeanFactoryAware {

 private static BeanFactory beanFactory;

 /**
  * 重写 BeanFactoryAware 接口的方法
  * @param beanFactory ：参数赋值给本地属性之后即可使用 BeanFactory
  * @throws BeansException BeansException
  */
 @Override
 public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
  BeanFactoryHelper.beanFactory = beanFactory;
 }
 /**
  * 根据名称获取容器中的对象实例
  * @param beanName ：注入的实例必须已经存在容器中，否则抛异常：NoSuchBeanDefinitionException
  * @return Object
  */
 public static Object getBean(String beanName) {
  return beanFactory.getBean(beanName);
 }
 /**
  * 根据 class 获取容器中的对象实例
  * @param requiredType ：被注入的必须已经存在容器中，否则抛异常：NoSuchBeanDefinitionException
  * @param <T> Class
  * @return 对象
  */
 public static <T> T getBean(Class<T> requiredType) {
  return beanFactory.getBean(requiredType);
 }
 /**
  * 判断 spring 容器中是否包含指定名称的对象
  * @param beanName bean名称
  * @return 是否存在
  */
 public static boolean containsBean(String beanName) {
  return beanFactory.containsBean(beanName);
 }
 //其它需求皆可参考 BeanFactory 接口和它的实现类
}

在上述工具类中，便是基于BeanFactoryAware的特性，获得了BeanFactory，然后再通过BeanFactory来获得指定的Bean。

该方案满足了获取Bean的基本需求，但同时具有使用BeanFactory的缺点。根据前文介绍的BeanFactory特性，可酌情使用。

上面提供了两种基于BeanFactory容器获得Bean的方式，下面则通过ApplicationContext来获取容器中的Bean，不同的是获取ApplicationContext的方式的区别。

3.3 方式三：启动获取ApplicationContext

在项目启动时先获取ApplicationContext对象，然后将其存储在一个地方，以便后续用到时进行使用。

这里提供两种场景的获取：

1.基于xml配置bean的形式，适用于比较古老的项目，已经很少使用了；

2.基于SpringBoot启动时获取ApplicationContext对象；

基于xml的形式实现：

// 其中applicationContext.xml 为配置容器的xml，不过现在一般很少使用了
ApplicationContext ac = new FileSystemXmlApplicationContext("applicationContext.xml");

这里等于直接初始化容器，并且获得容器的引用。这种方式适用于采用Spring框架的独立应用程序，需要程序通过配置文件手工初始化Spring的情况。目前大多数Spring项目已经不再采用xml配置，很少使用了。

基于SpringBoot启动实现：

@SpringBootApplication
public class ExampleApplication {

    public static void main(String[] args) {
        // 启动时，保存上下文，并保存为静态
        ConfigurableApplicationContext ac = SpringApplication.run(ExampleApplication.class, args);
        SpringContextUtil.setApplicationContext(ac);
    }
}

对应的SpringContextUtil类如下：

public class SpringContextUtil1 {

    private static ApplicationContext ac;

    public static <T>  T getBean(String beanName, Class<T> clazz) {
        T bean = ac.getBean(beanName, clazz);
        return bean;
    }

    public static void setApplicationContext(ApplicationContext applicationContext){
        ac = applicationContext;
    }
}

两种方式都是在启动Spring项目时，直接获取到ApplicationContext的引用，然后将其存储到工具类当中。在使用时，则从工具类中获取ApplicationContext容器，进而从中获得Bean对象。

3.4 方式四：通过继承ApplicationObjectSupport

此种方式依旧是先获得ApplicationContext容器，然后从中获取Bean对象，只不过是基于继承ApplicationObjectSupport类实现的。

具体实现代码：

@Component
public class SpringContextUtil extends ApplicationObjectSupport {
 public <T> T getBean(Class<T> clazz) {
  ApplicationContext ac = getApplicationContext();
  if(ac == null){
   return null;
  }
  return ac.getBean(clazz);
 }
}

注意，这里的SpringContextUtil类需要实例化。

ApplicationObjectSupport类图入下，我们看到它实现了ApplicationContextAware接口，在Spring容器初始化过程中回调方法setApplicationContext来完成ApplicationContext的赋值。

3.5 方式五：通过继承WebApplicationObjectSupport

WebApplicationObjectSupport是ApplicationObjectSupport的一个实现类，提供了Web相关的支持。实现原理与ApplicationObjectSupport一样。

具体实现代码如下：

@Component
public class SpringContextUtil extends WebApplicationObjectSupport {
 public <T> T getBean(Class<T> clazz) {
  ApplicationContext ac = getApplicationContext();
  if(ac == null){
   return null;
  }
  return ac.getBean(clazz);
 }
}

通过类图我们可以看到它是ApplicationObjectSupport的实现子类，此方式除了继承对象不同外，没有其他区别，都是基于getApplicationContext方法来获取。

3.6 方式六：通过WebApplicationContextUtils

Spring提供了工具类
WebApplicationContextUtils，通过该类可获取WebApplicationContext对象。

具体实现代码如下：

public class SpringContextUtil2 {
 public static <T> T getBean(ServletContext request, String name, Class<T> clazz){
  WebApplicationContext webApplicationContext = WebApplicationContextUtils.getRequiredWebApplicationContext(request);
  // 或者
  WebApplicationContext webApplicationContext1 = WebApplicationContextUtils.getWebApplicationContext(request);
//        webApplicationContext1.getBean(name, clazz)
  T bean = webApplicationContext.getBean(name, clazz);
  return bean;
 }
}

这个方法很常见于SpringMVC构建的Web项目中，适用于Web项目的B/S结构。

3.7 方式七：通过ApplicationContextAware

通过实现ApplicationContextAware接口，在Spring容器启动时将ApplicationContext注入进去，从而获取ApplicationContext对象，这种方法也是常见的获取Bean的一种方式，推荐使用。

具体实现代码如下：

@Component
public class SpringContextUtil3 implements ApplicationContextAware {

 private static ApplicationContext ac;

 @Override
 public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
  ac = applicationContext;
 }

 public static <T> T getBean(Class<T> clazz) {
  T bean = ac.getBean(clazz);
  return bean;
 }

}

这种方式与前面通过BeanFactoryAware获得BeanFactory的思路一致。其本质和四、五两种方式一样。

3.8 方式八：通过ContextLoader

使用ContextLoader提供的
getCurrentWebApplicationContext方法，也是常用的获取WebApplicationContext的一种方法。

具体实现代码如下：

WebApplicationContext wac = ContextLoader.getCurrentWebApplicationContext();
wac.getBean(beanID);

该方法常见于SpringMVC实现的Web项目中。该方式是一种不依赖于Servlet，不需要注入的方式。但是需要注意一点，在服务器启动时和Spring容器初始化时，不能通过该方法获取Spring容器。

3.9 方式九：通过BeanFactoryPostProcessor

Spring工具类，方便在非Spring管理环境中获取Bean。

@Component
public final class SpringUtils implements BeanFactoryPostProcessor{
    
    /** Spring应用上下文环境 */
    private static ConfigurableListableBeanFactory beanFactory;

    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException{
        SpringUtilsS.beanFactory = beanFactory;
    }

    /**
     * 获取对象
     *
     * @param name
     * @return Object 一个以所给名字注册的bean的实例
     * @throws BeansException
     *
     */
    @SuppressWarnings("unchecked")
    public static <T> T getBean(String name) throws BeansException{
        return (T) beanFactory.getBean(name);
    }

    /**
     * 获取类型为requiredType的对象
     *
     * @param clz
     * @return
     * @throws BeansException
     *
     */
    public static <T> T getBean(Class<T> clz) throws BeansException{
        T result = (T) beanFactory.getBean(clz);
        return result;
    }

    /**
     * 如果BeanFactory包含一个与所给名称匹配的bean定义，则返回true
     *
     * @param name
     * @return boolean
     */
    public static boolean containsBean(String name){
        return beanFactory.containsBean(name);
    }

    /**
     * 判断以给定名字注册的bean定义是一个singleton还是一个prototype。 如果与给定名字相应的bean定义没有被找到，将会抛出一个异常（NoSuchBeanDefinitionException）
     *
     * @param name
     * @return boolean
     * @throws NoSuchBeanDefinitionException
     *
     */
    public static boolean isSingleton(String name) throws NoSuchBeanDefinitionException{
        return beanFactory.isSingleton(name);
    }

    /**
     * @param name
     * @return Class 注册对象的类型
     * @throws NoSuchBeanDefinitionException
     *
     */
    public static Class<?> getType(String name) throws NoSuchBeanDefinitionException{
        return beanFactory.getType(name);
    }

    /**
     * 如果给定的bean名字在bean定义中有别名，则返回这些别名
     *
     * @param name
     * @return
     * @throws NoSuchBeanDefinitionException
     *
     */
    public static String[] getAliases(String name) throws NoSuchBeanDefinitionException{
        return beanFactory.getAliases(name);
    }

    /**
     * 获取aop代理对象
     * 
     * @param invoker
     * @return
     */
    @SuppressWarnings("unchecked")
    public static <T> T getAopProxy(T invoker){
        return (T) AopContext.currentProxy();
    }
}

其中
ConfigurableListableBeanFactory接口，也属于BeanFactory的子接口。

4 总结

在本文中介绍了9种从Spring容器中获取Bean的方法，虽然每种方式实现各有不同，但从本质上来讲，无非就是通过BeanFactory或ApplicationContext获取Bean，只不过获取BeanFactory或ApplicationContext容器的方式不同而已。严格来说ApplicationContext也是BeanFactory。

那么，你是否意识到，学习一项技术或一个实现方式，只要把握住它的根本，无论形式如何变化，都万变不离其宗。而这里“宗”就是IoC容器。

作者：京东零售曾登均

来源：京东云开发者社区

微信关注我们

原文链接：https://my.oschina.net/u/4090830/blog/10086266

转载内容版权归作者及来源网站所有！

低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。

数据库模型设计案例分享（GaussDB版）

目录一、前言二、应用系统数据库设计的基本流程三、数据库模型设计 1、概念结构设计阶段 2、逻辑结构设计阶段 3、物理结构设计阶段四、小结一、前言 GaussDB数据库是一款企业级分布式数据库，支持集中式和分布式两种部署形态。它面向金融互联网交易和政企OA/办公等场景，具有安全可靠、超高性能、简单易用等优势。在GaussDB中，数据建模是非常重要的一部分。数据建模是指根据业务需求和数据特点，将现实世界中的实体、属性、关系等概念抽象出来，并用一定的方式表示成计算机可以理解的形式。数据库模型设计的目的是为了建立一个能够满足业务需求的数据存储结构，使得数据的存储、查询、更新等操作更加高效、可靠、安全。在GaussDB中，可以使用E-R图来进行数据建模，E-R图也称实体-联系图(Entity Relationship Diagram)，提供了表示实体类型、属性和联系的方法，用来描述现实世界的概念模型，它可以帮助您更好地理解您的业务逻辑并将其转换为关系模型。二、应用系统数据库设计的基本流程应用系统数据库设计基本流程简图：第一步：需求分析：主要包括数据、功能、性能等第二步：数据...

2023-07-04

459

并发指同一时间内进行了多个线程。并发问题是多个线程对同一资源进行操作时产生的问题。通过加锁可以解决并发问题，ReentrantLock是锁的一种。 1 ReentrantLock 1.1 定义 ReentrantLock是Lock接口的实现类，可以手动的对某一段进行加锁。ReentrantLock可重入锁，具有可重入性，并且支持可中断锁。其内部对锁的控制有两种实现，一种为公平锁，另一种为非公平锁. 1.2 实现原理 ReentrantLock的实现原理为volatile+CAS。想要说明volatile和CAS首先要说明JMM。 1.2.1 JMM JMM(java 内存模型 Java Memory Model 简称JMM) 本身是一个抽象的概念,并不在内存中真实存在的,它描述的是一组规范或者规则,通过这组规范定义了程序中各个变量的访问方式. 由于 JMM 运行程序的实体是线程.而每个线程创建时JMM都会为其创建一个自己的工作内存(栈空间),工作内存是每个线程的私有数据区域.而java内存模型中规定所有的变量都存储在主内存中,主内存是共享内存区域,所有线程都可以访问,但线程的变量的操...

2023-07-04

302

资源下载

更多资源

Mario

马里奥是站在游戏界顶峰的超人气多面角色。马里奥靠吃蘑菇成长，特征是大鼻子、头戴帽子、身穿背带裤，还留着胡子。与他的双胞胎兄弟路易基一起，长年担任任天堂的招牌角色。

腾讯云软件源

为解决软件依赖安装时官方源访问速度慢的问题，腾讯云为一些软件搭建了缓存服务。您可以通过使用腾讯云软件源站来提升依赖包的安装速度。为了方便用户自由搭建服务架构，目前腾讯云软件源站支持公网访问和内网访问。

Rocky Linux

Rocky Linux（中文名：洛基）是由Gregory Kurtzer于2020年12月发起的企业级Linux发行版，作为CentOS稳定版停止维护后与RHEL（Red Hat Enterprise Linux）完全兼容的开源替代方案，由社区拥有并管理，支持x86_64、aarch64等架构。其通过重新编译RHEL源代码提供长期稳定性，采用模块化包装和SELinux安全架构，默认包含GNOME桌面环境及XFS文件系统，支持十年生命周期更新。

Sublime Text

Sublime Text具有漂亮的用户界面和强大的功能，例如代码缩略图，Python的插件，代码段等。还可自定义键绑定，菜单和工具栏。Sublime Text 的主要功能包括：拼写检查，书签，完整的 Python API ， Goto 功能，即时项目切换，多选择，多窗口等等。Sublime Text 是一个跨平台的编辑器，同时支持Windows、Linux、Mac OS X等操作系统。