快捷導(dǎo)航

Spring控制Bean加載順序的操作方法

更新時(shí)間：2024年05月09日 14:25:53 作者：fuxing

正常情況下,Spring 容器加載 Bean 的順序是不確定的,那么我們?nèi)绻枰错樞蚣虞d Bean 時(shí)應(yīng)如何操作？本文將詳細(xì)講述我們?nèi)绾尾拍芸刂?nbsp;Bean 的加載順序,需要的朋友可以參考下

前言

正常情況下，Spring 容器加載 Bean 的順序是不確定的，那么我們?nèi)绻枰错樞蚣虞d Bean 時(shí)應(yīng)如何操作？本文將詳細(xì)講述我們?nèi)绾尾拍芸刂?Bean 的加載順序。

場(chǎng)景

我創(chuàng)建了 4 個(gè) Class 文件，分別命名為

FirstInitialization
SecondInitialization
ThirdInitialization
ForthInitialization

我希望這 4 個(gè)類(lèi)按照 1、2、3、4 的順序加載。

如下圖，直接加載的話(huà)，順序是 1、4、2、3，并不能達(dá)到要求。

如何控制

注意：網(wǎng)上很多文章說(shuō)Order注解或Ordered接口可以控制 Bean 的加載順序，其是并不能，它們的作用是定義 Spring IOC 容器中 Bean 定義類(lèi)的執(zhí)行順序的優(yōu)先級(jí)，并不是定義加載順序。

使用@DependsOn 注解

在需要調(diào)整順序的類(lèi)上依次加@DependsOn注解，缺點(diǎn)是類(lèi)過(guò)多的時(shí)候需要一個(gè)個(gè)加注解，且不好維護(hù)。

@Component
public class FirstInitialization {

    @PostConstruct
    public void init(){
        System.out.println("我是第一個(gè)加載！");
    }

}

@Component
@DependsOn("firstInitialization")
public class SecondInitialization {

    @PostConstruct
    public void init(){
        System.out.println("我是第二個(gè)加載！");
    }

}

@Component
@DependsOn("secondInitialization")
public class ThirdInitialization {

    @PostConstruct
    public void init(){
        System.out.println("我是第三個(gè)加載！");
    }

}

@Component
@DependsOn("thirdInitialization")
public class ForthInitialization {

    @PostConstruct
    public void init(){
        System.out.println("我是第四個(gè)加載！");
    }

}

執(zhí)行結(jié)果如下

基于 ApplicationContextInitializer 接口

接口簡(jiǎn)介

這里我簡(jiǎn)單介紹一個(gè)這個(gè)接口的用處，等到整理到相關(guān)源碼的時(shí)候再詳細(xì)介紹。

ApplicationContextInitializer接口是在 Spring 容器刷新之前執(zhí)行的一個(gè)回調(diào)函數(shù)。

執(zhí)行時(shí)機(jī)：

Spring 內(nèi)部執(zhí)行ConfigurableApplicationContext#refresh()方法前；

SpringBoot 執(zhí)行run()方法前。

一般有什么用呢？

在 SpringBoot 應(yīng)用中 Classpath 上會(huì)有很多 jar 包，有些 jar 包需要在refresh()調(diào)用前對(duì)應(yīng)用上下文做一些初始化動(dòng)作，因此會(huì)提供ApplicationContextInitializer接口的實(shí)現(xiàn)類(lèi)，放在如下圖的文件中，這樣會(huì)被SpringApplication#initialize發(fā)現(xiàn)，然后完成對(duì)應(yīng)初始化。

實(shí)現(xiàn)步驟

首先創(chuàng)建一個(gè)類(lèi)繼承ApplicationContextInitializer接口。

public class MyApplicationContextInitializer implements ApplicationContextInitializer {
    @Override
    public void initialize(ConfigurableApplicationContext applicationContext) {

        //將自定義的BeanFactoryPostProcessor實(shí)現(xiàn)類(lèi)保存到ApplicationContext中
        applicationContext.addBeanFactoryPostProcessor(new MyBeanFactoryPostProcessor());
    }
}

創(chuàng)建META-INF/spring.factories文件。

自定義BeanDefinitionRegistryPostProcessor。

/**
 * BeanFactoryPostProcessor的子類(lèi)
 * 允許開(kāi)發(fā)人員在Bean定義注冊(cè)之前和之后對(duì)BeanDefinition進(jìn)行自定義處理，例如添加，修改或刪除Bean定義等。
 */
public class MyBeanFactoryPostProcessor implements BeanDefinitionRegistryPostProcessor {

    // 初始化需要排序的類(lèi)，這里要保證插入順序只能用LinkedHashMap
    private static final Map<String, Class> ORDER_BEAN_MAP = new LinkedHashMap<>() {
        {
            put("firstInitialization", FirstInitialization.class);
            put("secondInitialization", SecondInitialization.class);
            put("thirdInitialization", ThirdInitialization.class);
            put("forthInitialization", ForthInitialization.class);
        }
    };

    @Override
    public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
        Optional.ofNullable(ORDER_BEAN_MAP.keySet()).orElse(new HashSet<>()).stream()
                .forEach(beanName -> {
                    // 初始化一個(gè) Bean 定義
                    AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder
                            .genericBeanDefinition().getBeanDefinition();

                    // 按順序注冊(cè)每個(gè)Bean
                    beanDefinition.setBeanClass(ORDER_BEAN_MAP.get(beanName));
                    registry.registerBeanDefinition(beanName, beanDefinition);
                });
    }
}

執(zhí)行結(jié)果如下