Spring容器加入bean的几种方式

2022-10-22 09:57:16

一、五种方式简介

  • @Configuration + @Bean
  • @ComponentScan + @Component
  • @Import 配合接口进行导入
  • 使用FactoryBean。
  • 实现BeanDefinitionRegistryPostProcessor进行后置处理。

二、五种方式具体介绍

1、@Configuration + @Bean

@Configuration用来声明一个配置类,然后使用@Bean 注解,用于声明一个bean,将其加入到Spring容器中。这种方式是我们最常用的一种

@ConfigurationpublicclassMyConfiguration{@BeanpublicPersonperson(){Person person=newPerson();
        person.setName("spring");return person;}}

2、@Componet + @ComponentScan

@Componet中文译为组件,放在类名上面,然后@ComponentScan放置在我们的配置类上,然后可以指定一个路径,进行扫描带有@Componet注解的bean,然后加至容器中。这种方式也较为常用,spring扫描包路径就是使用这种方式,这样可以一下子扫描很多个bean到容器

// 该类在com.shawn.*包下面@ComponentpublicclassPerson{privateString name;publicStringgetName(){return name;}publicvoidsetName(String name){this.name= name;}@OverridepublicStringtoString(){return"Person{"+"name='"+ name+'\''+'}';}}//*代表该包下匹配的所有包和类@ComponentScan(basePackages="com.shawn.*")publicclassDemo{publicstaticvoidmain(String[] args){AnnotationConfigApplicationContext applicationContext=newAnnotationConfigApplicationContext(Demo.class);Person bean= applicationContext.getBean(Person.class);//结果输出Person{name='null'}System.out.println(bean);}}

3、@Import注解导入

@Import注解用到的并不是很多,但是非常重要,在进行Spring扩展时经常会用到。它通过搭配自定义注解进行使用,然后往容器中导入一个配置文件。它有四种使用方式。

@Import注解的源码,表示只能放置在类上

@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic@interfaceImport{/**
   * 用于导入一个class文件
     * {@link Configuration @Configuration}, {@link ImportSelector},
     * {@link ImportBeanDefinitionRegistrar}, or regular component classes to import.
     */Class<?>[]value();}

1、Import直接导入类

直接使用@Import导入了一个类,然后自动的就被放置在IOC容器中了。注意我们的Person类上 就不需要任何的注解了,直接导入即可

publicclassPerson{privateString name;publicStringgetName(){return name;}publicvoidsetName(String name){this.name= name;}@OverridepublicStringtoString(){return"Person{"+"name='"+ name+'\''+'}';}}/**
* 直接使用@Import导入person类,然后尝试从applicationContext中取,成功拿到
**/@Import(Person.class)publicclassDemo{publicstaticvoidmain(String[] args){AnnotationConfigApplicationContext applicationContext=newAnnotationConfigApplicationContext(Demo.class);Person bean= applicationContext.getBean(Person.class);System.out.println(bean);}}

2、@Import + ImportSelector

自定义了一个MyImportSelector 实现了ImportSelector 接口,重写selectImports方法,然后将我们要导入的类的全限定名写在里面即可导入

@Import(MyImportSelector.class)publicclassDemo{publicstaticvoidmain(String[] args){AnnotationConfigApplicationContext applicationContext=newAnnotationConfigApplicationContext(Demo.class);Person bean= applicationContext.getBean(Person.class);System.out.println(bean);}}classMyImportSelectorimplementsImportSelector{@OverridepublicString[]selectImports(AnnotationMetadata importingClassMetadata){//这里需要具体到类名returnnewString[]{"com.shawn.Person"};}}

3、@Import + ImportBeanDefinitionRegistrar

这种方式需要实现ImportBeanDefinitionRegistrar 接口中的方法。BeanDefinition可以简单理解为bean的定义(bean的元数据),也是需要放在IOC容器中进行管理的,先有bean的元数据,applicationContext再根据bean的元数据去创建Bean。

@Import(MyImportBeanDefinitionRegistrar.class)publicclassDemo{publicstaticvoidmain(String[] args){AnnotationConfigApplicationContext applicationContext=newAnnotationConfigApplicationContext(Demo.class);Person bean= applicationContext.getBean(Person.class);System.out.println(bean);}}classMyImportBeanDefinitionRegistrarimplementsImportBeanDefinitionRegistrar{@OverridepublicvoidregisterBeanDefinitions(AnnotationMetadata importingClassMetadata,BeanDefinitionRegistry registry){// 构建一个beanDefinitionAbstractBeanDefinition beanDefinition=BeanDefinitionBuilder.rootBeanDefinition(Person.class).getBeanDefinition();// 将beanDefinition注册到Ioc容器中
        registry.registerBeanDefinition("person", beanDefinition);}}

4、@Import + DeferredImportSelector

这种方式也需要我们进行实现接口,其实它和@Import的第二种方式差不多,DeferredImportSelector 它是ImportSelector 的子接口,所以实现的方法和第二种无异。只是Spring的处理方式不同,它和Spring Boot中的自动导入配置文件延迟导入有关,非常重要

@Import(MyDeferredImportSelector.class)publicclassDemo{publicstaticvoidmain(String[] args){AnnotationConfigApplicationContext applicationContext=newAnnotationConfigApplicationContext(Demo.class);Person bean= applicationContext.getBean(Person.class);System.out.println(bean);}}classMyDeferredImportSelectorimplementsDeferredImportSelector{@OverridepublicString[]selectImports(AnnotationMetadata importingClassMetadata){// 也是直接将Person的全限定名放进去returnnewString[]{Person.class.getName()};}}

上述三类还可以搭配@Configuration注解使用,用于导入一个配置类

4、使用FactoryBean接口

FactoryBean接口和BeanFactory不一样,BeanFactory顾名思义 bean工厂,它是IOC容器的顶级接口。

下述代码通过@Configuration + @Bean的方式将PersonFactoryBean 加入到容器中,注意,我没有向容器中注入Person, 而是直接注入的PersonFactoryBean 然后从容器中拿Person这个类型的bean,成功运行。

@ConfigurationpublicclassDemo{@BeanpublicPersonFactoryBeanpersonFactoryBean(){returnnewPersonFactoryBean();}publicstaticvoidmain(String[] args){AnnotationConfigApplicationContext applicationContext=newAnnotationConfigApplicationContext(Demo.class);Person bean= applicationContext.getBean(Person.class);System.out.println(bean);}}classPersonFactoryBeanimplementsFactoryBean<Person>{/**
     *  直接new出来Person进行返回.
     */@OverridepublicPersongetObject()throwsException{returnnewPerson();}/**
     *  指定返回bean的类型.
     */@OverridepublicClass<?>getObjectType(){returnPerson.class;}}

5、使用 BeanDefinitionRegistryPostProcessor

这种方式也是利用到了BeanDefinitionRegistry,在Spring容器启动的时候会执行BeanDefinitionRegistryPostProcessorpostProcessBeanDefinitionRegistry 方法,大概意思就是等beanDefinition加载完毕之后,对beanDefinition进行后置处理,可以在此进行调整IOC容器中的beanDefinition,从而干扰到后面进行初始化bean。

下述代码中我们手动向beanDefinitionRegistry中注册了person的BeanDefinition,最终成功将person加入到applicationContext中

publicclassDemo{publicstaticvoidmain(String[] args){AnnotationConfigApplicationContext applicationContext=newAnnotationConfigApplicationContext();MyBeanDefinitionRegistryPostProcessor beanDefinitionRegistryPostProcessor=newMyBeanDefinitionRegistryPostProcessor();
        applicationContext.addBeanFactoryPostProcessor(beanDefinitionRegistryPostProcessor);
        applicationContext.refresh();Person bean= applicationContext.getBean(Person.class);System.out.println(bean);}}classMyBeanDefinitionRegistryPostProcessorimplementsBeanDefinitionRegistryPostProcessor{@OverridepublicvoidpostProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry)throwsBeansException{AbstractBeanDefinition beanDefinition=BeanDefinitionBuilder.rootBeanDefinition(Person.class).getBeanDefinition();
        registry.registerBeanDefinition("person", beanDefinition);}@OverridepublicvoidpostProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)throwsBeansException{}}

参考文章

https://blog.csdn.net/weixin_43741092/article/details/120176466

https://mp.weixin.qq.com/s/NpTNVGqU4dQwwgec3X4ibg

  • 作者:魅Lemon
  • 原文链接:https://blog.csdn.net/lemon_TT/article/details/122196465
    更新时间:2022-10-22 09:57:16