SpringBoot源码之监听器设计

1.观察者模式

  监听器的设计会使用到Java设计模式中的观察者模式,所以在搞清楚SpringBoot中的监听器的设计之前我们还是非常有必要把观察者模式先弄清楚。

  观察者模式又称为发布/订阅(Publish/Subscribe)模式,在对象之间定义了一对多的依赖,这样一来,当一个对象改变状态,依赖它的对象会收到通知并自动更新.

  在java.util包中包含有基本的Observer接口和Observable抽象类.功能上和Subject接口和Observer接口类似.不过在使用上,就方便多了,因为许多功能比如说注册,删除,通知观察者的那些功能已经内置好了.

1.1 定义具体被观察者

  1. package com.dpb.observer2;
  2. import java.util.Observable;
  3. /**
  4. * 目标对象
  5. * 继承 Observable
  6. * @author dengp
  7. *
  8. */
  9. public class ConcreteSubject extends Observable {
  10. private int state;
  11. public void set(int s){
  12. state = s; //目标对象的状态发生了改变
  13. setChanged(); //表示目标对象已经做了更改
  14. notifyObservers(state); //通知所有的观察者
  15. }
  16. public int getState() {
  17. return state;
  18. }
  19. public void setState(int state) {
  20. this.state = state;
  21. }
  22. }

观察者只需要继承Observable父类。发送消息的方式执行如下两行代码即可

  1. setChanged(); //表示目标对象已经做了更改
  2. notifyObservers(state); //通知所有的观察者

Observable源码对应的是:
SpringBoot源码之监听器本质 - 图1
SpringBoot源码之监听器本质 - 图2

1.2 定义具体观察者

  1. package com.dpb.observer2;
  2. import java.util.Observable;
  3. import java.util.Observer;
  4. /**
  5. * 观察者模式:观察者(消息订阅者)
  6. * 实现Observer接口
  7. * @author dengp
  8. *
  9. */
  10. public class ObserverA implements Observer {
  11. private int myState;
  12. @Override
  13. public void update(Observable o, Object arg) {
  14. myState = ((ConcreteSubject)o).getState();
  15. }
  16. public int getMyState() {
  17. return myState;
  18. }
  19. public void setMyState(int myState) {
  20. this.myState = myState;
  21. }
  22. }

观察者也就是订阅者只需要实现Observer接口并重写相关update方法即可,在目标实现中我们发现触发的时候执行的就是观察者的update方法。

1.3 测试

  1. package com.dpb.observer2;
  2. public class Client {
  3. public static void main(String[] args) {
  4. //创建目标对象Obserable
  5. ConcreteSubject subject = new ConcreteSubject();
  6. //创建观察者
  7. ObserverA obs1 = new ObserverA();
  8. ObserverA obs2 = new ObserverA();
  9. ObserverA obs3 = new ObserverA();
  10. //将上面三个观察者对象添加到目标对象subject的观察者容器中
  11. subject.addObserver(obs1);
  12. subject.addObserver(obs2);
  13. subject.addObserver(obs3);
  14. //改变subject对象的状态
  15. subject.set(3000);
  16. System.out.println("===============状态修改了!");
  17. //观察者的状态发生了变化
  18. System.out.println(obs1.getMyState());
  19. System.out.println(obs2.getMyState());
  20. System.out.println(obs3.getMyState());
  21. subject.set(600);
  22. System.out.println("===============状态修改了!");
  23. //观察者的状态发生了变化
  24. System.out.println(obs1.getMyState());
  25. System.out.println(obs2.getMyState());
  26. System.out.println(obs3.getMyState());
  27. //移除一个订阅者
  28. subject.deleteObserver(obs2);
  29. subject.set(100);
  30. System.out.println("===============状态修改了!");
  31. //观察者的状态发生了变化
  32. System.out.println(obs1.getMyState());
  33. System.out.println(obs2.getMyState());
  34. System.out.println(obs3.getMyState());
  35. }
  36. }

SpringBoot源码之监听器本质 - 图3
  这样就实现了官方提供观察者模式.

2.SpringBoot中监听器的设计

  然后我们来看下SpringBoot启动这涉及到的监听器这块是如何实现的。

2.1 初始化操作

  通过前面的介绍我们知道在SpringApplication的构造方法中会加载所有声明在spring.factories中的监听器。

SpringBoot源码之监听器本质 - 图4

  通过Debug模式我们可以看到加载的监听器有哪些。

SpringBoot源码之监听器本质 - 图5

  其实就是加载的spring.factories文件中的key为ApplicationListener的value

SpringBoot源码之监听器本质 - 图6

SpringBoot源码之监听器本质 - 图7

  通过对这些内置监听器的源码查看我们发现这些监听器都实现了 ApplicationEvent接口。也就是都会监听 ApplicationEvent发布的相关的事件。ApplicationContext事件机制是观察者设计模式的实现,通过ApplicationEvent类和ApplicationListener接口,可以实现ApplicationContext事件处理。

SpringBoot源码之监听器本质 - 图8

2.2 run方法

  然后我们来看下在SpringApplication.run()方法中是如何发布对应的事件的。

SpringBoot源码之监听器本质 - 图9

  首先会通过getRunListeners方法来获取我们在spring.factories中定义的SpringApplicationRunListener类型的实例。也就是EventPublishingRunListener.

SpringBoot源码之监听器本质 - 图10

SpringBoot源码之监听器本质 - 图11

SpringBoot源码之监听器本质 - 图12

  加载这个类型的时候会同步的完成实例化。

SpringBoot源码之监听器本质 - 图13

SpringBoot源码之监听器本质 - 图14

  实例化操作就会执行EventPublishingRunListener.

SpringBoot源码之监听器本质 - 图15

  在这个构造方法中会绑定我们前面加载的11个过滤器。

SpringBoot源码之监听器本质 - 图16

  到这其实我们就已经清楚了EventPublishingRunListener和我们前面加载的11个监听器的关系了。然后在看事件发布的方法。

SpringBoot源码之监听器本质 - 图17

查看starting()方法。

SpringBoot源码之监听器本质 - 图18

再进入

SpringBoot源码之监听器本质 - 图19

进入到multicastEvent中方法中我们可以看到具体的触发逻辑

SpringBoot源码之监听器本质 - 图20

在这儿以ConfigFileApplicationListener为例。

SpringBoot源码之监听器本质 - 图21

触发会进入ConfigFileApplicationListener对象的onApplicationEvent方法中,

SpringBoot源码之监听器本质 - 图22

通过代码我们可以发现当前的事件是ApplicationStartingEvent事件,都不满足,所以ConfigFileApplicationListener在SpringBoot项目开始启动的时候就不会做任何的操作。而当我们在配置环境信息的时候,会发布对应的事件来触发

SpringBoot源码之监听器本质 - 图23

SpringBoot源码之监听器本质 - 图24

继续进入

SpringBoot源码之监听器本质 - 图25

继续进入

SpringBoot源码之监听器本质 - 图26

然后再触发ConfigFileApplicationListener监听器的时候就会触发如下方法了

SpringBoot源码之监听器本质 - 图27

  其实到这儿,后面的事件发布与监听器的处理逻辑就差不多是一致了。到这儿对应SpringBoot中的监听器这块就分析的差不错了。像SpringBoot的属性文件中的信息什么时候加载的就是在这些内置的监听器中完成的。

SpringBoot源码之监听器本质 - 图28

官方内置的事件有:

SpringBoot源码之监听器本质 - 图29

  好了本文就给大家介绍到这里,希望能对你有所帮助哦。