ZooKeeper客户端编程(三)

前面说了一些ZooKeeper理论上的内容，对于实践部分，想必都是跃跃欲试。这里我想主要介绍几个Java的demo来起到抛砖引玉的作用，Zookeeper客户端框架具体的细节部分若深入起来不是三言两语能解释的完的，我适当的说明一些，深入的研究还望一起努力。

假设你已经对zkCli的基本命令较熟悉了：

• create 创建节点
• delete 删除节点
• exists 判断节点是否存在
• getChildren 获取节点下的所有子节点
• getData 获取节点的数据
• setData 在节点写入或更新数据
• getACL 获取某节点的ACL
• setACL 设置某节点的ACL
• sync 同步某客户端znode的状态

准备

• 电脑上有Java开发环境
• maven，下载ZooKeeper Java客户端的源码
• 浏览器 ，ZooKeeper API文档(http://zookeeper.apache.org/doc/r3.4.6/api/index.html)

Java案例

1. 列出指定节点下的内容

public class ZooState {

    public static void main(String[] args) throws IOException, KeeperException, InterruptedException {
        String hostPort = "192.168.8.250:2181";
        String zPath = "/";
        List<String> zooChildren = new ArrayList<>();
        //构造ZooKeeper的实例
        ZooKeeper zooKeeper = new ZooKeeper(hostPort, 2000, null);
        try {
            //获取节点下的内容
            zooChildren = zooKeeper.getChildren(zPath,false);
            System.out.println("Znodes of /:");
            for (String zooChild : zooChildren) {
                System.out.println(zooChild);
            }
        } catch (InterruptedException e) {
            e.printStackTrace();
        } catch (KeeperException e) {
            e.printStackTrace();
        }
    }
}

ZooKeeper的构造参数：

• connectString 服务器列表，多个服务器用逗号分隔开，如"127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002"。如果要使用chroot特性，那么加上路径后缀。如"127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002/app/a"
• sessionTimeout session的超时时间，毫秒为单位。在sessionTimeout内没有心跳检测，会话就标记为失效的
• watcher watcher对象用来通知对象的改变，可以传入null
• canBeReadOnly 是否支持只读模式。当ZooKeeper服务器挂掉的时候，还是希望ZooKeeper能提供读服务。
• sessionId和sessionPasswd 用于确定唯一一个会话，可以实现客户端的会话复用

Zookeeper实例提供了很多我们操作ZooKeeper数据的接口，记得看它的详细介绍。

我自己是觉得Java Doc已经解释的很详细了，我列出几个使用客户端API的案例。

1. 注册zNode监听事件

    @Slf4j
    public class DataWatch implements Watcher,Runnable{

        String hostPart = "192.168.8.250:2181";
        String zooDataPath = "/MyConfig";
        byte[] zooData = null;
        ZooKeeper zk;
        
         public static void main(String[] args) throws IOException, KeeperException, InterruptedException {
        DataWatch dataWatch = new DataWatch();
        dataWatch.printData();
        dataWatch.run();
      }

        public DataWatch() {
            try {
                zk = new ZooKeeper(hostPart,2000,this);
                if (zk.exists(zooDataPath,this) == null){
                    zk.create(zooDataPath,"".getBytes(), ZooDefs.Ids.OPEN_ACL_UNSAFE,CreateMode.PERSISTENT);

                }
            } catch (IOException | KeeperException | InterruptedException e) {
                e.printStackTrace();
            }
        }

        public void printData() throws KeeperException, InterruptedException {
            zooData = zk.getData(zooDataPath,this,null);
            String zString = new String(zooData);
            log.info("\nCurrent Data: %s %s",zooDataPath,zString);
        }



        @Override
        public void run() {
            try {
                synchronized (this){
                    while (true){
                        wait();
                    }
                }
            } catch (InterruptedException e) {
                e.printStackTrace();
                Thread.currentThread().interrupt();
            }
        }

        @Override
        public void process(WatchedEvent event) {
            System.out.printf("\nReceive Events: %s",event.toString());
            // 我们只处理数据改变的Node
            if (event.getType() == Event.EventType.NodeDataChanged){
                try {
                    printData();
                } catch (KeeperException | InterruptedException e) {
                    e.printStackTrace();
                }
            }
        }
    }

简单的实现将监听器指向自己，当节点数据改变的时候打印节点中的内容。在zkCli中试着改变/MyConfig节点查看效果。

1. ACL访问控制的例子

public class ZooAcl {
    public static void main(String[] args) throws IOException, KeeperException, InterruptedException {
        String hostPort = "192.168.8.250:2181";
        String zooDataPath = "/Auth";
        byte[] zooData = null;
        ZooKeeper zk = new ZooKeeper(hostPort, 2000, null);
        zk.addAuthInfo("digest","foo:true".getBytes());
        zk.create(zooDataPath, "init".getBytes(), ZooDefs.Ids.CREATOR_ALL_ACL, CreateMode.EPHEMERAL);

        ZooKeeper zk2 = new ZooKeeper(hostPort, 2000, null);
        zk2.getData(zooDataPath,false,null);

    }
}

这个实例，首先创建一个包含权限信息的客户端创建一个数据节点，然后使用另外一个不包含权限信息的客户端访问。运行会出现异常。

Exception in thread "main" org.apache.zookeeper.KeeperException$NoAuthException: KeeperErrorCode = NoAuth for /Auth

额外-Curator

除了ZooKeeper官方的Java API，开源社区也提供了更好的对ZooKeeper的封装，常用的有ZkClient和Curator。最受欢迎的是Curator，所以建议使用Curator，若想要对ZooKeeper有更深入的研究，两者的实现都可以看一下。

我这里略提一些Curator的内容。它是Netfix公司开源的一套ZooKeeper客户端框架，它解决了很多ZooKeeper客户端非常底层的细节开发工作，包括连接重连，反复注册Watcher和NodeExistsException异常等。目前是Apache的顶级项目，ZooKeeper的核心代码提交者Patrick Hunt以一句“Guava is to Java what Curator to ZooKeeper”。对其进行了高度评价。

因为Curator对底层封装的很好，用起来也特别方便，并且提供了一套易用性和可读性更强的Fluent风格的客户端API框架。

Curator有些maven的源值得提一下：

<!-- https://mvnrepository.com/artifact/org.apache.curator/curator-framework -->
// 开发所用的curator maven依赖
<dependency>
    <groupId>org.apache.curator</groupId>
    <artifactId>curator-framework</artifactId>
    <version>4.0.1</version>
</dependency>


<!-- https://mvnrepository.com/artifact/org.apache.curator/curator-examples -->
// curator的使用案例。可以进行参考
<dependency>
    <groupId>org.apache.curator</groupId>
    <artifactId>curator-examples</artifactId>
    <version>4.0.1</version>
</dependency>

<!-- https://mvnrepository.com/artifact/org.apache.curator/curator-recipes -->
// Curator的常见用法，常用的应用场景
<dependency>
    <groupId>org.apache.curator</groupId>
    <artifactId>curator-recipes</artifactId>
    <version>4.0.1</version>
</dependency>

// 几句样例代码

CuratorFramework client = CuratorFrameworkFactory.builder()
    .connectString("192.168.8.250:2181")
    .sessionTimeoutMs(5000)
    .retryPolicy(new ExponentBackoffRetry(1000,3))
    .build();
client.start();    
//创建一个节点，初始内容为空
client.create().forPath("/parent");
//创建一个节点，附带初始内容
client.create().forPath("/parent","init".getBytes());
// 创建一个临时节点，初始内容为空
client.create().withMode( CreateMode.EPHEMERAL ).forPath("/parent");

// 创建一个临时节点，并自动创建父节点，这个接口非常有用，开发人员经常碰到NoNodeException.
client.create()
.creatingParentsIfNeeded()
.withMode( CreateMode.EPHEMERAL ).forPath("/parent");

最后

这篇文章主要给了几个关于ZooKeeper Java API的用法，API中有很多常用的用法文档写的很明白了，就未过多的进行讲解。最后又提了一下使用很广泛的Curator框架，带大家了解了一下Curator的用法，想要继续深入的话全屏个人兴趣。

参考

• 《从Paxos到ZooKeeper-分布式一致性原理与实践》
• 《Apache ZooKeeper Essential》
• ZooKeeper Programing Guide
• Curator 官网