【ZooKeeper Notes 13】ZooKeeper Watcher的事件通知类型

转载请注明：@ni掌柜

    本文重点围绕ZooKeeper的Watcher，介绍通知的状态类型和事件类型，以及这些事件通知的触发条件。

 

1、浅谈Watcher接口

在ZooKeeper中，接口类Watcher定义了事件通知相关的逻辑，包含了KeeperState和EventType两个枚举类，分别代表通知状态和事件类型。还有一个比较重要的接口方法：

1. abstract public void process(WatchedEvent event); 

这个方法用于处理事件通知，每个实现类都应该自己实现合适的处理逻辑。参数WatchedEvent类封装了上面提到的两个枚举类，以及触发事件对应的ZK节点path，当然，这个path不一定每次通知都有，例如会话建立，会话失效或连接断开等通知类型，就不是针对某一个单独path的。

2、如何注册Watcher

上面已经提到，Watcher接口已经提供了基本的回调方法用于处理来自服务器的通知。因此，我们只要在合适的地方实现这个接口，并传给服务器即可。下面来看看哪些是合适的地方： 

A、构造方法

1. ZooKeeper(String connectString, int sessionTimeout, Watcher watcher) 

上面这个是ZooKeeper的一个构造方法，与ZK创建连接的时候会用到这个。这里我们重点关注第三个参数：Watcher，很显然在，这个就是一个注册Watcher的地方，传入的参数就是开发者自己Watcher接口实现。需要注意的是，这个地方注册的Watcher实现，会成为当前ZK会话的默认Watcher实现。也就是说，其它地方如果也想注册一个Watcher，那么是可以默认使用这个实现的。具体下面会涉及到。

B、API的读写接口中

1. public Stat exists(String path, boolean watch)throws KeeperException, InterruptedException 
2.  
3. public List<String> getChildren(String path, boolean watch)throws KeeperException,InterruptedException 
4.  
5. public byte[] getData(String path,boolean watch,Stat stat)throws KeeperException,InterruptedException 
6.  
7. public void register(Watcher watcher) 

 

 

3、通知的状态类型与事件类型

在Watcher接口类中，已经定义了所有的状态类型和事件类型，这里把各个状态和事件类型之间的关系整理一下。

3.1状态：KeeperState.Disconnected(0)

此时客户端处于断开连接状态，和ZK集群都没有建立连接。

3.1.1事件：EventType.None(-1)

触发条件：一般是在与服务器断开连接的时候，客户端会收到这个事件。

 

3.2状态：KeeperState. SyncConnected(3)

3.2.1事件：EventType.None(-1)

触发条件：客户端与服务器成功建立会话之后，会收到这个通知。

3.2.2事件：EventType. NodeCreated (1)

触发条件：所关注的节点被创建。

3.2.3事件：EventType. NodeDeleted (2)

触发条件：所关注的节点被删除。

3.2.4事件：EventType. NodeDataChanged (3)

触发条件：所关注的节点的内容有更新。注意，这个地方说的内容是指数据的版本号dataVersion。因此，即使使用相同的数据内容来更新，还是会收到这个事件通知的。无论如何，调用了更新接口，就一定会更新dataVersion的。

3.2.5事件：EventType. NodeChildrenChanged (4)

触发条件：所关注的节点的子节点有变化。这里说的变化是指子节点的个数和组成，具体到子节点内容的变化是不会通知的。

 

3.3状态 KeeperState. AuthFailed(4)

3.3.1事件：EventType.None(-1)

 

3.4状态 KeeperState. Expired(-112)

3.4.1事件：EventType.None(-1)

 

 

 

4、程序实例

这里有一个可以用来演示“触发事件通知”和“如何处理这些事件通知”的程序AllZooKeeperWatcher.java。

在这里：https://github.com/alibaba/taokeeper/blob/master/taokeeper-research/src/main/java/com/taobao/taokeeper/research/watcher/AllZooKeeperWatcher.java

运行结果如下：

1. 2012-08-05 06:35:23,779 - 【Main】开始连接ZK服务器 
2. 2012-08-05 06:35:24,196 - 【Watcher-1】收到Watcher通知 
3. 2012-08-05 06:35:24,196 - 【Watcher-1】连接状态:  SyncConnected 
4. 2012-08-05 06:35:24,196 - 【Watcher-1】事件类型:  None 
5. 2012-08-05 06:35:24,196 - 【Watcher-1】成功连接上ZK服务器 
6. 2012-08-05 06:35:24,196 - -------------------------------------------- 
7. 2012-08-05 06:35:24,354 - 【Main】节点创建成功, Path: /nileader, content: 1353337464279 
8. 2012-08-05 06:35:24,554 - 【Watcher-2】收到Watcher通知 
9. 2012-08-05 06:35:24,554 - 【Watcher-2】连接状态:  SyncConnected 
10. 2012-08-05 06:35:24,554 - 【Watcher-2】事件类型:  NodeCreated 
11. 2012-08-05 06:35:24,554 - 【Watcher-2】节点创建 
12. 2012-08-05 06:35:24,582 - -------------------------------------------- 
13. 2012-08-05 06:35:27,471 - 【Main】更新数据成功，path：/nileader,  
14.  
15. 2012-08-05 06:35:27,667 - 【Watcher-3】收到Watcher通知 
16. 2012-08-05 06:35:27,667 - 【Watcher-3】连接状态:  SyncConnected 
17. 2012-08-05 06:35:27,667 - 【Watcher-3】事件类型:  NodeDataChanged 
18. 2012-08-05 06:35:27,667 - 【Watcher-3】节点数据更新 
19. 2012-08-05 06:35:27,696 - 【Watcher-3】数据内容: 1353337467434 
20. 2012-08-05 06:35:27,696 - -------------------------------------------- 
21. 2012-08-05 06:35:30,534 - 【Main】节点创建成功, Path: /nileader/ch, content: 1353337470471 
22. 2012-08-05 06:35:30,728 - 【Watcher-4】收到Watcher通知 
23. 2012-08-05 06:35:30,728 - 【Watcher-4】连接状态:  SyncConnected 
24. 2012-08-05 06:35:30,728 - 【Watcher-4】事件类型:  NodeCreated 
25. 2012-08-05 06:35:30,728 - 【Watcher-4】节点创建 
26. 2012-08-05 06:35:30,758 - -------------------------------------------- 
27. 2012-08-05 06:35:30,958 - 【Watcher-5】收到Watcher通知 
28. 2012-08-05 06:35:30,958 - 【Watcher-5】连接状态:  SyncConnected 
29. 2012-08-05 06:35:30,958 - 【Watcher-5】事件类型:  NodeChildrenChanged 
30. 2012-08-05 06:35:30,958 - 【Watcher-5】子节点变更 
31. 2012-08-05 06:35:30,993 - 【Watcher-5】子节点列表：[ch] 
32. 2012-08-05 06:35:30,993 - -------------------------------------------- 
33. 2012-08-05 06:35:33,618 - 【Main】删除节点成功，path：/nileader/ch 
34. 2012-08-05 06:35:33,756 - 【Main】删除节点成功，path：/nileader 
35. 2012-08-05 06:35:33,817 - 【Watcher-6】收到Watcher通知 
36. 2012-08-05 06:35:33,817 - 【Watcher-6】连接状态:  SyncConnected 
37. 2012-08-05 06:35:33,817 - 【Watcher-6】事件类型:  NodeDeleted 
38. 2012-08-05 06:35:33,817 - 【Watcher-6】节点 /nileader/ch 被删除 
39. 2012-08-05 06:35:33,817 - -------------------------------------------- 
40. 2012-08-05 06:35:34,017 - 【Watcher-7】收到Watcher通知 
41. 2012-08-05 06:35:34,017 - 【Watcher-7】连接状态:  SyncConnected 
42. 2012-08-05 06:35:34,017 - 【Watcher-7】事件类型:  NodeChildrenChanged 
43. 2012-08-05 06:35:34,017 - 【Watcher-7】子节点变更 
44. 2012-08-05 06:35:34,109 - 【Watcher-7】子节点列表：null 
45. 2012-08-05 06:35:34,109 - -------------------------------------------- 
46. 2012-08-05 06:35:34,309 - 【Watcher-8】收到Watcher通知 
47. 2012-08-05 06:35:34,309 - 【Watcher-8】连接状态:  SyncConnected 
48. 2012-08-05 06:35:34,309 - 【Watcher-8】事件类型:  NodeDeleted 
49. 2012-08-05 06:35:34,309 - 【Watcher-8】节点 /nileader 被删除 
50. 2012-08-05 06:35:34,309 - --------------------------------------------