【Spring】八种常见Bean加载方式

🚩本文已收录至专栏：Spring家族学习

一.引入

(1) 概述

​ 关于bean的加载方式，spring提供了各种各样的形式。因为spring管理bean整体上来说就是由spring维护对象的生命周期，所以bean的加载可以从大的方面划分成2种形式：

• 已知类通过（类名.class）交给spring管理
• 已知类名通过（类名字符串）并交给spring管理。

两种形式内部其实都一样，都是通过spring的BeanDefinition对象初始化spring的bean。

1. bean的定义由前期xml配置逐步演化成注解配置，本质是一样的，都是通过反射机制加载类名后创建对象，对象就是spring管控的bean
2. @Import注解可以指定加载某一个类作为spring管控的bean，如果被加载的类中还具有@Bean相关的定义，会被一同加载
3. spring开放出了若干种可编程控制的bean的初始化方式，通过分支语句由固定的加载bean转成了可以选择bean是否加载或者选择加载哪一种bean

本文介绍八种常见的bean加载方式：

1. xml
2. xml+注解
3. 注解
4. @Import导入
5. 使用register方法编程形式注册
6. @Import导入实现ImportSelector接口的类
7. @Import导入实现ImportBeanDefinitionRegistrar接口的类
8. @Import导入实现BeanDefinitionRegistryPostProcessor接口的类

此外还介绍一些相关涉及知识

1. @Bean定义FactoryBean接口
2. @ImportResource
3. @Configuration注解的proxyBeanMethods属性

(2) 环境搭建

在开始讲解之前，我们需要先介绍一下测试所用的环境。

1. 创建Maven工程，可以选择导入如下Spring坐标用于测试

		<dependency><groupId>org.springframework</groupId><artifactId>spring-context</artifactId><version>5.3.9</version></dependency>
<!--     演示加载第三方bean--><dependency><groupId>com.alibaba</groupId><artifactId>druid</artifactId><version>1.1.16</version></dependency>

2. 创建一些用于后续示例演示的bean
   

二.八种加载方式

(1) XML方式

​ 最初级的bean的加载方式其实可以直击spring管控bean的核心思想，就是提供类名，然后spring就可以管理了。所以第一种方式就是给出bean的类名，至于内部就是通过反射机制加载成class。

1. 创建Spring的xml配置文件，通过其中的 <bean/>标签加载bean，我们可以在其中声明加载自己创建的bean,也可以加载第三方开发的bean。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd"><!--xml方式声明 自己 开发的bean--><bean class="com.guanzhi.bean.Cat"/><bean class="com.guanzhi.bean.Dog"/><!--xml方式声明 第三方 开发的bean--><bean class="com.alibaba.druid.pool.DruidDataSource"/></beans>

2. 我们可以测试一下是否成功加载了这些bean

public class App {public static void main(String[] args) {// 加载配置文件ApplicationContext ctx = new ClassPathXmlApplicationContext("applicationContext.xml");// 获取所有已加载bean的名称String[] names = ctx.getBeanDefinitionNames();// 打印查看for (String name : names) {System.out.println(name);}}
}

3. 启动我们可以发现成功加载到了上述配置的三个bean
   

(2) XML+注解方式

​ 由于方式一种需要将spring管控的bean全部写在xml文件中，对于程序员来说非常不友好，所以就有了第二种方式。哪一个类要受到spring管控加载成bean，就在这个类的上面加一个注解，还可以顺带起一个bean的名字（id）。这里可以使用的注解有@Component以及三个衍生注解@Service、@Controller、@Repository。

1. 例如我们可以在上述Cat类和Mouse类中加上注解

package com.guanzhi.bean;@Component("tom")
public class Cat {
}

package com.guanzhi.bean;@Service
public class Mouse {
}

​ 当然，由于我们无法在第三方提供的技术源代码中去添加上述4个注解，因此当你需要加载第三方开发的bean的时候可以使用下列方式定义注解式的bean。将@Bean定义在一个方法上方，当前方法的返回值就可以交给spring管控，注意，这个方法所在的类一定要定义在@Configuration修饰的类中。

package com.guanzhi.config;@Configuration
public class DbConfig {@Beanpublic DruidDataSource dataSource(){DruidDataSource ds = new DruidDataSource();return ds;}
}

​ 2. 仅仅如此还是不够，上面提供的只是bean的声明，spring并没有感知到这些东西。想让spring感知到这些声明，必须设置spring去检查这些类。我们可以通过下列xml配置设置spring去检查哪些包，发现定了对应注解，就将对应的类纳入spring管控范围，声明成bean。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"xmlns:context="http://www.springframework.org/schema/context"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.springframework.org/schema/beanshttp://www.springframework.org/schema/beans/spring-beans.xsdhttp://www.springframework.org/schema/contexthttp://www.springframework.org/schema/context/spring-context.xsd"><!--指定扫描加载bean的位置--><context:component-scan base-package="com.guanzhi.bean,com.guanzhi.config"/>
</beans>

3. 同样我们可以测试一下是否成功加载了这些bean

public class App {public static void main(String[] args) {// 加载配置文件ApplicationContext ctx = new ClassPathXmlApplicationContext("applicationContext.xml");// 获取所有已加载bean的名称String[] names = ctx.getBeanDefinitionNames();// 打印查看for (String name : names) {System.out.println(name);}}
}

3. 启动我们可以发现成功加载到了上述配置的三个bean
   

方式二声明bean的方式是目前企业中较为常见的bean的声明方式，但是也有缺点。方式一中，通过一个配置文件，你可以查阅当前spring环境中定义了多少个或者说多少种bean，但是方式二没有任何一个地方可以查阅整体信息，只有当程序运行起来才能感知到加载了多少个bean。

(3) 注解方式声明配置类

​ 方式二已经完美的简化了bean的声明，以后再也不用写茫茫多的配置信息了。仔细观察xml配置文件，会发现这个文件中只剩了扫描包这句话，于是就有人提出，使用java类替换掉这种固定格式的配置，所以下面这种格式就出现了。

1. 定义一个类并使用@ComponentScan替代原始xml配置中的包扫描这个动作，其实功能基本相同。

@ComponentScan({"com.guanzhi.bean","com.guanzhi.config"})
public class SpringConfig {
}

2. 同样我们可以测试一下是否成功加载了这些bean

public class App {public static void main(String[] args) {// 加载配置文件ApplicationContext ctx = new AnnotationConfigApplicationContext(SpringConfig.class);// 获取所有已加载bean的名称String[] names = ctx.getBeanDefinitionNames();// 打印查看for (String name : names) {System.out.println(name);}}
}

3. 启动我们可以发现成功加载了这些bean
   

(4) @Import注解注入

​ 使用扫描的方式加载bean是企业级开发中常见的bean的加载方式，但是由于扫描的时候不仅可以加载到你要的东西，还有可能加载到各种各样的乱七八糟的东西。

​ 有人就会奇怪，会有什么问题呢？比如你扫描了com.guanzhi.service包，后来因为业务需要，又扫描了com.guanzhi.dao包，你发现com.guanzhi包下面只有service和dao这两个包，这就简单了，直接扫描com.guanzhi就行了。但是万万没想到，十天后你加入了一个外部依赖包，里面也有com.guanzhi包，这下便加载了许多不需要的东西。

​ 所以我们需要一种精准制导的加载方式，使用@Import注解就可以解决你的问题。它可以加载所有的一切，只需要在注解的参数中写上加载的类对应的.class即可。有人就会觉得，还要自己手写，多麻烦，不如扫描好用。 但是他可以指定加载啊，好的命名规范配合@ComponentScan可以解决很多问题，但是@Import注解拥有其重要的应用场景。有没有想过假如你要加载的bean没有使用@Component修饰呢？这下就无解了，而@Import就无需考虑这个问题。

@Import({Dog.class})
public class SpringConfig {
}

被导入的bean无需使用注解声明为bean

public class Dog {
}

此形式可以有效的降低源代码与Spring技术的耦合度，在spring技术底层及诸多框架的整合中大量使用

除了加载bean，还可以使用@Import注解加载配置类。其实本质上是一样的。

@Import(Dbconfig.class)
public class SpringConfig {
}

(5) 编程形式注册bean

​ 前面介绍的加载bean的方式都是在容器启动阶段完成bean的加载，下面这种方式就比较特殊了，可以在容器初始化完成后手动加载bean。通过这种方式可以实现编程式控制bean的加载。

public class App {public static void main(String[] args) {AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(SpringConfig.class);//上下文容器对象已经初始化完毕后，手工加载beanctx.register(Mouse.class);ctx.register(Dog.class);ctx.register(Cat.class);}
}

​ 其实这种方式坑还是挺多的，比如容器中已经有了某种类型的bean，再加载会不会覆盖呢？这都是要思考和关注的问题。

public class App {public static void main(String[] args) {AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(SpringConfig.class);//上下文容器对象已经初始化完毕后，手工加载beanctx.registerBean("tom", Cat.class,0);ctx.registerBean("tom", Cat.class,1);ctx.registerBean("tom", Cat.class,2);System.out.println(ctx.getBean(Cat.class));}
}

运行可以发现，后加载的覆盖了之前加载的

(6) 导入实现ImportSelector接口的类

​ 在方式五中，我们感受了bean的加载可以进行编程化的控制，添加if语句就可以实现bean的加载控制了。但是毕竟是在容器初始化后实现bean的加载控制，那是否可以在容器初始化过程中进行控制呢？答案是必须的。实现ImportSelector接口的类可以设置加载的bean的全路径类名，记得一点，只要能编程就能判定，能判定意味着可以控制程序的运行走向，进而控制一切。

public class MyImportSelector implements ImportSelector { @Overridepublic String[] selectImports(AnnotationMetadata metadata) {// 各种条件的判定，判定完毕后，决定是否装载指定的bean// 判断是否满足xx条件，满足则加载xx，否则xxboolean flag = metadata.hasAnnotation("org.springframework.context.annotation.Configuration");if(flag){return new String[]{"com.guanzhi.bean.Dog"};}return new String[]{"com.guanzhi.bean.Cat"};}
}

在配置类中导入

//@Configuration
@Import(MyImportSelector.class)
public class SpringConfig {
}

编写测试类

public class App {public static void main(String[] args) {ApplicationContext ctx = new AnnotationConfigApplicationContext(SpringConfig.class);String[] names = ctx.getBeanDefinitionNames();for (String name : names) {System.out.println(name);}System.out.println("----------------------");}
}

运行可以发现，根据MyImportSelector中的判断条件，如果在SpringConfig加上Configuration注解得打印com.guanzhi.bean.Cat，否则打印com.guanzhi.bean.Dog。如此我们便实现了Bean的动态加载。

(7) 导入实现ImportBeanDefinitionRegistrar接口的类

​ 方式六中提供了给定类全路径类名控制bean加载的形式，如果对spring的bean的加载原理比较熟悉的小伙伴知道，其实bean的加载不是一个简简单单的对象，spring中定义了一个叫做BeanDefinition的东西，它才是控制bean初始化加载的核心。BeanDefinition接口中给出了若干种方法，可以控制bean的相关属性。说个最简单的，创建的对象是单例还是非单例，在BeanDefinition中定义了scope属性就可以控制这个。

如果你感觉方式六没有给你开放出足够的对bean的控制操作，那么方式七你值得拥有。我们可以通过定义一个类，然后实现ImportBeanDefinitionRegistrar接口的方式定义bean，并且还可以让你对bean的初始化进行更加细粒度的控制.

public class MyRegistrar implements ImportBeanDefinitionRegistrar {@Overridepublic void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {BeanDefinition beanDefinition = 	BeanDefinitionBuilder.rootBeanDefinition(Dog.class).getBeanDefinition();registry.registerBeanDefinition("dog",beanDefinition);}
}

在配置类中导入

@Import(MyRegistrar.class)
public class SpringConfig {
}

测试

public class App {public static void main(String[] args) {ApplicationContext ctx = new AnnotationConfigApplicationContext(SpringConfig.class);String[] names = ctx.getBeanDefinitionNames();for (String name : names) {System.out.println(name);}}
}

(8) 导入实现BeanDefinitionRegistryPostProcessor接口的类

​ 上述七种方式都是在容器初始化过程中进行bean的加载或者声明，但是这里有一个bug。这么多种方式，它们之间如果有冲突怎么办？谁能有最终裁定权？这是个好问题，当某种类型的bean被接二连三的使用各种方式加载后，在你对所有加载方式的加载顺序没有完全理解清晰之前，你还真不知道最后谁说了算。

​ BeanDefinitionRegistryPostProcessor，看名字知道，BeanDefinition意思是bean定义，Registry注册的意思，Post后置，Processor处理器，全称bean定义后处理器,在所有bean注册都加载完后，它是最后一个运行的,实现对容器中bean的最终裁定.

public class MyPostProcessor implements BeanDefinitionRegistryPostProcessor {@Overridepublic void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {BeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(Dog.class).getBeanDefinition();registry.registerBeanDefinition("Dog",beanDefinition);}
}

使用与上述一致

三.相关补充

(1) FactroyBean接口

​ spring提供了一个接口FactoryBean，也可以用于声明bean，只不过实现了FactoryBean接口的类造出来的对象不是当前类的对象，而是FactoryBean接口泛型指定类型的对象。如下列，造出来的bean并不是DogFactoryBean，而是Dog。这有什么用呢？它可以帮助我们在对象初始化前做一些事情。

// 创建一个类实现FactoryBean接口
public class DogFactoryBean implements FactoryBean<Dog> {@Overridepublic Dog getObject() throws Exception {Dog dog = new Dog();// 扩展要做的其他事情.....return dog;}@Overridepublic Class<?> getObjectType() {return Dog.class;}// 是否为单例@Overridepublic boolean isSingleton() {return true;}
}

​ 有人说，注释中的代码写入Dog的构造方法不就行了吗？干嘛这么费劲转一圈，还写个类，还要实现接口，多麻烦啊。还真不一样，你可以理解为Dog是一个抽象后剥离的特别干净的模型，但是实际使用的时候必须进行一系列的初始化动作。只不过根据情况不同，初始化动作不同而已。如果写入Dog，或许初始化动作A当前并不能满足你的需要，这个时候你就要做一个DogB的方案了。如此，你就要做两个Dog类。而使用FactoryBean接口就可以完美解决这个问题。

​ 通常实现了FactoryBean接口的类使用@Bean的形式进行加载，当然也可以使用@Component去声明DogFactoryBean，只要被扫描加载到即可。

@ComponentScan({"com.guanzhi.bean","com.guanzhi.config"})
public class SpringConfig {@Beanpublic DogFactoryBean dog(){return new DogFactoryBean();}
}

(2) 注解导入XML配置的bean

​ 由于早起开发的系统大部分都是采用xml的形式配置bean，现在的企业级开发基本上不用这种模式了。但是如果你特别幸运，需要基于之前的系统进行二次开发，这就尴尬了。新开发的用注解格式，之前开发的是xml格式。这个时候可不是让你选择用哪种模式的，而是两种要同时使用。spring提供了一个注解可以解决这个问题，@ImportResource，在配置类上直接写上要被融合的xml配置文件名即可，算的上一种兼容性解决方案。

@Configuration
@ComponentScan("com.guanzhi")
@ImportResource("applicationContext.xml")
public class SpringConfig {
}

(3) proxyBeanMethods属性

​ 前面的例子中用到了@Configuration这个注解，它可以保障配置类中使用方法创建的bean的唯一性，使我们得到的对象是从容器中获取的而不是重新创建的。只需为@Configuration注解设置proxyBeanMethods属性值为true即可，由于此属性默认值为true，所以很少看见明确书写的，除非想放弃此功能。

@Configuration(proxyBeanMethods = true)
public class SpringConfig {@Beanpublic Cat cat(){return new Cat();}
}

​ 下面通过容器再调用上面的cat方法时，得到的就是同一个对象了。注意，必须使用spring容器对象调用此方法才有保持bean唯一性的特性。此特性在很多底层源码中有应用，在MQ中也应用了此特性。

public class App {public static void main(String[] args) {ApplicationContext ctx = new AnnotationConfigApplicationContext(SpringConfig.class);SpringConfig springConfig = ctx.getBean("springConfig", SpringConfig.class);System.out.println(springConfig.cat());System.out.println(springConfig.cat());System.out.println(springConfig.cat());}
}