快捷導(dǎo)航

使用Spring @DependsOn控制bean加載順序的實(shí)例

更新時(shí)間：2021年07月22日 15:12:13 作者：夢(mèng)想畫家

這篇文章主要介紹了使用Spring @DependsOn控制bean加載順序的實(shí)例講解，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

spring容器載入bean順序是不確定的，spring框架沒有約定特定順序邏輯規(guī)范。但spring保證如果A依賴B(如beanA中有@Autowired B的變量)，那么B將先于A被加載。但如果beanA不直接依賴B，我們?nèi)绾巫孊仍先加載呢？

控制bean初始化順序

可能有些場(chǎng)景中，bean A 間接依賴 bean B。如Bean B應(yīng)該需要更新一些全局緩存，可能通過單例模式實(shí)現(xiàn)且沒有在spring容器注冊(cè)，bean A需要使用該緩存；因此，如果bean B沒有準(zhǔn)備好，bean A無(wú)法訪問。

另一個(gè)場(chǎng)景中，bean A是事件發(fā)布者（或JMS發(fā)布者），bean B (或一些) 負(fù)責(zé)監(jiān)聽這些事件，典型的如觀察者模式。我們不想B 錯(cuò)過任何事件，那么B需要首先被初始化。

簡(jiǎn)言之，有很多場(chǎng)景需要bean B應(yīng)該被先于bean A被初始化，從而避免各種負(fù)面影響。我們可以在bean A上使用@DependsOn注解，告訴容器bean B應(yīng)該先被初始化。下面通過示例來(lái)說明。

示例說明

示例通過事件機(jī)制說明，發(fā)布者和監(jiān)聽者，然后通過spring配置運(yùn)行。為了方便說明，示例進(jìn)行了簡(jiǎn)化。

EventManager.java

事件管理類，維護(hù)監(jiān)聽器列表，通過單例方法獲取事件管理器，可以增加監(jiān)聽器或發(fā)布事件。

import java.util.ArrayList;
import java.util.List;
import java.util.function.Consumer;
public class EventManager {
    private final List<Consumer<String>> listeners = new ArrayList<>();
    private EventManager() {
    }
    private static class SingletonHolder {
        private static final EventManager INSTANCE = new EventManager();
    }
    public static EventManager getInstance() {
        return SingletonHolder.INSTANCE;
    }
    public void publish(final String message) {
        listeners.forEach(l -> l.accept(message));
    }
    public void addListener(Consumer<String> eventConsumer) {
        listeners.add(eventConsumer);
    }
}

EventPublisherBean.java

事件發(fā)布類，通過EventManager類發(fā)布事件。

import com.logicbig.example.EventManager;
public class EventPublisherBean {
    public void initialize() {
        System.out.println("EventPublisherBean initializing");
        EventManager.getInstance().publish("event published from EventPublisherBean");
    }
}

EventListenerBean.java

事件監(jiān)聽者，可以增加監(jiān)聽器。

import com.logicbig.example.EventManager;
public class EventListenerBean {
    private void initialize() {
        EventManager.getInstance().
                addListener(s ->
                        System.out.println("event received in EventListenerBean : " + s));
    }
}

AppConfig.java

配置運(yùn)行類。

@Configuration
@ComponentScan("com.logicbig.example")
public class AppConfig {
    @Bean(initMethod = "initialize")
    @DependsOn("eventListener")
    public EventPublisherBean eventPublisherBean () {
        return new EventPublisherBean();
    }
    @Bean(name = "eventListener", initMethod = "initialize")
    // @Lazy
    public EventListenerBean eventListenerBean () {
        return new EventListenerBean();
    }
    public static void main (String... strings) {
        new AnnotationConfigApplicationContext(AppConfig.class);
    }
}

運(yùn)行AppConfig的main方法，輸出結(jié)果為：

EventListenerBean initializing

EventPublisherBean initializing

event received in EventListenerBean : event published from EventPublisherBean

總結(jié)

如果我們注釋掉@DependsOn("eventListener")，我們可能不確定獲得相同結(jié)果。嘗試多次運(yùn)行main方法，偶爾我們將看到EventListenerBean 沒有收到事件。為什么是偶爾呢？因?yàn)槿萜鲉?dòng)過程中，spring按任意順序加載bean。

那么當(dāng)不使用@DependsOn可以讓其100%確定嗎？可以使用@Lazy注解放在eventListenerBean ()上。因?yàn)镋ventListenerBean在啟動(dòng)階段不加載，當(dāng)其他bean需要其時(shí)才加載。這次我們僅EventListenerBean被初始化。