在Java中操作Zookeeper的示例代码详解

Z时代
2024-01-10
分类：综合

依赖


 <dependency>
    <groupId>org.apache.zookeeper</groupId>
    <artifactId>zookeeper</artifactId>
    <version>3.6.0</version>
  </dependency>

连接到zkServer


//连接字符串,zkServer的ip、port，如果是集群逗号分隔
  String connectStr = "192.168.1.9:2181";
  //zookeeper就是一个zkCli
ZooKeeper zooKeeper = null;
  try {
　　　　　//初始次数为1。后面要在内部类中使用，三种写法：1、写成外部类成员变量，不用加final；2、作为函数局部变量，放在try外面，写成final；3、写在try中，不加final
  　　 CountDownLatch countDownLatch = new CountDownLatch(1);
    //超时时间ms，监听器
    zooKeeper = new ZooKeeper(connectStr, 5000, new Watcher() {
      public void process(WatchedEvent watchedEvent) {
        //如果状态变成已连接
        if (watchedEvent.getState().equals(Event.KeeperState.SyncConnected)) {
          System.out.println("连接成功");
          //次数-1
          countDownLatch.countDown();
        }
      }
    });
    //等待，次数为0时才会继续往下执行。等待监听器监听到连接成功，才能操作zk
    countDownLatch.await();
  } catch (IOException | InterruptedException e) {
    e.printStackTrace();
  }
  //...操作zk。后面的demo都是写在此处的
  //关闭连接
  try {
    zooKeeper.close();
  } catch (InterruptedException e) {
    e.printStackTrace();
  }

检测节点是否存在


// 检测节点是否存在
  // 同步方式
  Stat exists = null;
  try {
    //如果存在，返回节点状态Stat；如果不存在，返回null。第二个参数是watch
    exists = zooKeeper.exists("/mall",false);
  } catch (KeeperException | InterruptedException e) {
    e.printStackTrace();
  }
  if (exists==null){
    System.out.println("节点不存在");
  }
  else {
    System.out.println("节点存在");
  }
  //异步回调
  zooKeeper.exists("/mall",false, new AsyncCallback.StatCallback() {
    //第二个是path znode路径，第三个是ctx 后面传入实参，第四个是znode的状态
    public void processResult(int i, String s, Object o, Stat stat) {
      //如果节点不存在，返回的stat是null
      if (stat==null){
        System.out.println("节点不存在");
      }
      else{
        System.out.println("节点存在");
      }
    }
  // 传入ctx，Object类型
  },null);

操作后，服务端会返回处理结果，返回void、null也算处理结果。

同步指的是当前线程阻塞，等待服务端返回数据，收到返回的数据才继续往下执行；

异步回调指的是，把对结果（返回的数据）的处理写在回调函数中，当前线程不等待返回的数据，继续往下执行，收到返回的数据时自动调用回调函数来处理。

如果处理返回数据的代码之后的操作，不依赖返回数据、对返回数据的处理，那么可以把返回数据的处理写成回调函数。

创建节点


//创建节点
  //同步方式
  try {
    //数据要写成byte[]，不携带数据写成null；默认acl权限使用ZooDefs.Ids.OPEN_ACL_UNSAFE；最后一个是节点类型，P是永久，E是临时，S是有序
    zooKeeper.create("/mall", "abcd".getBytes(), ZooDefs.Ids.OPEN_ACL_UNSAFE, CreateMode.PERSISTENT);
    System.out.println("已创建节点/mall");
    //如果节点已存在，会抛出异常
  } catch (KeeperException | InterruptedException e) {　　　　 System.out.println("创建节点/mall失败，请检查节点是否已存在");
    e.printStackTrace();
  }
  //异步回调
  zooKeeper.create("/mall", "abcd".getBytes(), ZooDefs.Ids.OPEN_ACL_UNSAFE, CreateMode.PERSISTENT, new AsyncCallback.Create2Callback(){
    //第二个path，第三个ctx，第四个节点状态
    public void processResult(int i, String s, Object o, String s1, Stat stat) {
      //回调方式不抛出异常，返回的stat是创建节点的状态，如果节点已存在，返回的stat是null
      if (stat==null){
        System.out.println("创建节点/mall失败，请检查节点是否已存在");
      }
      else {
        System.out.println("节点创建成功");
      }
    }
    //ctx实参
  },null);

删除节点


//删除节点
  //同步方式
  try {
    //第二个参数是版本号，-1表示可以是任何版本
    zooKeeper.delete("/mall1",-1);
    System.out.println("成功删除节点/mall");
  } catch (InterruptedException | KeeperException e) {
    System.out.println("删除节点/mall失败");
    e.printStackTrace();
  }
  //异步回调
  zooKeeper.delete("/mall2", -1, new AsyncCallback.VoidCallback() {
    //第二个是path，第三个是ctx
    public void processResult(int i, String s, Object o) {
    }
  //
  //ctx实参
  },null);

delete()只能删除没有子节点的znode，如果该znode有子节点会抛出异常。

没有提供递归删除子节点的方法，如果要删除带有子节点的znode，需要自己实现递归删除。可以先getChildren()获取子节点列表，遍历列表依次删除子节点，再删除父节点。

获取子节点列表


//获取子节点列表，List<String>，比如/mall/user,/mall/order，返回的是["user"、"order"]
  //同步方式
  List<String> children = null;
  try {
    //第二个参数是watch
    children = zooKeeper.getChildren("/mall", false);
  } catch (KeeperException | InterruptedException e) {
    e.printStackTrace();
  }
  System.out.println("子节点列表：" + children);
  //异步
  zooKeeper.getChildren("/mall", false, new AsyncCallback.ChildrenCallback() {
    //第二个起依次是：path、ctx、返回的子节点列表
    public void processResult(int i, String s, Object o, List<String> list) {
      System.out.println("子节点列表：" + list);
    }
  //ctx实参
  }, null);

只获取子节点，不获取孙节点。

watch都是：可以写boolean，要添加监听就写true，不监听写false；也可以写Watcher对象，new一个Watcher对象表示要监听，null表示不监听。

获取节点数据


//获取节点数据，返回byte[]
  //同步方式
  byte[] data = null;
  try {
    //第二个参数是watch，第三个是stat
    data = zooKeeper.getData("/mall", false, null);
  } catch (KeeperException | InterruptedException e) {
    e.printStackTrace();
  }
  //调用new String()时要判断data是否为null，如果是null会抛NPE
  if (data==null){
    System.out.println("该节点没有数据");
  }
  else{
    System.out.println("节点数据："+new String(data));
  }
  //异步回调
  zooKeeper.getData("/mall", false, new AsyncCallback.DataCallback() {
    //第二个起依次是：path、ctx、返回的节点数据、节点状态
    public void processResult(int i, String s, Object o, byte[] bytes, Stat stat) {
      //不必判断bytes是否是null，如果节点没有数据，不会调用回调函数；执行到此，说明bytes不是null
      System.out.println("节点数据：" + new String(bytes) );
    }
    //ctx实参
  }, null);

设置|修改节点数据


//设置|更新节点据
  //同步方式
  try {
    //最后一个参数是版本号
    zooKeeper.setData("/mall", "1234".getBytes(), -1);
    System.out.println("设置节点数据成功");
  } catch (KeeperException | InterruptedException e) {
    System.out.println("设置节点数据失败");
    e.printStackTrace();
  }
  //异步回调
  zooKeeper.setData("/mall", "1234".getBytes(), -1, new AsyncCallback.StatCallback() {
    //第二个是path，第三个是ctx
    public void processResult(int i, String s, Object o, Stat stat) {
    }
  // ctx
  },null);

设置acl权限


//设置acl权限
  //第一个参数指定权限,第二个是Id对象
  ACL acl = new ACL(ZooDefs.Perms.ALL, new Id("auth", "chy:abcd"));
  List<ACL> aclList = new ArrayList<>();
  aclList.add(acl);
  //如果List中只有一个ACL对象，也可以这样写
  //List<ACL> aclList = Collections.singletonList(auth);
  //验证权限，需写在设置权限之前。如果之前没有设置权限，也需要先验证本次即将设置的用户
  zooKeeper.addAuthInfo("digest","chy:abcd".getBytes());
  //方式一 setAcl
  try {
    //第二个参数是List<ACL>，第三个参数是版本号
    zooKeeper.setACL("/mall", aclList, -1);
    System.out.println("设置权限成功");
  } catch (KeeperException | InterruptedException e) {
    System.out.println("设置权限失败");
    e.printStackTrace();
  }
  //方式二 在创建节点时设置权限
  try {
    zooKeeper.create("/mall","abcd".getBytes(),aclList,CreateMode.PERSISTENT);
    System.out.println("已创建节点并设置权限");
  } catch (KeeperException | InterruptedException e) {
    e.printStackTrace();
  }

设置权限之后，连接zkServer进行操作时，都需要先验证用户。

此处未写对应的异步回调。

查看acl权限


//查看acl权限
  //设置权限之后，以后操作时需要先验证用户，一次session中验证一次即可
  zooKeeper.addAuthInfo("digest","chy:abcd".getBytes());
  //同步方式
  try {
    List<ACL> aclList = zooKeeper.getACL("/mall", null);
    System.out.println("acl权限："+aclList);
  } catch (KeeperException | InterruptedException e) {
    System.out.println("获取acl权限失败");
    e.printStackTrace();
  }
  //异步回调
  zooKeeper.getACL("/mall3", null, new AsyncCallback.ACLCallback() {
    //第二个起：path、ctx、获取到的List<ACL>、节点状态
    public void processResult(int i, String s, Object o, List<ACL> list, Stat stat) {
      //就算没有手动设置acl权限，默认也是有值的
      System.out.println("acl权限："+list);
    }
  //ctx实参
  },null);

添加监听器


//添加监听 方式一
  try {
    CountDownLatch countDownLatch = new CountDownLatch(1);
    zooKeeper.getData("/mall", new Watcher() {
      public void process(WatchedEvent watchedEvent) {
        //watcher会监听该节点所有的事件，不管发生什么事件都会调用process()来处理，需要先判断一下事件类型
        if (watchedEvent.getType().equals(Event.EventType.NodeDataChanged)){
          System.out.println("节点数据改变了");
          //会一直监听，如果只监听一次数据改变，将下面这句代码取消注释即可
          //countDownLatch.countDown();
        }
      }
    }, null);
    //默认watcher是一次性的，如果要一直监听，需要借助CountDownLatch
    countDownLatch.await();
  } catch (KeeperException | InterruptedException e) {
    e.printStackTrace();
  }

ZooKeeper类的exists()、getData()、getChildren()方法都具有添加监听的功能，用法类似。

watchedEvent.getType().equals(Event.EventType.NodeDataChanged)
watchedEvent.getState().equals(Event.KeeperState.SyncConnected)

getType是获取事件类型，getState是获取连接状态。

上面这种方式，会递归监听子孙节点，子孙节点的数据改变也算NodeDataChanged，子孙节点的创建|删除也算NodeCreated|NodeDeleted。


//添加监听 方式二  
 　　try {
    CountDownLatch countDownLatch1 = new CountDownLatch(1);
    zooKeeper.addWatch("/mall", new Watcher() {
      @Override
      public void process(WatchedEvent watchedEvent) {
        if (watchedEvent.getType().equals(Event.EventType.NodeDataChanged)){
          System.out.println("节点数据改变了");
          //如果只监听一次数据改变，将下面这句代码注释掉
          //countDownLatch1.countDown();
        }
      }
    //监听模式，PERSISTENT是不监听子孙节点，PERSISTENT_RECURSIVE是递归监听子孙节点
    }, AddWatchMode.PERSISTENT_RECURSIVE);
    countDownLatch1.await();
  } catch (KeeperException | InterruptedException e) {
    e.printStackTrace();
  }

countDownLatch1.await();要阻塞线程，最好启动一条新线程来监听。

只有设置了监听的zkCli，该节点发生事件时才会收到zkServer的通知。

watch只保存在zkServer的内存中（zk依赖jdk，运行在jvm上，堆中的session对象），不持久化到硬盘，就是说设置的监听只在本次会话期间有效，zkCli关闭连接，zkServer在指定时间后（默认连续没有收到10个心跳），zkServer会自动删除相关session，watcher丢失。

移除监听


//移除监听 方式一
  try {
    zooKeeper.addWatch("/mall",null,AddWatchMode.PERSISTENT);
    System.out.println("已移除监听");
  } catch (KeeperException | InterruptedException e) {
    e.printStackTrace();
  }

就是上面添加监听的哪些方法，watch|watcher参数，如果是boolean类型，设置为false即可关闭监听；如果是Watcher类型，可以设置null覆盖掉之前设置的监听。

//移除监听方式二

try {

//第二个参数是Watcher，原来添加的那个Watcher监听对象，不能是null

//第三个参数指定要移除监听的哪部分，Any是移除整个监听，Data是移除对数据的监听，Children是移除对子节点的递归监听

//最后一个参数指定未连接到zkServe时，是否移除本地监听部分

zooKeeper.removeWatches("/mall",watcher, Watcher.WatcherType.Children,true);

} catch (InterruptedException | KeeperException e) {

e.printStackTrace();

}

监听由2部分组成，一部分在zkServer上，事件发生时通知对应的zkCli；一部分在zkCli，收到zkServer的通知时做出一些处理。

最后一个参数指定未连接到zkServer，是否移除本地（zkCli）监听部分，true——移除，false——不移除。