将bean放入Spring容器中有哪些方式？

怼烎@ 2024-03-27 11:23 79阅读 0赞

我们知道平时在开发中使用Spring的时候，就是将对象交由Spring去管理，那么究竟是怎么将一个对象加入到Spring容器中，有哪些方式呢，下面作者就来总结一下自己了解到的吧！

## 一、@Configuration + @Bean ##

这种方式其实，在上一篇文章已经介绍过了，也是我们最常用的一种方式，@Configuration用来声明一个配置类，然后使用 @Bean 注解，用于声明一个bean，将其加入到Spring容器中。  
具体代码如下:

@Configuration
    public class MyConfiguration {
        
        @Bean
        public User user() {
        
            User user = new User();
            user.setUserName("spring bean");
            return user;
        }
    }

## 二、@Component + @ComponentScan ##

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

package com.springdemo.demo;
    import org.springframework.stereotype.Component;
    
    /**
     * @Title: User
     * @Description:
     * @author: leon
     * @date: 2023/2/1 16:24
     */
    
    @Component
    public class User {
        
        private String userName;
        private String hobby;
    
        public String getUserName() {
        
            return userName;
        }
    
        public void setUserName(String userName) {
        
            this.userName = userName;
        }
    
        public String getHobby() {
        
            return hobby;
        }
    
        public void setHobby(String hobby) {
        
            this.hobby = hobby;
        }
    
        @Override
        public String toString() {
        
            return "User{" +
                    "userName='" + userName + '\'' +
                    ", hobby='" + hobby + '\'' +
                    '}';
        }
    }

扫描需要注入bean所在的包

@ComponentScan(basePackages = "com.springdemo.demo")
    public class Demo2 {
        
        public static void main(String[] args) {
        
            AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo2.class);
            User user = applicationContext.getBean(User.class);
            System.out.println(user);
        }
    }

输出结果：

User{
        userName='null', hobby='null'}

表示成功将User放置在了IOC容器中。

## 三、@Import注解导入 ##

前两种方式，大家用的可能比较多，也是平时开发中必须要知道的，@Import注解用的可能不是特别多了，但是也是非常重要的，在进行Spring扩展时经常会用到，它经常搭配自定义注解进行使用，然后往容器中导入一个配置文件。关于@Import注解，我会多介绍一点，它有四种使用方式。这是@Import注解的源码，表示只能放置在类上。

@Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface Import {
        
    
       /**
        * {@link Configuration @Configuration}, {@link ImportSelector},
        * {@link ImportBeanDefinitionRegistrar}, or regular component classes to import.
        */
       Class<?>[] value();
    
    }

### 1、用@Import直接导入类 ###

User类上面已经给出了。

/**
    * 直接使用@Import导入User类，尝试从applicationContext中取出
    **/
    @Import(User.class)
    public class Demo3 {
        
        public static void main(String[] args) {
        
            AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo3.class);
            User user = applicationContext.getBean(User.class);
            System.out.println(user);
        }
    }

### 2、@Import + ImportSelector ###

其实在@Import注解的源码中，说的已经很清楚了，感兴趣的可以看下，我们实现一个ImportSelector的接口，然后实现其中的方法，进行导入。

代码如下:

@Import(MyImportSelector.class)
    public class Demo4 {
        
    
        public static void main(String[] args) {
        
            AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo4.class);
            User user = applicationContext.getBean(User.class);
            System.out.println(user);
        }
    }
    
    class MyImportSelector implements ImportSelector {
        
        @Override
        public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        
            return new String[]{
        "com.springdemo.demo.User"};
        }
    }

我自定义了一个 MyImportSelector 实现了 ImportSelector 接口，重写selectImports 方法，然后将我们要导入的类的全限定名写在里面即可，实现起来也是非常简单。

### 3、@Import + ImportBeanDefinitionRegistrar ###

这种方式也需要我们实现 ImportBeanDefinitionRegistrar 接口中的方法，具体代码如下:

@Import(MyImportBeanDefinitionRegistrar.class)
    public class Demo5 {
        
    
        public static void main(String[] args) {
        
            AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo5.class);
            User user = applicationContext.getBean(User.class);
            System.out.println(user);
        }
    }
    
    class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
        
    
        @Override
        public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        
            // 构建一个beanDefinition, 关于beanDefinition我后续会介绍，可以简单理解为bean的定义.
            AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(User.class).getBeanDefinition();
            // 将beanDefinition注册到Ioc容器中.
            registry.registerBeanDefinition("user", beanDefinition);
        }
    }

上述实现其实和Import的第二种方式差不多，都需要去实现接口，然后进行导入。接触到了一个新的概念，BeanDefinition，可以简单理解为bean的定义(bean的元数据)，也是需要放在IOC容器中进行管理的，先有bean的元数据，applicationContext再根据bean的元数据去创建Bean。

### 4、@Import + DeferredImportSelector ###

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

@Import(MyDeferredImportSelector.class)
    public class Demo6 {
        
        public static void main(String[] args) {
        
            AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo6.class);
            User user = applicationContext.getBean(User.class);
            System.out.println(user);
        }
    }
    class MyDeferredImportSelector implements DeferredImportSelector {
        
        @Override
        public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        
            // 也是直接将User的全限定名放进去
            return new String[]{
        User.class.getName()};
        }
    }

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

## 四、使用FactoryBean接口 ##

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

class UserFactoryBean implements FactoryBean<User> {
        
        @Override
        public User getObject() throws Exception {
        
            return new User();
        }
        /**
         *  指定返回bean的类型.
         */
        @Override
        public Class<?> getObjectType() {
        
            return User.class;
        }
    }
    
    @Configuration
    public class Demo7 {
        
        @Bean
        public UserFactoryBean userFactoryBean() {
        
            return new UserFactoryBean();
        }
    
        public static void main(String[] args) {
        
            AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo7.class);
            User user = applicationContext.getBean(User.class);
            System.out.println(user);
        }
    }

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

## 五、使用 BeanDefinitionRegistryPostProcessor ##

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

具体代码如下:

class MyBeanDefinitionRegistryPostProcessor implements BeanDefinitionRegistryPostProcessor {
        
    
        @Override
        public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
        
            AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(User.class).getBeanDefinition();
            registry.registerBeanDefinition("user", beanDefinition);
        }
        @Override
        public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
        
    
        }
    }
    public class Demo8 {
        
        public static void main(String[] args) {
        
            AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext();
            MyBeanDefinitionRegistryPostProcessor beanDefinitionRegistryPostProcessor = new MyBeanDefinitionRegistryPostProcessor();
            applicationContext.addBeanFactoryPostProcessor(beanDefinitionRegistryPostProcessor);
            applicationContext.refresh();
            User user = applicationContext.getBean(User.class);
            System.out.println(user);
        }
    }

上述代码中，我们手动向beanDefinitionRegistry中注册了user的BeanDefinition。最终成功将user加入到applicationContext中。

## 六、使用读取xml文件的方式注入bean ##

配置xml文件的bean信息，这里只列举简单的**xml文件配置bean**，就不区分**构造器**跟**setter**、**工厂方法**这些模式了

可参考链接:

> https://zhuanlan.zhihu.com/p/387259323

![在这里插入图片描述][ff74d0de717848668edc50b5c64b1d33.png]  
使用ClassPathXmlApplicationContext加载配置信息把bean注入到容器中

具体代码如下:

@Test
    public void testAdd() {
        
        //1 加载spring配置文件
        ApplicationContext context =
                new ClassPathXmlApplicationContext("bean1.xml");
        //2 获取配置创建的对象
        User user = context.getBean("user", User.class);
        System.out.println(user);
        user.add();
    }

效果如下：  
![在这里插入图片描述][1ae778bb5895483b845973313e5cc387.png]

## 最后小结 ##

**向spring容器中加入bean的常用几种方式如下：**

**@Configuration + @Bean**  
**@ComponentScan + @Component**  
**@Import 配合接口进行导入**  
**使用FactoryBean。**  
**实现BeanDefinitionRegistryPostProcessor进行后置处理。**  
**通过xml文件读取导入到容器**

本文是参考许多网友博客以及结合自己实践总结的学习记录，欢迎指正一起交流学习，如果有涉及侵权原创，可联系本人删除。

[ff74d0de717848668edc50b5c64b1d33.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/d77d820d48ad48efae4e59b293c62b62.png
[1ae778bb5895483b845973313e5cc387.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/defbcd4785a2445d8404c2aeefb53893.png