使用Spring @DependsOn控制bean加載順序的實例

Posted on by

spring容器載入bean順序是不確定的，spring框架沒有約定特定順序邏輯規范。但spring保證如果A依賴B(如beanA中有@Autowired B的變量)，那麼B將先於A被加載。但如果beanA不直接依賴B，我們如何讓B仍先加載呢？

控制bean初始化順序

可能有些場景中，bean A 間接依賴 bean B。如Bean B應該需要更新一些全局緩存，可能通過單例模式實現且沒有在spring容器註冊，bean A需要使用該緩存；因此，如果bean B沒有準備好，bean A無法訪問。

另一個場景中，bean A是事件發佈者（或JMS發佈者），bean B (或一些) 負責監聽這些事件，典型的如觀察者模式。我們不想B 錯過任何事件，那麼B需要首先被初始化。

簡言之，有很多場景需要bean B應該被先於bean A被初始化，從而避免各種負面影響。我們可以在bean A上使用@DependsOn註解，告訴容器bean B應該先被初始化。下面通過示例來說明。

示例說明

示例通過事件機制說明，發佈者和監聽者，然後通過spring配置運行。為瞭方便說明，示例進行瞭簡化。

EventManager.java

事件管理類，維護監聽器列表，通過單例方法獲取事件管理器，可以增加監聽器或發佈事件。

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

事件發佈類，通過EventManager類發佈事件。

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

事件監聽者，可以增加監聽器。

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

配置運行類。

@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);
    }
}

運行AppConfig的main方法，輸出結果為：

EventListenerBean initializing

EventPublisherBean initializing

event received in EventListenerBean : event published from EventPublisherBean

總結

如果我們註釋掉@DependsOn(“eventListener”)，我們可能不確定獲得相同結果。嘗試多次運行main方法，偶爾我們將看到EventListenerBean 沒有收到事件。為什麼是偶爾呢？因為容器啟動過程中，spring按任意順序加載bean。

那麼當不使用@DependsOn可以讓其100%確定嗎？可以使用@Lazy註解放在eventListenerBean ()上。因為EventListenerBean在啟動階段不加載，當其他bean需要其時才加載。這次我們僅EventListenerBean被初始化。

EventPublisherBean initializing

現在從新增加@DependsOn，也不刪除@Lazy註解，輸出結果和第一次一致，雖然我們使用瞭@Lazy註解，eventListenerBean在啟動時仍然被加載，因為@DependsOn表明需要EventListenerBean。

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：