8、Curator的监听机制

原生的zookeeper的监听API所实现的方法存在一些缺点，对于开发者来说后续的开发会考虑的细节比较多。

Curator所实现的方法希望摒弃原声API 的不足，是开发看起来更加的简单，一些重连等操作对开发者变成了透明操作，而不需要去考虑。

1. Curator的监听API

Curator的监听实现是对zookeeper原生监听方法的高级封装，主要体现在两点：监听重复注册，事件发生信息。而且监听事件返回详细的信息，如变动的节点信息，节点的value等。

Curator 提供了3个接口，包含在org.apache.curator.framework.recipes.cache下（点击超链接可查看对应的javadoc）

如图所示：

1) NodeCache: 对一个节点进行监听，监听事件包括指定的路径节点的增、删、改的操作。

2) PathChildrenCache: 对指定的路径节点的一级子目录进行监听，不对该节点的操作进行监听，对其子目录的节点进行增、删、改的操作监听

3) TreeCache:  可以将指定的路径节点作为根节点（祖先节点），对其所有的子节点操作进行监听，呈现树形目录的监听，可以设置监听深度，最大监听深度为2147483647（int类型的最大值）。

2. NodeCache

Node Cache - A utility that attempts to keep the data from a node locally cached. This class will watch the node, respond to update/create/delete events, pull down the data, etc. You can register a listener that will get notified when changes occur. (官网)

部分样例代码

NodeCache nodeCache = null;

nodeCache.start(true);
  // 如果为true则首次不会缓存节点内容到cache中，默认为false,设置为true首次不会触发监听事件

nodeCache.getListenable().addListener(new NodeCacheListener(){

            @Override
            public void nodeChanged() throws Exception {
                // 节点发生变化，回调方法
                byte[] ret = nodeCache.getCurrentData().getData();
                // getData()方法实现返回byte[]
                System.out.println("数据发生变化: " + new String(ret));
            }

        });

说明：

       /*
        * 节点路径不存在，set不触发监听
        * 节点路径不存在，创建事件触发监听（第一次创建时要触发）
        * 节点路径存在，set触发监听（改操作触发）
        * 节点路径存在，delete触发监听（删操作触发）
        *
        * 节点挂掉，未触发任何监听
        * 节点重连，未触发任何监听
        * 节点重连 ，恢复监听
        * */

2. PathChildrenCache

Path Cache - A Path Cache is used to watch a ZNode. Whenever a child is added, updated or removed, the Path Cache will change its state to contain the current set of children, the children's data and the children's state. Path caches in the Curator Framework are provided by the PathChildrenCache class. Changes to the path are passed to registered PathChildrenCacheListener instances.（官网）

部分样例代码：

PathChildrenCache pathChildrenCache = null;

pathChildrenCache.start(PathChildrenCache.StartMode.BUILD_INITIAL_CACHE);
        pathChildrenCache.getListenable().addListener(new PathChildrenCacheListener(){

            @Override
            public void childEvent(CuratorFramework client,
                    PathChildrenCacheEvent event) throws Exception {
                //
                switch(event.getType()) {
                case CHILD_ADDED:
                    System.out.println("添加了儿子节点  " + event.getData());
                    break;
                case CHILD_UPDATED:
                    System.out.println("儿子节点发生了更新  " + event.getData());
                    break;
                case CHILD_REMOVED:
                    System.out.println("儿子节点移除  " + event.getData());
                case CONNECTION_SUSPENDED: break;
                // ZK挂掉
                case CONNECTION_RECONNECTED: break;
                // 重新启动ZK
                case CONNECTION_LOST: break;
                // ZK挂掉一段时间后
                case INITIALIZED: break;
                default: break;
                }
            }

        });

说明：

        /**
         *  注册监听器，当前节点不存在，创建该节点：未抛出异常及错误日志
         *  注册子节点触发type=[CHILD_ADDED]
         *  更新触发type=[CHILD_UPDATED]
         *
         *  zk挂掉type=CONNECTION_SUSPENDED,，一段时间后type=CONNECTION_LOST
         *  重启zk：type=CONNECTION_RECONNECTED, data=null
         *  更新子节点：type=CHILD_UPDATED, data=ChildData{path='/zktest111/tt1', stat=4294979983,4294979993,1501037475236,1501037733805,2,0,0,0,6,0,4294979983
            ,data=[55, 55, 55, 55, 55, 55]}
​
         *  删除子节点type=CHILD_REMOVED
         *  更新根节点：不触发
         *  删除根节点：不触发  无异常
         *  创建根节点：不触发
         *  再创建及更新子节点不触发
         *
         *  重启时，与zk连接失败
         */

3. TreeCache

Tree Cache - A utility that attempts to keep all data from all children of a ZK path locally cached. This class will watch the ZK path, respond to update/create/delete events, pull down the data, etc. You can register a listener that will get notified when changes occur.（官网）

部分样例代码：

TreeCache treeCache = null;

treeCache.start();
        // 没有开启模式作为入参的方法

        treeCache.getListenable().addListener(new TreeCacheListener(){

            @Override
            public void childEvent(CuratorFramework client, TreeCacheEvent event)
                    throws Exception {
                //
                switch(event.getType()) {
                case NODE_ADDED:
                    System.out.println("tree:发生节点添加" + event.getData().toString() ); break;
                case NODE_UPDATED:
                    System.out.println("tree:发生节点更新"); break;
                case NODE_REMOVED:
                    System.out.println("tree:发生节点删除"); break;
                case CONNECTION_SUSPENDED:
                    break;
                case CONNECTION_RECONNECTED:
                    break;
                case CONNECTION_LOST:
                    break;
                case INITIALIZED:
                    System.out.println("初始化的操作"); break;
                default:
                    break;
                }
            }

        });

说明：

        /**
         * TreeCache.nodeState == LIVE的时候，才能执行getCurrentChildren非空,默认为PENDING
         * 初始化完成之后，监听节点操作时 TreeCache.nodeState == LIVE
         *
         * maxDepth值设置说明，比如当前监听节点/t1，目录最深为/t1/t2/t3/t4,则maxDepth=3,说明下面3级子目录全
         * 监听，即监听到t4，如果为2，则监听到t3,对t3的子节点操作不再触发
         * maxDepth最大值2147483647
         *
         * 初次开启监听器会把当前节点及所有子目录节点，触发[type=NODE_ADDED]事件添加所有节点（小等于maxDepth目录）
         * 默认监听深度至最低层
         * 初始化以[type=INITIALIZED]结束
         *
         *  [type=NODE_UPDATED],set更新节点值操作，范围[当前节点，maxDepth目录节点](闭区间)
         *
         *
         *  [type=NODE_ADDED] 增加节点 范围[当前节点，maxDepth目录节点](左闭右闭区间)
         *
         *  [type=NODE_REMOVED] 删除节点， 范围[当前节点， maxDepth目录节点](闭区间),删除当前节点无异常
         *
         *  事件信息
         *  TreeCacheEvent{type=NODE_ADDED, data=ChildData{path='/zktest1',                     stat=4294979373,4294979373,1499850881635,1499850881635,0,0,0,0,2,0,4294979373
         , data=[116, 49]}}
         *
         */