Bean放入Spring容器中的五种方式
1、@Configuration + @Bean
最常用的一种方式，@Configuration用来声明一个配置类，然后使用 @Bean 注解，用于声明一个bean，将其加入到Spring容器中。
@Configuration
public class MyConfiguration {
@Bean
public UserInfo userInfo(){
UserInfo userInfo = new UserInfo();
userInfo.setName("张三");
return userInfo;
}
}
2、@Componet + @ComponentScan
@Componet中文译为组件，放在类名上面，然后@ComponentScan放置在我们的配置类上，然后可以指定一个bean对象路径，进行扫描带有@Componet注解的bean，然后加至容器中。
@Data
@Component
public class UserInfo implements Serializable {
private String name;
}
@ComponentScan(basePackages = "top.andoudou.*")
public class Demo1 {
public static void main(String[] args) {
AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class);
UserInfo bean = applicationContext.getBean(UserInfo.class);
System.out.println(bean);
}
}
结果输出:
UserInfo{name='null'}
表示成功将UserInfo放置在了IOC容器中
3、@Import注解导入
在进行Spring扩展时经常会用到，它经常搭配自定义注解进行使用，然后往容器中导入一个配置文件。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Import {
/**
* 用于导入一个class文件
* {@link Configuration @Configuration}, {@link ImportSelector},
* {@link ImportBeanDefinitionRegistrar}, or regular component classes to import.
*/
Class<?>[] value();
}
3.1、@Import直接导入类
代码示例如下:
@Data
public class UserInfo implements Serializable {
private String name;
}
/**
* 直接使用@Import导入userInfo类，然后尝试从applicationContext中取，成功拿到
**/
@Import(UserInfo.class)
public class Demo1 {
public static void main(String[] args) {
AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class);
UserInfo bean = applicationContext.getBean(UserInfo.class);
System.out.println(bean);
}
}
上述代码直接使用@Import导入了一个类，然后自动的就被放置在IOC容器中了。
注意：我们的UserInfo类上 就不需要任何的注解了，直接导入即可。
3.2、@Import + ImportSelector
实现一个ImportSelector的接口，然后实现其中的方法，进行导入。
代码如下:
@Import(MyImportSelector.class)
public class Demo1 {
public static void main(String[] args) {
AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class);
UserInfo bean = applicationContext.getBean(UserInfo.class);
System.out.println(bean);
}
}
class MyImportSelector implements ImportSelector {
@Override
public String[] selectImports(AnnotationMetadata importingClassMetadata) {
return new String[]{"top.andoudou.test.UserInfo"};
}
}
我自定义了一个 MyImportSelector 实现了 ImportSelector 接口，重写selectImports 方法，然后将我们要导入的类的全路径名写在里面即可。
3.3、@Import + ImportBeanDefinitionRegistrar
这种方式也需要我们实现 ImportBeanDefinitionRegistrar 接口中的方法，具体代码如下:
@Import(MyImportBeanDefinitionRegistrar.class)
public class Demo1 {
public static void main(String[] args) {
AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class);
UserInfo bean = applicationContext.getBean(UserInfo.class);
System.out.println(bean);
}
}
class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
@Override
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
// 构建一个beanDefinition, 可以简单理解为bean的定义.
AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(UserInfo.class).getBeanDefinition();
// 将beanDefinition注册到Ioc容器中.
registry.registerBeanDefinition("userInfo", beanDefinition);
}
}
上述实现其实和Import的第二种方式差不多，都需要去实现接口，然后进行导入。BeanDefinition，可以简单理解为bean的定义(bean的元数据)，也是需要放在IOC容器中进行管理的，先有bean的元数据，applicationContext再根据bean的元数据去创建Bean。
3.4、@Import + DeferredImportSelector
这种方式也需要我们进行实现接口，其实它和@Import的第二种方式差不多，DeferredImportSelector 它是 ImportSelector 的子接口，所以实现的方法和第二种无异。只是Spring的处理方式不同，它和Spring Boot中的自动导入配置文件 延迟导入有关，非常重要。使用方式如下:
@Import(MyDeferredImportSelector.class)
public class Demo1 {
public static void main(String[] args) {
AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class);
UserInfo bean = applicationContext.getBean(UserInfo.class);
System.out.println(bean);
}
}
class MyDeferredImportSelector implements DeferredImportSelector {
@Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
// 也是直接将UserInfo的全限定名放进去
return new String[]{UserInfo.class.getName()};
}
}
关于@Import注解的使用方式，大概就以上三种，当然它还可以搭配@Configuration注解使用，用于导入一个配置类。
4、使用FactoryBean接口
FactoryBean接口和BeanFactory千万不要弄混了，从名字其实可以大概的区分开，FactoryBean, 后缀为bean，那么它其实就是一个bean, BeanFactory，顾名思义 bean工厂，它是IOC容器的顶级接口。
代码示例:
@Configuration
public class Demo1 {
@Bean
public UserInfoFactoryBean userInfoFactoryBean() {
return new UserInfoFactoryBean();
}
public static void main(String[] args) {
AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class);
UserInfo bean = applicationContext.getBean(UserInfo.class);
System.out.println(bean);
}
}
class UserInfoFactoryBean implements FactoryBean<UserInfo> {
/**
* 直接new出来UserInfo进行返回.
*/
@Override
public UserInfo getObject() throws Exception {
return new UserInfo();
}
/**
* 指定返回bean的类型.
*/
@Override
public Class<?> getObjectType() {
return UserInfo.class;
}
}
使用@Configuration + @Bean的方式将 UserInfoFactoryBean 加入到容器中，注意，我没有向容器中注入 UserInfo, 而是直接注入的 UserInfoFactoryBean 然后从容器中拿UserInfo这个类型的bean,成功运行。
5、使用 BeanDefinitionRegistryPostProcessor
这种方式也是利用到了 BeanDefinitionRegistry，在Spring容器启动的时候会执行 BeanDefinitionRegistryPostProcessor 的 postProcessBeanDefinitionRegistry 方法，大概就是等beanDefinition加载完毕之后，对beanDefinition进行后置处理，可以在此进行调整IOC容器中的beanDefinition，从而干扰到后面进行初始化bean。
具体代码如下:
public class Demo1 {
public static void main(String[] args) {
AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext();
MyBeanDefinitionRegistryPostProcessor beanDefinitionRegistryPostProcessor = new MyBeanDefinitionRegistryPostProcessor();
applicationContext.addBeanFactoryPostProcessor(beanDefinitionRegistryPostProcessor);
applicationContext.refresh();
UserInfo bean = applicationContext.getBean(UserInfo.class);
System.out.println(bean);
}
}
class MyBeanDefinitionRegistryPostProcessor implements BeanDefinitionRegistryPostProcessor {
@Override
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(UserInfo.class).getBeanDefinition();
registry.registerBeanDefinition("userInfo", beanDefinition);
}
@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
}
}
上述代码中，手动向beanDefinitionRegistry中注册了UserInfo的BeanDefinition。最终成功将userInfo加入到applicationContext中。
小结
向spring容器中加入bean的几种方式：
- @Configuration + @Bean
- @ComponentScan + @Component
- @Import 配合接口进行导入
- 使用FactoryBean。
- 实现BeanDefinitionRegistryPostProcessor进行后置处理。
注意：本文归作者所有，未经作者允许，不得转载
