Zookeeper API

ZooKeeper有一个用于Java和C的官方API绑定.Zookeeper社区为大多数语言(.NET，python等)提供非官方API。 使用ZooKeeper API，应用程序可以连接，交互，操作数据，协调，最后断开与ZooKeeper集合。

ZooKeeper API具有丰富的功能，以一种简单和安全的方式获得ZooKeeper集合的所有功能。 ZooKeeper API提供同步和异步方法。

ZooKeeper合奏和ZooKeeper API在每个方面完全互补，它以一种伟大的方式对开发人员有利。 让我们在本章讨论Java绑定。

ZooKeeper API的基础知识

与ZooKeeper集合的应用程序交互称为 ZooKeeper客户端或简称客户端。

Znode是ZooKeeper集合的核心组件，ZooKeeper API提供了一组小集合来使用ZooKeeper集合来操纵znode的所有细节。

客户端应该遵循以下给出的步骤来与ZooKeeper集合进行清晰和干净的交互。

• 连接到ZooKeeper合奏。 ZooKeeper集合为客户端分配会话ID。

• 定期向服务器发送心跳。 否则，ZooKeeper集合将过期会话ID，客户端需要重新连接。

• 只要会话ID处于活动状态，就可以获取/设置znode。

• 所有任务完成后，断开与ZooKeeper集成的连接。 如果客户端长时间不活动，则ZooKeeper集合将自动断开客户端。

Java绑定

让我们来了解本章中最重要的一组ZooKeeper API。 ZooKeeper API的中心部分是 ZooKeeper类。 它提供了在其构造函数中连接ZooKeeper集合的选项，并具有以下方法 -

• connect - 连接到ZooKeeper集合

• create- 创建znode

• exists- 检查znode是否存在及其信息

• getData - 从特定znode获取数据

• setData - 在特定znode中设置数据

• getChildren - 获取特定znode中的所有子节点

• delete - 获取特定的znode及其所有子项

• close - 关闭连接

连接到ZooKeeper合奏

ZooKeeper类通过其构造函数提供连接功能。 构造函数的签名如下 :

ZooKeeper(String connectionString, int sessionTimeout, Watcher watcher)

• connectionString - ZooKeeper集成主机。

• sessionTimeout - 会话超时(以毫秒为单位)。

• watcher - 实现“观察者"界面的对象。 ZooKeeper集合通过观察者对象返回连接状态。

让我们创建一个新的帮助类 ZooKeeperConnection ，并添加一个方法 connect 。 connect 方法创建一个ZooKeeper对象，连接到ZooKeeper集合，然后返回对象。

这里 CountDownLatch 用于停止(等待)主进程，直到客户端与ZooKeeper集合连接。

这里 CountDownLatch 用于停止(等待)主进程，直到客户端与ZooKeeper集合连接。...

这里是与ZooKeeper集合连接的完整代码。

编码:ZooKeeperConnection.java

// import java classesimport java.io.IOException;import java.util.concurrent.CountDownLatch;// import zookeeper classesimport org.apache.zookeeper.KeeperException;import org.apache.zookeeper.WatchedEvent;import org.apache.zookeeper.Watcher;import org.apache.zookeeper.Watcher.Event.KeeperState;import org.apache.zookeeper.ZooKeeper;import org.apache.zookeeper.AsyncCallback.StatCallback;import org.apache.zookeeper.KeeperException.Code;import org.apache.zookeeper.data.Stat;public class ZooKeeperConnection {   // declare zookeeper instance to access ZooKeeper ensemble   private ZooKeeper zoo;   final CountDownLatch connectedSignal = new CountDownLatch(1);   // Method to connect zookeeper ensemble.   public ZooKeeper connect(String host) throws IOException,InterruptedException {      zoo = new ZooKeeper(host,5000,new Watcher() {         public void process(WatchedEvent we) {            if (we.getState() == KeeperState.SyncConnected) {               connectedSignal.countDown();            }         }      });      connectedSignal.await();      return zoo;   }   // Method to disconnect from zookeeper server   public void close() throws InterruptedException {      zoo.close();   }}

保存上面的代码，它将在下一节中用于连接ZooKeeper集合。

创建Znode

ZooKeeper类提供创建方法在ZooKeeper集合中创建一个新的znode。 create 方法的签名如下 -

create(String path, byte[] data, List<ACL> acl, CreateMode createMode)

• 路径 - Znode路径。 例如，/ myapp1，/ myapp2，/ myapp1 / mydata1，myapp2 / mydata1 / myanothersubdata

• data - 要存储在指定znode路径中的数据

• acl - 要创建的节点的访问控制列表。 ZooKeeper API提供了一个静态接口 ZooDefs.Ids 来获取一些基本的acl列表。 例如，ZooDefs.Ids.OPEN_ACL_UNSAFE返回打开znode的acl列表。

• createMode - 节点的类型，短暂，顺序或两者。 这是一个枚举。

让我们创建一个新的Java应用程序来检查ZooKeeper API的 create 功能。 创建文件 ZKCreate.java 。 在main方法中，创建一个类型为 ZooKeeperConnection 的对象，并调用 connect 方法连接到ZooKeeper集合。

connect方法将返回ZooKeeper对象 zk 。 现在，请使用自定义路径和数据调用 zk 对象的 create 方法。

创建znode的完整程序代码如下 -

编码:ZKCreate.java

import java.io.IOException;import org.apache.zookeeper.WatchedEvent;import org.apache.zookeeper.Watcher;import org.apache.zookeeper.Watcher.Event.KeeperState;import org.apache.zookeeper.ZooKeeper;import org.apache.zookeeper.KeeperException;import org.apache.zookeeper.CreateMode;import org.apache.zookeeper.ZooDefs;public class ZKCreate {   // create static instance for zookeeper class.   private static ZooKeeper zk;   // create static instance for ZooKeeperConnection class.   private static ZooKeeperConnection conn;   // Method to create znode in zookeeper ensemble   public static void create(String path, byte[] data) throws       KeeperException,InterruptedException {      zk.create(path, data, ZooDefs.Ids.OPEN_ACL_UNSAFE,      CreateMode.PERSISTENT);   }   public static void main(String[] args) {      // znode path      String path = "/MyFirstZnode"; // Assign path to znode      // data in byte array      byte[] data = "My first zookeeper app".getBytes(); // Declare data      try {         conn = new ZooKeeperConnection();         zk = conn.connect("localhost");         create(path, data); // Create the data to the specified path         conn.close();      } catch (Exception e) {         System.out.println(e.getMessage()); //Catch error message      }   }}

一旦编译和执行应用程序，将在ZooKeeper集合中创建具有指定数据的znode。 您可以使用ZooKeeper CLIzkCli.sh 进行检查。

cd /path/to/zookeeperbin/zkCli.sh>>> get /MyFirstZnode

存在 - 检查Znode的存在

ZooKeeper类提供了 exists方法来检查znode的存在。 如果指定的znode存在，则返回znode的元数据。 存在方法的签名如下 -

exists(String path, boolean watcher)

• path- Znode路径

• watcher - 布尔值，用于指定是否观看指定的znode

让我们创建一个新的Java应用程序来检查ZooKeeper API的“exists"功能。 创建文件“ZKExists.java"。 在main方法中，使用“ZooKeeperConnection"对象创建ZooKeeper对象“zk" 然后，使用自定义“path"调用“zk"对象的“exists" 完整的列表如下 -

编码:ZKExists.java

import java.io.IOException;import org.apache.zookeeper.ZooKeeper;import org.apache.zookeeper.KeeperException;import org.apache.zookeeper.WatchedEvent;import org.apache.zookeeper.Watcher;import org.apache.zookeeper.Watcher.Event.KeeperState;import org.apache.zookeeper.data.Stat;public class ZKExists {   private static ZooKeeper zk;   private static ZooKeeperConnection conn;   // Method to check existence of znode and its status, if znode is available.   public static Stat znode_exists(String path) throws      KeeperException,InterruptedException {      return zk.exists(path, true);   }   public static void main(String[] args) throws InterruptedException,KeeperException {      String path = "/MyFirstZnode"; // Assign znode to the specified path      try {         conn = new ZooKeeperConnection();         zk = conn.connect("localhost");         Stat stat = znode_exists(path); // Stat checks the path of the znode         if(stat != null) {            System.out.println("Node exists and the node version is " +            stat.getVersion());         } else {            System.out.println("Node does not exists");         }      } catch(Exception e) {         System.out.println(e.getMessage()); // Catches error messages      }   }}

一旦编译和执行应用程序，您将获得以下输出。

Node exists and the node version is 1.

getData方法

ZooKeeper类提供 getData 方法来获取指定znode中附加的数据及其状态。 getData 方法的签名如下 -

getData(String path, Watcher watcher, Stat stat)

• path - Znode路径。

• watcher - 类型观察者的回调函数。 当指定的znode的数据改变时，ZooKeeper集合将通过Watcher回调通知。 这是一次性通知。

• stat - 返回znode的元数据。

让我们创建一个新的Java应用程序来了解ZooKeeper API的 getData 功能。 创建文件 ZKGetData.java 。在main方法中，使用他 ZooKeeperConnection 对象创建一个ZooKeeper对象 zk 。 然后，使用自定义路径调用zk对象的 getData 方法。

下面是从指定节点获取数据的完整程序代码 -

编码:ZKGetData.java

import java.io.IOException;import java.util.concurrent.CountDownLatch;import org.apache.zookeeper.ZooKeeper;import org.apache.zookeeper.KeeperException;import org.apache.zookeeper.WatchedEvent;import org.apache.zookeeper.Watcher;import org.apache.zookeeper.Watcher.Event.KeeperState;import org.apache.zookeeper.data.Stat;public class ZKGetData {   private static ZooKeeper zk;   private static ZooKeeperConnection conn;   public static Stat znode_exists(String path) throws       KeeperException,InterruptedException {      return zk.exists(path,true);   }   public static void main(String[] args) throws InterruptedException, KeeperException {      String path = "/MyFirstZnode";      final CountDownLatch connectedSignal = new CountDownLatch(1);      try {         conn = new ZooKeeperConnection();         zk = conn.connect("localhost");         Stat stat = znode_exists(path);         if(stat != null) {            byte[] b = zk.getData(path, new Watcher() {               public void process(WatchedEvent we) {                  if (we.getType() == Event.EventType.None) {                     switch(we.getState()) {                        case Expired:                        connectedSignal.countDown();                        break;                     }                  } else {                     String path = "/MyFirstZnode";                     try {                        byte[] bn = zk.getData(path,                        false, null);                        String data = new String(bn,                        "UTF-8");                        System.out.println(data);                        connectedSignal.countDown();                     } catch(Exception ex) {                        System.out.println(ex.getMessage());                     }                  }               }            }, null);            String data = new String(b, "UTF-8");            System.out.println(data);            connectedSignal.await();         } else {            System.out.println("Node does not exists");         }      } catch(Exception e) {        System.out.println(e.getMessage());      }   }}

一旦编译和执行应用程序，您将获得以下输出

My first zookeeper app

应用程序将等待ZooKeeper集合的进一步通知。 使用ZooKeeper CLI zkCli.sh 更改指定znode的数据。

cd /path/to/zookeeperbin/zkCli.sh>>> set /MyFirstZnode Hello

现在，应用程序将打印以下输出并退出。

Hello

setData方法

ZooKeeper类提供 setData 方法来修改指定znode中附加的数据。 setData 方法的签名如下 :

setData(String path, byte[] data, int version)

• path- Znode路径

• data - 要存储在指定znode路径中的数据。

• version- znode的当前版本。 每当数据更改时，ZooKeeper会更新znode的版本号。

现在让我们创建一个新的Java应用程序来了解ZooKeeper API的 setData 功能。 创建文件ZKSetData.java 。 在main方法中，使用 ZooKeeperConnection 对象创建一个ZooKeeper对象 zk 。然后，使用指定的路径，新数据和节点版本调用 zk 对象的 setData 方法。

这里是完整的程序代码来修改附加在指定znode中的数据。

代码:ZKSetData.java

import org.apache.zookeeper.ZooKeeper;import org.apache.zookeeper.KeeperException;import org.apache.zookeeper.WatchedEvent;import org.apache.zookeeper.Watcher;import org.apache.zookeeper.Watcher.Event.KeeperState;import java.io.IOException;public class ZKSetData {   private static ZooKeeper zk;   private static ZooKeeperConnection conn;   // Method to update the data in a znode. Similar to getData but without watcher.   public static void update(String path, byte[] data) throws      KeeperException,InterruptedException {      zk.setData(path, data, zk.exists(path,true).getVersion());   }   public static void main(String[] args) throws InterruptedException,KeeperException {      String path= "/MyFirstZnode";      byte[] data = "Success".getBytes(); //Assign data which is to be updated.      try {         conn = new ZooKeeperConnection();         zk = conn.connect("localhost");         update(path, data); // Update znode data to the specified path      } catch(Exception e) {         System.out.println(e.getMessage());      }   }}

一旦应用程序被编译和执行，指定的znode的数据将被改变，并且可以使用ZooKeeper CLI， zkCli.sh 进行检查。

cd /path/to/zookeeperbin/zkCli.sh>>> get /MyFirstZnode

getChildren方法

ZooKeeper类提供 getChildren 方法来获取特定znode的所有子节点。 getChildren 方法的签名如下 -

getChildren(String path, Watcher watcher)

• path - Znode路径。

• watcher - 类型为“Watcher"的回调函数。 当指定的znode被删除或znode下的子节点被创建/删除时，ZooKeeper集合将通知。 这是一次性通知。

编码:ZKGetChildren.java

import java.io.IOException;import java.util.*;import org.apache.zookeeper.ZooKeeper;import org.apache.zookeeper.KeeperException;import org.apache.zookeeper.WatchedEvent;import org.apache.zookeeper.Watcher;import org.apache.zookeeper.Watcher.Event.KeeperState;import org.apache.zookeeper.data.Stat;public class ZKGetChildren {   private static ZooKeeper zk;   private static ZooKeeperConnection conn;   // Method to check existence of znode and its status, if znode is available.   public static Stat znode_exists(String path) throws       KeeperException,InterruptedException {      return zk.exists(path,true);   }   public static void main(String[] args) throws InterruptedException,KeeperException {      String path = "/MyFirstZnode"; // Assign path to the znode      try {         conn = new ZooKeeperConnection();         zk = conn.connect("localhost");         Stat stat = znode_exists(path); // Stat checks the path         if(stat!= null) {            //“getChildren" method- get all the children of znode.It has two            args, path and watch            List <String> children = zk.getChildren(path, false);            for(int i = 0; i < children.size(); i++)            System.out.println(children.get(i)); //Print children's         } else {            System.out.println("Node does not exists");         }      } catch(Exception e) {         System.out.println(e.getMessage());      }   }}

在运行程序之前，让我们使用ZooKeeper CLI zkCli.sh 为 / MyFirstZnode 创建两个子节点。

cd /path/to/zookeeperbin/zkCli.sh>>> create /MyFirstZnode/myfirstsubnode Hi>>> create /MyFirstZnode/mysecondsubmode Hi

现在，编译和运行程序将输出上面创建的znode。

myfirstsubnodemysecondsubnode

删除Znode

ZooKeeper类提供了 delete 方法来删除指定的znode。 删除方法的签名如下 -

delete(String path, int version)

• path - Znode路径。

• version - znode的当前版本。

让我们创建一个新的Java应用程序来了解ZooKeeper API的 delete 功能。 创建文件 ZKDelete.java 。 在main方法中，使用 ZooKeeperConnection 对象创建一个ZooKeeper对象 zk 。 然后，使用指定的路径和版本号调用 zk 对象的 delete

删除znode的完整程序代码如下 

编码:ZKDelete.java

import org.apache.zookeeper.ZooKeeper;import org.apache.zookeeper.KeeperException;public class ZKDelete {   private static ZooKeeper zk;   private static ZooKeeperConnection conn;   // Method to check existence of znode and its status, if znode is available.   public static void delete(String path) throws KeeperException,InterruptedException {      zk.delete(path,zk.exists(path,true).getVersion());   }   public static void main(String[] args) throws InterruptedException,KeeperException {      String path = "/MyFirstZnode"; //Assign path to the znode      try {         conn = new ZooKeeperConnection();         zk = conn.connect("localhost");         delete(path); //delete the node with the specified path      } catch(Exception e) {         System.out.println(e.getMessage()); // catches error messages      }   }}