zkclient的使用

Posted 2021-02-11 programmlover

zkclient简介：ZKCient是有Datameer的工程师StefanGroschupf和Peter voss 一起开发的。在源生API接口基础上进行了封装，简化了ZK的复杂性。

一  创建客户端方法: ZKCllent (Arguments )

参数1: zkServers zookeeper服务器的地址，用”,"分割。

参数2: session Timeout 超时会话，为毫秒，默认为30 000ms

参数3: connection Timeout 连接超时会话。

参数4: IZkConnection接口的实现类。

参数5: zkSerlalizer自定义序列化实现。

 

二  创建节点方法: create、 createEphemeral、 createEphemeralSequential、createPersistent、createPersistentSequential

参数1: path, 路径

参数2: data, 数据内容，可以传入null

参数3: mode,节点类型，为一个枚举类型，4种形式

参数4: acl策略

参数5: callback 回调函数

参数6: context 上下文对象

参数7: createParents 是否创建父节点

 

三  删除节点方法：delete、deleteRecursive

参数1: path 路径

参数2: callback 回调函数

参数3: context .上下文对象

 

四  读取子节点数据方法: getChildren

参数1: path路径

 

五  读取节点数据方法: readData

参数1: path路径

参数2: returnNullfPathNotExists (避免为空节点抛出异常，直接返回null)

参数3:节点状态

 

六  更新数据方法writeData

参数1: path 路径
参数2: data 数据信息

参数3: version 版本号

 

七  检测节点是否存在方法exists

参数1: path 路径

 

我们发现，上述ZkClient里 面并没有类似的watcher、watch参数，这也就是说我们开发人员无需关心反复注册Watcher的问题, ZkClent给我们提供了一套监听方式，我们可以使用监听节点的方式进行操作，剔除了繁琐的反复wather操作，减化了代码的复杂程度。

八  subscribeChildChanges方法

参数1: path路径

参数2:实现了IZkChildListener接口的类(如:实例化ZkChildListener类)

只需要重写其handleChildChangs(String parentPath, List<String>currentChilds)方法。其中参数parentPath为所监听节点全路径，currentChilds为最新的子节点列表(相对路径)。IZkChildListener事件说明针对于下面三个事件触发：

　　新增子节点、减少子节点、删除节点

 

通过之前的方法我们发现，其IZkChildListener有以 下特点:

　　1 客户端可以对一个不存在的节点进行变更的监听。

　　2 一旦客户端对一个节点注册了子节点列表变更监听后，那么当前节点的子节点列表发送变更的时候，服务器端都会通知客户端，并将最新的子节点列表发送给客户端。

　　3 该节点本身创建或删除也会通知到客户端。

　　4 另外最重要的是这个监听是一直存在的。不是单次监听，相比较原生API提供的要简单的多了。

 

 九 IZkDataListener接口，需要重写俩个方法:
　　(1) handleDataChange(String dataPath, Object data)

　　(2) handleDataDeleted(String dataPath)

分别为节点变更和节点删除事件。 

 

示例1： 没有watch的使用

import java.util.List;
import org.I0Itec.zkclient.ZkClient;
import org.I0Itec.zkclient.ZkConnection;

public class ZkClientBase {

    /** zookeeper地址 */
    static final String CONNECT_ADDR = "192.168.1.101:2181,192.168.1.38:2181,192.168.1.39:2181";
    /** session超时时间 */
    static final int SESSION_OUTTIME = 5000;//ms 
    
    
    public static void main(String[] args) throws Exception {
        ZkClient zkc = new ZkClient(new ZkConnection(CONNECT_ADDR), 5000);
        //1. create and delete方法 
        zkc.createEphemeral("/temp");
        zkc.createPersistent("/super/c1", true);
        Thread.sleep(3000);
        zkc.delete("/temp");
        //递归删除
        zkc.deleteRecursive("/super");
        
        //2. 设置path和data 并且读取子节点和每个节点的内容
        zkc.createPersistent("/super", "1234");
        zkc.createPersistent("/super/c1", "c1内容");
        zkc.createPersistent("/super/c2", "c2内容");
        List<String> list = zkc.getChildren("/super");
        for(String p : list){
            System.out.println(p);
            String rp = "/super/" + p;
            String data = zkc.readData(rp);
            System.out.println("节点为：" + rp + "，内容为: " + data);
        }
        
        //3. 更新和判断节点是否存在
        zkc.writeData("/super/c1", "新内容");
        System.out.println(zkc.readData("/super/c1")+"");
        System.out.println(zkc.exists("/super/c1"));
        
        //4.递归删除/super内容
        zkc.deleteRecursive("/super");        
    }
}

 

示例2  有watch的使用一 subscribeChildChanges方法

import java.util.List;
import org.I0Itec.zkclient.IZkChildListener;
import org.I0Itec.zkclient.ZkClient;
import org.I0Itec.zkclient.ZkConnection;

public class ZkClientWatcher1 {

    /** zookeeper地址 */
    static final String CONNECT_ADDR = "192.168.1.101:2181";
//    static final String CONNECT_ADDR = "192.168.1.101:2181,192.168.1.38:2181,192.168.1.39:2181";
    /** session超时时间 */
    static final int SESSION_OUTTIME = 5000;//ms 
    
    
    public static void main(String[] args) throws Exception {
        ZkClient zkc = new ZkClient(new ZkConnection(CONNECT_ADDR), 5000);
        
        //对父节点添加监听子节点变化。
        zkc.subscribeChildChanges("/super", new IZkChildListener() {
            @Override
            public void handleChildChange(String parentPath, List<String> currentChilds) throws Exception {
                System.out.println("parentPath: " + parentPath);
                System.out.println("currentChilds: " + currentChilds);
            }
        });
        
        Thread.sleep(3000);
        
        zkc.createPersistent("/super");
        Thread.sleep(1000);
        
        zkc.createPersistent("/super" + "/" + "c1", "c1内容");
        Thread.sleep(1000);
        
        zkc.createPersistent("/super" + "/" + "c2", "c2内容");
        Thread.sleep(1000);        
        
        zkc.delete("/super/c2");
        Thread.sleep(1000);    
        
        zkc.deleteRecursive("/super");
        Thread.sleep(Integer.MAX_VALUE);
    }
}

从结果我们可以看出subscribeChildChanges之检查子节点的增删，不检查子节点的更新操作

 

示例3 有watch的使用二 subscribeDataChanges方法

import org.I0Itec.zkclient.IZkDataListener;
import org.I0Itec.zkclient.ZkClient;
import org.I0Itec.zkclient.ZkConnection;

public class ZkClientWatcher2 {

    /** zookeeper地址 */
    static final String CONNECT_ADDR = "192.168.1.101:2181";
//    static final String CONNECT_ADDR = "192.168.1.101:2181,192.168.1.38:2181,192.168.1.39:2181";
    /** session超时时间 */
    static final int SESSION_OUTTIME = 5000;//ms 
    
    
    public static void main(String[] args) throws Exception {
        ZkClient zkc = new ZkClient(new ZkConnection(CONNECT_ADDR), 5000);
        
        zkc.createPersistent("/super", "1234");
        
        //对父节点添加监听子节点变化。
        zkc.subscribeDataChanges("/super", new IZkDataListener() {
            @Override
            public void handleDataDeleted(String path) throws Exception {
                System.out.println("删除的节点为:" + path);
            }
            
            @Override
            public void handleDataChange(String path, Object data) throws Exception {
                System.out.println("变更的节点为:" + path + ", 变更内容为:" + data);
            }
        });
        
        Thread.sleep(3000);
        zkc.writeData("/super", "456", -1);
        Thread.sleep(1000);

        zkc.delete("/super");
        Thread.sleep(Integer.MAX_VALUE);
    }
}