zookeeper 的 watcher 机制,可以分为四个过程:

  • 客户端注册 watcher。
  • 服务端处理 watcher。
  • 服务端触发 watcher 事件。
  • 客户端回调 watcher。

其中客户端注册 watcher 有三种方式,调用客户端 API 可以分别通过 getData、exists、getChildren 实现,利用前面章节创建的 maven 工程,新建 WatcherDemo 类,以 exists 方法举例说明其原理。

  1. public class WatcherDemo implements Watcher {
  2. static ZooKeeper zooKeeper;
  3. static {
  4. try {
  5. zooKeeper = new ZooKeeper("127.0.0.1:2181", 4000,new WatcherDemo());
  6. } catch (IOException e) {
  7. e.printStackTrace();
  8. }
  9. }
  10. @Override
  11. public void process(WatchedEvent event) {
  12. System.out.println("eventType:"+event.getType());
  13. if(event.getType()==Event.EventType.NodeDataChanged){
  14. try {
  15. zooKeeper.exists(event.getPath(),true);
  16. } catch (KeeperException e) {
  17. e.printStackTrace();
  18. } catch (InterruptedException e) {
  19. e.printStackTrace();
  20. }
  21. }
  22. }
  23. public static void main(String[] args) throws IOException, KeeperException, InterruptedException {
  24. String path="/watcher";
  25. if(zooKeeper.exists(path,false)==null) {
  26. zooKeeper.create("/watcher", "0".getBytes(), ZooDefs.Ids.OPEN_ACL_UNSAFE, CreateMode.PERSISTENT);
  27. }
  28. Thread.sleep(1000);
  29. System.out.println("-----------");
  30. //true表示使用zookeeper实例中配置的watcher
  31. Stat stat=zooKeeper.exists(path,true);
  32. System.in.read();
  33. }
  34. }

运行完程序,控制台显示:
Zookeeper watcher 事件机制原理剖析 - 图1
此时启动 zookeeper 命令行终端,查看并且删除 watcher 节点:
Zookeeper watcher 事件机制原理剖析 - 图2
IDE 控制台输出,触发了节点删除事件:
Zookeeper watcher 事件机制原理剖析 - 图3
客户端发送请求给服务端是通过 TCP 长连接建立网络通道,底层默认是通过 java 的 NIO 方式,也可以配置 netty 实现方式。
Zookeeper watcher 事件机制原理剖析 - 图4
注册 watcher 监听事件流程图:
Zookeeper watcher 事件机制原理剖析 - 图5

1、客户端发送事件通知请求

在 Zookeeper 类调用 exists 方法时候,把创建事件监听封装到 request 对象中,watch 属性设置为 true,待服务端返回 response 后把监听事件封装到客户端的 ZKWatchManager 类中。
Zookeeper watcher 事件机制原理剖析 - 图6

2、服务端处理 watcher 事件的请求

服务端 NIOServerCnxn 类用来处理客户端发送过来的请求,最终调用到 FinalRequestProcessor,其中有一段源码添加客户端发送过来的 watcher 事件:
Zookeeper watcher 事件机制原理剖析 - 图7
然后进入 statNode 方法,在 DataTree 类方法中添加 watcher 事件,并保存至 WatchManager 的 watchTable 与 watch2Table 中。
Zookeeper watcher 事件机制原理剖析 - 图8
Zookeeper watcher 事件机制原理剖析 - 图9

3、服务端触发 watcher 事件流程:

若服务端某个被监听的节点发生事务请求,服务端处理请求过程中调用 FinalRequestProcessor 类 processRequest 方法中的代码如下所示:
Zookeeper watcher 事件机制原理剖析 - 图10
删除调用链最终到 DataTree 类中删除节点分支的触发代码段:
Zookeeper watcher 事件机制原理剖析 - 图11
进入 WatchManager 类的 triggerWatch 方法:
Zookeeper watcher 事件机制原理剖析 - 图12
继续跟踪进入 NIOServerCnxn,构建了一个 xid 为 -1,zxid 为 -1 的 ReplyHeader 对象,然后再调用 sendResonpe 方法。
Zookeeper watcher 事件机制原理剖析 - 图13

4、客户端回调 watcher 事件

客户端 SendThread 类 readResponse 方法接收服务端触发的事件通知,进入 xid 为 -1 流程,处理 Event 事件。
Zookeeper watcher 事件机制原理剖析 - 图14
Zookeeper watcher 事件机制原理剖析 - 图15