SpringBoot bean的多種加載方式示例詳解

更新時(shí)間：2024年10月10日 12:03:22 作者：冬天vs不冷

本文詳細(xì)介紹了在SpringBoot中加載Bean的多種方式,包括通過(guò)xml配置文件、注解定義、特殊方式如FactoryBean、@ImportResource、ApplicationContext以及使用@Import注解導(dǎo)入bean的方法,感興趣的朋友跟隨小編一起看看吧

一、xml配置文件

配置文件spring-bean.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd">
    <!--xml方式聲明自己開(kāi)發(fā)的bean-->
    <bean id="person" class="com.xc.entity.Person"/>
    <bean class="com.xc.entity.Person"/>
    <bean class="com.xc.entity.Person"/>
    <!--xml方式聲明第三方開(kāi)發(fā)的bean-->
    <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource"/>
</beans>

加載xml

public class App {
    public static void main(String[] args) {
        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("spring-bean.xml");
        for (String beanDefinitionName : context.getBeanDefinitionNames()) {
            System.out.println(beanDefinitionName);
        }
    }
}

輸出結(jié)果：

person
com.xc.entity.Person#0
com.xc.entity.Person#1
dataSource

二、注解定義bean

1、使用AnnotationConfigApplicationContext對(duì)象加載

public class App {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(MyConfig.class);
        for (String beanDefinitionName : context.getBeanDefinitionNames()) {
            System.err.println(beanDefinitionName);
        }
    }
}

public class MyConfig {
}

使用AnnotationConfigApplicationContext對(duì)象加載MyConfig，即使MyConfig類什么注解沒(méi)有，也會(huì)被注冊(cè)為bean。

2、加載本地類使用的注解@Component或其他衍生注解@Service、@Controller、@Repository

@Service
public class BookServiceImpl implements BookService {
}

3、加載第三方j(luò)ar類

由于我們無(wú)法在第三方提供的技術(shù)源代碼中去添加上述4個(gè)注解，因此當(dāng)你需要加載第三方開(kāi)發(fā)的bean的時(shí)候可以使用@Component和@Configuration都可以，一般引入第三方傾向于后者。

//@Component
@Configuration
public class DbConfig {
    @Bean
    public DruidDataSource dataSource(){
        return new DruidDataSource();
    }
    @Bean
    public Cat cat(){
    	Cat cat = new Cat();
    	cat.setDruidDataSource(dataSource());
    	return cat; 
    }
}

@Configuration(proxyBeanMethods = true)：默認(rèn)設(shè)置，使用了cglib動(dòng)態(tài)代理，cat里的dataSource和@Bean創(chuàng)建的dataSource是同一個(gè)對(duì)象，可以理解為單例
@Configuration(proxyBeanMethods = false)：此時(shí)和@Component注解功能一樣，cat里的dataSource和@Bean創(chuàng)建的dataSource不是同一個(gè)對(duì)象，可以理解為多例
如果配置中@Bean標(biāo)識(shí)的方法之間不存在依賴調(diào)用的話，可以設(shè)置為false，可以避免攔截方法進(jìn)行代理操作，提升性能

三、特殊方式

3.1、使用FactroyBean接口

spring提供了一個(gè)接口FactoryBean，也可以用于聲明bean
實(shí)現(xiàn)了FactoryBean接口的類造出來(lái)的對(duì)象不是當(dāng)前類的對(duì)象，而是FactoryBean接口泛型指定類型的對(duì)象
一般用來(lái)創(chuàng)建復(fù)雜對(duì)象

public class DogFactoryBean implements FactoryBean<Dog> {
    //創(chuàng)建bean的復(fù)雜過(guò)程
    @Override
    public Dog getObject() throws Exception {
        Dog d = new Dog();
        //.........
        return d;
    }
    //bean的類型
    @Override
    public Class<?> getObjectType() {
        return Dog.class;
    }
    //bean是否單例
    @Override
    public boolean isSingleton() {
        return true;
    }
}

配置類

public class MyConfig {
    @Bean
    public DogFactoryBean dog(){
        return new DogFactoryBean();
    }
}

啟動(dòng)類

public class App {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(MyConfig.class);
        System.out.println(context.getBean("dog"));
    }
}

3.2、注解導(dǎo)入XML格式配置的bean

場(chǎng)景：舊項(xiàng)目xml配置bean融入配置類項(xiàng)目中
@ImportResource在配置類上直接寫上要被融合的xml配置文件名即可

@Configuration
@ImportResource(locations = "spring-bean.xml")
public class SpringConfig {
}

3.3、通過(guò)上下文ApplicationContext注冊(cè)bean

在容器初始化完成后手動(dòng)加載bean，創(chuàng)建方式很多

在這里插入圖片描述

方式一：無(wú)參構(gòu)造

public class App {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(SpringConfig.class);
        //上下文容器對(duì)象已經(jīng)初始化完畢后，手工加載bean
        ctx.register(Mouse.class);
    }
}

方式二：多參構(gòu)造

public class App {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(SpringConfig.class);
        //上下文容器對(duì)象已經(jīng)初始化完畢后，手工加載bean
        ctx.registerBean("tom", Cat.class,"花貓",3);
    }
}

四、@Import注解注入bean

1、@Import導(dǎo)入普通類

場(chǎng)景：將一個(gè)無(wú)任何注解的類加載為bean
一個(gè)類@Improt只能用一次，想要導(dǎo)入多個(gè)使用{…,…}
只有MyConfig加載為bean，@Import才生效

@Configuration
//@Import(Pig.class)
@Import({Dog.class,Cat.class})
public class MyConfig {
}

public class App {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(MyConfig.class);
        for (String beanDefinitionName : context.getBeanDefinitionNames()) {
            System.err.println(beanDefinitionName);
        }
    }
}

輸出結(jié)果：

myConfig
com.xc.springboot.bean.Dog
com.xc.springboot.bean.Cat

2、@Import導(dǎo)入實(shí)現(xiàn)了ImportSelector接口的類

可以通過(guò)添加判斷語(yǔ)句就可以實(shí)現(xiàn)對(duì)bean的加載控制
返回值為多個(gè)全路徑類名字符串
metadata為@Import注解類的元數(shù)據(jù)，可以拿到MyConfig類上所有的注解，注解里的屬性，繼承的接口，父類等等信息
如下則是判斷MyCofig類上有@Configuration注解則加載Dog類，否則加載Cat類

public class MyImportSelector implements ImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata metadata) {
        System.out.println("元數(shù)據(jù)Class名稱：" + metadata.getClassName());
        //各種條件的判定，判定完畢后，決定是否裝載指定的bean
        boolean flag = metadata.hasAnnotation("org.springframework.context.annotation.Configuration");
        if(flag){
            return new String[]{"com.xc.springboot.bean.Dog"};
        }
        return new String[]{"com.xc.springboot.bean.Cat"};
    }
}

配置類

@Configuration
@Import(MyImportSelector.class)
public class MyConfig {
}

啟動(dòng)類

public class App {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(MyConfig.class);
        for (String beanDefinitionName : context.getBeanDefinitionNames()) {
            System.err.println(beanDefinitionName);
        }
    }
}

輸出結(jié)果：

元數(shù)據(jù)Class名稱：com.xc.springboot.bean.MyConfig
myConfig
com.xc.springboot.bean.Dog

3、@Import導(dǎo)入實(shí)現(xiàn)了ImportBeanDefinitionRegistrar接口的類

返回值為void，通過(guò)Bean定義（beanDefinition）注冊(cè)創(chuàng)建新的bean
同樣可以通過(guò)添加判斷語(yǔ)句就可以實(shí)現(xiàn)bean的加載控制，更加細(xì)粒度判斷bean

public class MyRegistrar implements ImportBeanDefinitionRegistrar {
    @Override
    public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
        BeanDefinition beanDefinition = 	
            BeanDefinitionBuilder.rootBeanDefinition(BookService.class).getBeanDefinition();
        registry.registerBeanDefinition("bookService",beanDefinition);
    }
}

4、@Import導(dǎo)入實(shí)現(xiàn)了BeanDefinitionRegistryPostProcessor接口的類

BeanDefinitionRegistryPostProcessor接口，其中有兩個(gè)重要的方法：
- postProcessBeanDefinitionRegistry：用于注冊(cè)新的BeanDefinition
- postProcessBeanFactory：用于在BeanFactory準(zhǔn)備好后進(jìn)行自定義操作
BeanDefinitionRegistryPostProcessor：bean定義注冊(cè)最后的處理器（在以上處理后執(zhí)行此操作），如果想bean最后確定一個(gè)值，可以在這里操作

public class MyBeanDefinitionRegistryPostProcessor implements BeanDefinitionRegistryPostProcessor {
    @Override
    public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
        // 通過(guò) BeanDefinitionBuilder 創(chuàng)建一個(gè)新的 Bean 定義
        BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(MyCustomBean.class);
        // 注冊(cè)這個(gè) bean 定義到 registry 中
        registry.registerBeanDefinition("myCustomBean", builder.getBeanDefinition());
        System.out.println("Bean definition registered: myCustomBean");
    }
    @Override
    public void postProcessBeanFactory(org.springframework.beans.factory.config.ConfigurableListableBeanFactory beanFactory) throws BeansException {
        // 在這里可以對(duì) BeanFactory 進(jìn)行進(jìn)一步的配置
        System.out.println("Bean factory post-processing");
    }
}