将Bean放入Spring容器的几种方式

zhicheng..

已于 2022-04-28 11:40:33 修改

阅读量710

点赞数

文章标签： spring

于 2022-04-22 11:02:17 首次发布

本文链接：https://blog.csdn.net/weixin_60879423/article/details/124336687

版权

本文详细解读了Spring Boot中常用的配置方式，包括@Configuration+@Bean、@Component+@ComponentScan、@Import的各种导入策略，以及FactoryBean和BeanDefinitionRegistryPostProcessor的应用。深入理解如何灵活导入和管理bean，提升Spring应用配置效率。

摘要由CSDN通过智能技术生成

1、@Configuration + @Bean

2、@Componet + @ComponentScan

3、@Import注解导入

3.1 @Import直接导入类

3.2 @Import + ImportSelector

3.3 @Import + ImportBeanDefinitionRegistrar

3.4 @Import + DeferredImportSelector

4、使用FactoryBean接口

5、使用 BeanDefinitionRegistryPostProcessor

结：

1、@Configuration + @Bean

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

实体类：

@Data
public class Animal {

    private String name;

    private Integer age;
}

配置类：

@Configuration
public class MyConfiguration {

    @Bean
    public Animal animal() {
        Animal animal = new Animal();
        animal.setName("Tom");
        return animal;
    }
}

2、@Componet + @ComponentScan

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

实体类：

@Data
@Component
public class Animal {

    private String name;

    private Integer age;
}

配置类：

@ComponentScan(basePackages = "com.example.demo.Animal")
public class AnimalTest {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext annotationConfigApplicationContext = new AnnotationConfigApplicationContext(AnimalTest.class);
        Animal bean = annotationConfigApplicationContext.getBean(Animal.class);
        System.out.println(bean);
    }
}

输出结果：（表示成功将Animal放置在了IOC容器中）

Animal(name=null, age=null)

3、@Import注解导入

前两种方式，使用的可能比较多，@Import注解在进行Spring扩展时经常会用到，它经常搭配自定义注解进行使用，然后往容器中导入一个配置文件。关于@Import注解，有四种使用方式。

这是@Import注解的源码，表示只能放置在类上。

@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 Animal {

    private String name;

    private Integer age;
}

配置类：

/**
 * 直接使用@Import()导入Animal.class
 */
@Import(Animal.class)
public class AnimalTest {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext annotationConfigApplicationContext = new AnnotationConfigApplicationContext(AnimalTest.class);
        Animal bean = annotationConfigApplicationContext.getBean(Animal.class);
        System.out.println(bean);
    }
}

输出结果：（上述代码直接使用@Import导入了一个类，然后自动的就被放置在IOC容器中了。）

Animal(name=null, age=null)

3.2 @Import + ImportSelector

在@Import注解的源码中说明，我们可以实现一个ImportSelector的接口，然后实现其中的方法，进行导入。

配置类：

public class MyImportSelector implements ImportSelector {
    //重写selectImports 方法，然后将我们要导入的类的全限定名写在里面即可
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        return new String[]{"com.example.demo.Animal"};
    }
}

测试：

@Import(MyImportSelector.class)
public class AnimalTest {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext annotationConfigApplicationContext = new AnnotationConfigApplicationContext(AnimalTest.class);
        Animal bean = annotationConfigApplicationContext.getBean(Animal.class);
        System.out.println(bean);
    }
}

输出结果：

Animal(name=null, age=null)

3.3 @Import + ImportBeanDefinitionRegistrar

这种方式也需要我们实现 ImportBeanDefinitionRegistrar 接口中的方法

配置类：

public class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {

    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        // 构建一个beanDefinition, 可以简单理解为bean的定义.
        //接触到了一个新的概念，BeanDefinition，可以简单理解为bean的定义(bean的元数据)，也是需要放在IOC容器中进行管理的，先有bean的元数据，applicationContext再根据bean的元数据去创建Bean。
        AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(Animal.class).getBeanDefinition();
        // 将beanDefinition注册到Ioc容器中.
        registry.registerBeanDefinition("animal", beanDefinition);
    }
}

测试：

@Import(MyImportBeanDefinitionRegistrar.class)
public class AnimalTest {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext annotationConfigApplicationContext = new AnnotationConfigApplicationContext(AnimalTest.class);
        Animal bean = annotationConfigApplicationContext.getBean(Animal.class);
        System.out.println(bean);
    }
}

输出结果：

Animal(name=null, age=null)

上述实现其实和Import的第二种方式差不多，都需要去实现接口，然后进行导入。

3.4 @Import + DeferredImportSelector

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

配置类：

public class MyDeferredImportSelector implements DeferredImportSelector {

    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        // 也是直接将Animal的全限定名放进去
        return new String[]{"com.example.demo.Animal"};
    }
}

测试：

@Import(MyDeferredImportSelector.class)
public class AnimalTest {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext annotationConfigApplicationContext = new AnnotationConfigApplicationContext(AnimalTest.class);
        Animal bean = annotationConfigApplicationContext.getBean(Animal.class);
        System.out.println(bean);
    }
}

输出结果：

Animal(name=null, age=null)

关于@Import注解的使用方式，大概就以上四种，它还可以搭配@Configuration注解使用，用于导入一个配置类。

4、使用FactoryBean接口

FactoryBean接口和BeanFactory千万不要弄混了，从名字其实可以大概的区分开，FactoryBean, 后缀为bean，那么它其实就是一个bean, BeanFactory，顾名思义 bean工厂，它是IOC容器的顶级接口。

配置类：

public class AnimalFactoryBean implements FactoryBean<Animal> {

    /**
     * 直接new出来Animal进行返回
     *
     * @return
     * @throws Exception
     */
    @Override
    public Animal getObject() throws Exception {
        return new Animal();
    }

    /**
     * 指定返回的Bean类型
     *
     * @return
     */
    @Override
    public Class<?> getObjectType() {
        return Animal.class;
    }
}

测试：

@Configuration
public class AnimalTest {

    @Bean
    public AnimalFactoryBean animalFactoryBean() {
        return new AnimalFactoryBean();
    }

    public static void main(String[] args) {
        AnnotationConfigApplicationContext annotationConfigApplicationContext = new AnnotationConfigApplicationContext(AnimalTest.class);
        Animal bean = annotationConfigApplicationContext.getBean(Animal.class);
        System.out.println(bean);
    }
}

输出结果：

Animal(name=null, age=null)

上述代码，使用@Configuration + @Bean的方式将 AnimalFactoryBean 加入到容器中，注意，此处没有向容器中注入 Animal, 而是直接注入的 AnimalFactoryBean 然后从容器中拿Animal这个类型的bean,成功运行。

5、使用 BeanDefinitionRegistryPostProcessor

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

配置类：

public class MyBeanDefinitionRegistryPostProcessor implements BeanDefinitionRegistryPostProcessor {
    @Override
    public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry beanDefinitionRegistry) throws BeansException {
        AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(Animal.class).getBeanDefinition();
        beanDefinitionRegistry.registerBeanDefinition("animal", beanDefinition);
    }

    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory configurableListableBeanFactory) throws BeansException {

    }

}

测试：

public class AnimalTest {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext annotationConfigApplicationContext = new AnnotationConfigApplicationContext();
        MyBeanDefinitionRegistryPostProcessor myBeanDefinitionRegistryPostProcessor = new MyBeanDefinitionRegistryPostProcessor();
        annotationConfigApplicationContext.addBeanFactoryPostProcessor(myBeanDefinitionRegistryPostProcessor);
        annotationConfigApplicationContext.refresh();
        Animal bean = annotationConfigApplicationContext.getBean(Animal.class);
        System.out.println(bean);
    }
}

输出结果：