从PAXOS到ZOOKEEPER分布式一致性原理与实践：Watcher--数据变更的通知

本文内容为《从PAXOS到ZOOKEEPER分布式一致性原理与实践》一书学习笔记。本文主要概述第七章Watcher机制内容。

Water机制概述

Water机制用来实现分布式的通知功能，ZooKeeper允许客户端向服务端注册一个Watcher监听，当服务端的一些指定事件触发了Watcher，会向客户端发送事件通知。

1.客户端注册Watcher

Watcher接口类用于表示一个标准的事件处理器，包含KeeperState和EventTyepe两个枚举类，分别表示通知状态和事件类型，同时定义了事件回调方法process()。在创建ZooKeeper客户端对象实例时，可以向构造方法中传入一个默认的Watcher。该Watcher即整个ZooKeeper会话期间的默认Watcher。另外，ZooKeeper客户端也可以通过getData、getChilden和exist三个接口来向ZooKeeper服务器注册Watcher。然后把Watcher对象封装成WatchRegistration对象（暂存数据节点的路径和Watcher的对应关系），然后将WatchRegistration对象封装成Packet（在ZooKeeper中，Packet是用于客户端与服务器之间网络传输的最小通信协议单元，任何需要传输的对象都需要包装成一个Packet对象），之后将该Packet放入发送队列outgoingQueue中去，等待客户端发送出去。底层发送先进行序列化，只序列化packet中的请求头和请求体到底层字节数组中（并不是完全序列化WatchRegistration对象，如果客户端注册的所有Watcher都被传递到服务端的话，服务端肯定会出现内存紧张或其他性能问题），由客户端线程SendThread进行发送到服务器，请求发送完毕后将该Packet保存到等待响应队列pendingQueue中。之后仍然由SendThread来进行响应接收（客户端SendThread线程的readRespnse方法负责接收来自服务端的响应），这是一次常规的响应（不是Watch事件），然后从pendingQueue拿出一个packet进行处理，检验ZXID确保请求处理的顺序性（串行化，书中并没见这句）。最后客户端将Watcher从WatchRegistration对象取出转交到ZKWatcherManager中的Map集合dataWatches（路径和watcher对象的映射）（客户端已经将Watcher暂时封装在了WatchRegistration对象中，现在就需要从这个封装对象中再次提取出Watcher，在register方法中，客户端会将之前暂时保存的的Watcher对象转交给ZKWatcherManager，并最终保存到dataWatches中去。ZKWatcherManager. dataWatches用于将数据节点的路径和Watcher对象进行一一映射后管理起来。它一个Map>类型的数据结构。）完成整个注册过程。

服务端会进行是否需要注册watcher的判断，通过（FinalRequestProcessor.processRequest()中的）getDataRequest.getWatch是来判断，需要注册则最终将数据节点、节点路径、ServerCnxn（看做watcher对象）（ServerCnxn是一个ZooKeeper客户端和服务器之间的连接端口，代表了一个客户端和服务器的连接，它实现了Watcher的process接口，因此它可以看成是一个Watcher对象）存储在WatchManager中（WatchManager是ZooKeeper服务端Watcher的管理者，其内部管理的watchTable 是从数据节点路径的粒度来托管Watcher，watch2Paths是从Watcher的粒度来控制事件触发需要触发的数据节点；WatchManager还负责Watcher事件的触发并移除已被触发的Watcher）。WatchManager具体由服务端DataTree中dataWatches和childWatches托管。

2.Watcher触发

举例：节点数据变更的倾听。会在setData（）数据修改（对指定节点进行数据更新）后调用dataWatches.triggerWatch方法进行触发。触发过程：
1）封装WatchedEvent。首先将KeeperState、EventType（通知状态和事件类型）和节点路径（Path）封装成WatchedEvent对象；
2）查询Watcher。从WatchManager查询到watcher并将其取出并删除（根据数据节点的节点路径从watchTable中取出对应的Watcher，如果没有找到Watcher，说明没有任何客户端在该数据节点上注册过Watcher，直接退出。如果找到了，会将其提取出来，同时会直接从watchTable和watch2Paths中将其删除），说明触发只有一次性。（Watcher在服务端是一次性的）。
3）调用process方法来触发Watcher。利用watcher（实质上是ServerCnxn，代表连接接口）调用process方法，将WatchedEvent对象包装成WatcherEvent（实现了序列化接口便于发送），最后向客户端发送该通知。

3.客户端回调Watcher

客户端SendThread线程调用readRespnse进行处理。
1）反序列化。ZooKeeper客户端会首先将字节流反序列化成WatcherEvent对象。
2）处理chrootPath。（如果客户端设置了chrootPath属性，需要对服务端传过来的完整的节点路径进行chrootPath处理，生成客户端的一个相对节点路径。）
3）还原WatchedEvent。（将WatcherEvent对象转换成WatchedEvent）
4）回调Watcher。将WatchedEvent对象交给EventThread线程。EventThread . queueEvent会根据该通知事件从ZKWatcherManager中的Map集合dataWatches（也可能是existWatches/childWatches）取出watcher并移除原来的储存（客户端识别出事件类型EventType后从相应的Watcher存储移除），也是一次性触发（使用的是remove接口，表明客户端的Watcher机制也是一次性的）。获取到所有的Watcher之后，会将其放入waitingEvents这个队列（待处理Watcher的队列）中去，EventThread线程的run方法对这个队列进行处理，最后进行watcher.process方法的真正回调（此方法中的Watcher才是客户端真正注册的Watcher，调用其process方法就可以实现Watcher的回调了）。