控制bean初始化顺序

可能有些场景中，beanB 间接依赖 beanA。比如 BeanA 中需要更新一些全局缓存，可能通过单例模式实现且没有在 spring 容器注册，但是 beanB 需要使用该缓存；因此，如果 beanA 没有准备好，beanB 无法访问。

另一个场景中，beanA 是事件发布者（或JMS发布者），beanB (或一些) 负责监听这些事件，典型的如观察者模式。我们不想 beanB 错过任何事件，那么 beanB 需要先被初始化。

我们可以在 beanB 上使用@DependsOn注解，告诉容器 beanA 应该先被初始化。下面通过示例来说明。

示例说明

示例通过事件机制说明，发布者和监听者，然后通过 spring 配置运行。为了方便说明，示例进行了简化。

EventManager.java
事件管理类，维护监听器列表，通过单例方法获取事件管理器，可以增加监听器或发布事件。

  1. import java.util.ArrayList;
  2. import java.util.List;
  3. import java.util.function.Consumer;
  5. public class EventManager {
  6.     private final List<Consumer<String>> listeners = new ArrayList<>();
  8.     private EventManager() {
  9.     }
  11.     private static class SingletonHolder {
  12.         private static final EventManager INSTANCE = new EventManager();
  13.     }
  15.     public static EventManager getInstance() {
  16.         return SingletonHolder.INSTANCE;
  17.     }
  19.     public void publish(final String message) {
  20.         listeners.forEach(l -> l.accept(message));
  21.     }
  23.     public void addListener(Consumer<String> eventConsumer) {
  24.         listeners.add(eventConsumer);
  25.     }
  26. }

EventPublisherBean.java
事件发布类，通过EventManager类发布事件。

  1. import com.logicbig.example.EventManager;
  2. public class EventPublisherBean {
  3.     public void initialize() {
  4.         System.out.println("EventPublisherBean initializing");
  5.         EventManager.getInstance().publish("event published from EventPublisherBean");
  6.     }
  7. }

EventListenerBean.java
事件监听者，可以增加监听器。

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

AppConfig.java

配置运行类。

  1. @Configuration
  2. @ComponentScan("com.logicbig.example")
  3. public class AppConfig {
  5.     @Bean(initMethod = "initialize")
  6.     @DependsOn("eventListener")
  7.     public EventPublisherBean eventPublisherBean () {
  8.         return new EventPublisherBean();
  9.     }
  11.     @Bean(name = "eventListener", initMethod = "initialize")
  12.     // @Lazy
  13.     public EventListenerBean eventListenerBean () {
  14.         return new EventListenerBean();
  15.     }
  17.     public static void main (String... strings) {
  18.         new AnnotationConfigApplicationContext(AppConfig.class);
  19.     }
  20. }

运行AppConfig的main方法，输出结果为：

  1. EventListenerBean initializing
  2. EventPublisherBean initializing
  3. event received in EventListenerBean : event published from EventPublisherBean

总结

如果我们注释掉 @DependsOn("eventListener")，我们可能不确定获得相同结果。尝试多次运行main方法，偶尔我们将看到 EventListenerBean 没有收到事件。为什么是偶尔呢？因为容器启动过程中，spring 按任意顺序加载 bean。（但是我本地测试都收不到事件）

那么当不使用 @DependsOn 可以让其100%确定吗？可以使用 @Lazy 注解放在 eventListenerBean () 上。因为 EventListenerBean 在启动阶段不加载，当其他bean需要其时才加载。这次我们仅 EventListenerBean 被初始化。

  1. `EventPublisherBean initializing`

现在从新增加 @DependsOn，也不删除 @Lazy 注解，还是可以正常接收，虽然我们使用了 @Lazy 注解，eventListenerBean 在启动时仍然被加载，因为 @DependsOn表明需要EventListenerBean。