Spring容器中添加bean的5種方式

更新時(shí)間：2021年07月07日 11:41:25 作者：楚三木

我們知道平時(shí)在開(kāi)發(fā)中使用Spring的時(shí)候，都是將對(duì)象交由Spring去管理，那么將一個(gè)對(duì)象加入到Spring容器中，有哪些方式呢，感興趣的可以了解一下

@Configuration + @Bean

這種方式其實(shí)，在上一篇文章已經(jīng)介紹過(guò)了，也是我們最常用的一種方式，@Configuration用來(lái)聲明一個(gè)配置類(lèi)，然后使用 @Bean 注解，用于聲明一個(gè)bean，將其加入到Spring容器中。
具體代碼如下:

@Configuration
public class MyConfiguration {
    @Bean
    public Person person() {
        Person person = new Person();
        person.setName("spring");
        return person;
    }
}

@Componet + @ComponentScan

這種方式也是我們用的比較多的方式，@Componet中文譯為組件，放在類(lèi)名上面，然后@ComponentScan放置在我們的配置類(lèi)上，然后可以指定一個(gè)路徑，進(jìn)行掃描帶有@Componet注解的bean，然后加至容器中。

具體代碼如下:

@Component
public class Person {
    private String name;

    public String getName() {

        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                '}';
    }
}

@ComponentScan(basePackages = "it.chusen.spring.*")
public class Demo1 {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class);
        Person bean = applicationContext.getBean(Person.class);
        System.out.println(bean);
    }
}

結(jié)果輸出:

Person{name='null'}

表示成功將Person放置在了IOC容器中。

@Import注解導(dǎo)入

前兩種方式，大家用的可能比較多，也是平時(shí)開(kāi)發(fā)中必須要知道的，@Import注解用的可能不是特別多了，但是也是非常重要的，在進(jìn)行Spring擴(kuò)展時(shí)經(jīng)常會(huì)用到，它經(jīng)常搭配自定義注解進(jìn)行使用，然后往容器中導(dǎo)入一個(gè)配置文件。關(guān)于@Import注解，我會(huì)多介紹一點(diǎn)，它有三種使用方式，我會(huì)一一介紹。這是@Import注解的源碼，表示只能放置在類(lèi)上。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Import {

    /**
   * 用于導(dǎo)入一個(gè)class文件
     * {@link Configuration @Configuration}, {@link ImportSelector},
     * {@link ImportBeanDefinitionRegistrar}, or regular component classes to import.
     */
    Class<?>[] value();

}

@Import直接導(dǎo)入類(lèi)

代碼示例如下:

public class Person {
    private String name;

    public String getName() {

        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                '}';
    }
}
/**
* 直接使用@Import導(dǎo)入person類(lèi)，然后嘗試從applicationContext中取，成功拿到
**/
@Import(Person.class)
public class Demo1 {

    public static void main(String[] args) {
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class);
        Person bean = applicationContext.getBean(Person.class);
        System.out.println(bean);
    }
}

上述代碼直接使用@Import導(dǎo)入了一個(gè)類(lèi)，然后自動(dòng)的就被放置在IOC容器中了。注意
我們的Person類(lèi)上就不需要任何的注解了，直接導(dǎo)入即可。

@Import + ImportSelector

其實(shí)在@Import注解的源碼中，說(shuō)的已經(jīng)很清楚了，感興趣的可以看下，我們實(shí)現(xiàn)一個(gè)ImportSelector的接口，然后實(shí)現(xiàn)其中的方法，進(jìn)行導(dǎo)入。

代碼如下:

@Import(MyImportSelector.class)
public class Demo1 {

    public static void main(String[] args) {
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class);
        Person bean = applicationContext.getBean(Person.class);
        System.out.println(bean);
    }
}

class MyImportSelector implements ImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        return new String[]{"it.chusen.spring.model.Person"};
    }
}

我自定義了一個(gè) MyImportSelector 實(shí)現(xiàn)了 selectImports 方法，然后將我們要導(dǎo)入的類(lèi)的全限定名寫(xiě)在里面即可，實(shí)現(xiàn)起來(lái)也是非常簡(jiǎn)單。

@Import + ImportBeanDefinitionRegistrar

這種方式也需要我們實(shí)現(xiàn) ImportBeanDefinitionRegistrar 中的方法，具體代碼如下:

@Import(MyImportBeanDefinitionRegistrar.class)
public class Demo1 {

    public static void main(String[] args) {
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class);
        Person bean = applicationContext.getBean(Person.class);
        System.out.println(bean);
    }
}

class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {

    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        // 構(gòu)建一個(gè)beanDefinition, 關(guān)于beanDefinition我后續(xù)會(huì)介紹，可以簡(jiǎn)單理解為bean的定義.
        AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(Person.class).getBeanDefinition();
        // 將beanDefinition注冊(cè)到Ioc容器中.
        registry.registerBeanDefinition("person", beanDefinition);
    }
}

上述實(shí)現(xiàn)其實(shí)和Import的第二種方式差不多，都需要去實(shí)現(xiàn)接口，然后進(jìn)行導(dǎo)入。接觸到了一個(gè)新的概念，BeanDefinition，可以簡(jiǎn)單理解為bean的定義(bean的元數(shù)據(jù))，也是需要放在IOC容器中進(jìn)行管理的，先有bean的元數(shù)據(jù)，applicationContext再根據(jù)bean的元數(shù)據(jù)去創(chuàng)建Bean。

@Import + DeferredImportSelector

這種方式也需要我們進(jìn)行實(shí)現(xiàn)接口，其實(shí)它和@Import的第二種方式差不多，DeferredImportSelector 它是 ImportSelector 的子接口，所以實(shí)現(xiàn)的方法和第二種無(wú)異。只是Spring的處理方式不同，它和Spring Boot中的自動(dòng)導(dǎo)入配置文件延遲導(dǎo)入有關(guān)，非常重要。使用方式如下:

@Import(MyDeferredImportSelector.class)
public class Demo1 {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class);
        Person bean = applicationContext.getBean(Person.class);
        System.out.println(bean);
    }
}
class MyDeferredImportSelector implements DeferredImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        // 也是直接將Person的全限定名放進(jìn)去
        return new String[]{Person.class.getName()};
    }
}

關(guān)于@Import注解的使用方式，大概就以上三種，當(dāng)然它還可以搭配@Configuration注解使用，用于導(dǎo)入一個(gè)配置類(lèi)。

使用FactoryBean接口

FactoryBean接口和BeanFactory千萬(wàn)不要弄混了，從名字其實(shí)可以大概的區(qū)分開(kāi)，F(xiàn)actoryBean, 后綴為bean，那么它其實(shí)就是一個(gè)bean, BeanFactory，顧名思義 bean工廠，它是IOC容器的頂級(jí)接口，這倆接口其實(shí)都很重要。
代碼示例:

@Configuration
public class Demo1 {
    @Bean
    public PersonFactoryBean personFactoryBean() {
        return new PersonFactoryBean();
    }

    public static void main(String[] args) {
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class);
        Person bean = applicationContext.getBean(Person.class);
        System.out.println(bean);
    }
}

class PersonFactoryBean implements FactoryBean<Person> {

    /**
     *  直接new出來(lái)Person進(jìn)行返回.
     */
    @Override
    public Person getObject() throws Exception {
        return new Person();
    }
    /**
     *  指定返回bean的類(lèi)型.
     */
    @Override
    public Class<?> getObjectType() {
        return Person.class;
    }
}

上述代碼，我使用@Configuration + @Bean的方式將 PersonFactoryBean 加入到容器中，注意，我沒(méi)有向容器中注入 Person, 而是直接注入的 PersonFactoryBean 然后從容器中拿Person這個(gè)類(lèi)型的bean,成功運(yùn)行。

使用 BeanDefinitionRegistryPostProcessor

其實(shí)這種方式也是利用到了 BeanDefinitionRegistry，在Spring容器啟動(dòng)的時(shí)候會(huì)執(zhí)行 BeanDefinitionRegistryPostProcessor 的 postProcessBeanDefinitionRegistry 方法，大概意思就是等beanDefinition加載完畢之后，對(duì)beanDefinition進(jìn)行后置處理，可以在此進(jìn)行調(diào)整IOC容器中的beanDefinition，從而干擾到后面進(jìn)行初始化bean。

具體代碼如下:

public class Demo1 {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext();
        MyBeanDefinitionRegistryPostProcessor beanDefinitionRegistryPostProcessor = new MyBeanDefinitionRegistryPostProcessor();
        applicationContext.addBeanFactoryPostProcessor(beanDefinitionRegistryPostProcessor);
        applicationContext.refresh();
        Person bean = applicationContext.getBean(Person.class);
        System.out.println(bean);
    }
}

class MyBeanDefinitionRegistryPostProcessor implements BeanDefinitionRegistryPostProcessor {

    @Override
    public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
        AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(Person.class).getBeanDefinition();
        registry.registerBeanDefinition("person", beanDefinition);
    }
    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {

    }
}

上述代碼中，我們手動(dòng)向beanDefinitionRegistry中注冊(cè)了person的BeanDefinition。最終成功將person加入到applicationContext中，上述的幾種方式的具體原理，我后面會(huì)進(jìn)行介紹。