ZooKeeper之Java客户端API使用—创建节点。

灰太狼 2024-02-18 17:00 59阅读 0赞

客户端可以通过ZooKeeper的API来创建一个数据节点，有如下两个接口：

*  **String create(final String path, byte data\[\], List<ACL> acl, CreateMode createMode)**
 *  **void create(final String path, byte data\[\], List<ACL> acl, CreateMode createMode, StringCallback cb, Object ctx)**

这两个接口分别以同步和异步方式创建节点，API方法的参数说明如下表所示。

> <table> 
>  <tbody> 
>   <tr> 
>    <th>参数名</th> 
>    <th>说明</th> 
>   </tr> 
>  </tbody> 
>  <tbody> 
>   <tr> 
>    <td>path</td> 
>    <td>需要创建的数据节点的节点路径，例如，/zk-book/foo</td> 
>   </tr> 
>   <tr> 
>    <td>data[]</td> 
>    <td>一个字节数组，是节点创建后的初始内容</td> 
>   </tr> 
>   <tr> 
>    <td>acl</td> 
>    <td>节点的ACL策略</td> 
>   </tr> 
>   <tr> 
>    <td>createMode</td> 
>    <td>节点类型，是一个枚举类型，通常有4种可选的节点类型<br> 
>     <ul> 
>      <li>持久（PERSISTENT）</li> 
>      <li>持久顺序（PERSISTENT_SEQUENTIAL）</li> 
>      <li>临时（EPHEMERAL）</li> 
>      <li>临时顺序（EPHEMERAL_SEQUENTIAL）<br> </li> 
>     </ul> </td> 
>   </tr> 
>   <tr> 
>    <td>cb</td> 
>    <td>注册一个异步回调函数。开发人员需要实现StringCallback接口，主要是对下面这个方法的重写：<br> void processResult(int rc, String path, Object ctx, String name);<br> 当服务端节点创建完毕后，ZooKeeper客户端就会自动调用这个方法，这样就可以处理相关的业务逻辑了</td> 
>   </tr> 
>   <tr> 
>    <td>ctx</td> 
>    <td>用于传递一个对象，可以在回调方法执行的时候使用，通常是放一个上下文（Context）信息</td> 
>   </tr> 
>  </tbody> 
> </table>

需要注意几点，无论是同步还是异步接口，ZooKeeper都不支持递归创建，即无法在父节点不存在的情况下创建一个子节点。另外，如果一个节点已经存在了，那么创建同名节点的时候，会抛出NodeExistsException异常。

目前，ZooKeeper的节点内容只支持字节数组（byte\[\]）类型，也就是说，ZooKeeper不负责为节点内容进行序列化，开发人员需要自己使用序列化工具将节点内容进行序列化和反序列化。对于字符串，可以简单地使用“string”.getBytes()生成一个字节数组；对于其他复杂对象，可以使用Hessian或是Kryo等专门的序列化工具来进行序列化。

关于权限控制，如果你的应用场景没有太高的权限要求，那么可以不关注这个参数，只需要在acl参数中传入参数Ids.OPEN\_ACL\_UNSAFE，这就表明之后对这个节点的任何操作都不受权限控制。

## 使用同步API创建一个节点 ##

// ZooKeeper API创建节点，使用同步(sync)接口

public class ZooKeeper\_Create\_API\_Sync\_Usage implements Watcher \{

> private static CountDownLatch connectedSemaphore = new CountDownLatch(1);
> 
> public static void main(String\[\] args) throws Exception \{
> 
> > ZooKeeper zookeeper = new ZooKeeper("domain1.book.zookeeper:2181" , 5000 ,new ZooKeeper\_Create\_API\_Sync\_Usage());  
> > 
> > 
> > connectedSemaphore.await();
> > 
> > String path1 = zookeeper.create("/zk-test-ephemeral-", "".getBytes(), Ids.OPEN\_ACL\_UNSAFE, CreateMode.EPHEMERAL);
> > 
> > System.out.println("Success create znode: " + path1);
> > 
> > String path2 = zookeeper.create("/zk-test-ephemeral-", "".getBytes(), Ids.OPEN\_ACL\_UNSAFE, CreateMode.EPHEMERAL\_SEQUENTIAL);
> > 
> > System.out.println("Success create znode: " + path2);
> 
> \}  
> 
> 
> public void process(WatchedEvent event) \{
> 
> > if (KeeperState.SyncConnected == event.getState()) \{
> > 
> > > connectedSemaphore.countDown();  
> > > 
> > 
> > \}  
> > 
> 
> \}  
>

运行程序，输出结果如下：

> ![20171201165132699][]

在上面这个程序片段中，使用了同步的节点创建接口：String create(final String path, byte data\[\], List<ACL> acl, CreateMode createMode)。在接口使用中，我们分别创建了两种类型的节点：临时节点和临时顺序节点。从返回的结果可以看出，如果创建了临时节点，那么API的返回值就是当时传入的path参数；如果创建了临时顺序节点，那么ZooKeeper会自动在节点后缀加上一个数字，并且在API接口的返回值中返回该数据节点的一个完整的节点路径。

## 使用异步API创建一个节点 ##

// ZooKeeper API 创建节点，使用异步（async）接口

public class ZooKeeper\_Create\_API\_Sync\_Usage implements Watcher \{

> private static CountDownLatch connectedSemaphore = new CountDownLatch(1);

> public static void main(String\[\] args) throws Exception \{

> > ZooKeeper zookeeper = new ZooKeeper("domain1.book.zookeeper:2181" , 5000 ,new ZooKeeper\_Create\_API\_ASync\_Usage());  
> >

> > connectedSemaphore.await();
> > 
> > zookeeper.create("/zk-test-ephemeral-", "".getBytes(), Ids.OPEN\_ACL\_UNSAFE, CreateMode.EPHEMERAL, new IStringCallback(), "I am context.");
> > 
> > zookeeper.create("/zk-test-ephemeral-", "".getBytes(), Ids.OPEN\_ACL\_UNSAFE, CreateMode.EPHEMERAL, new IStringCallback(), "I am context.");
> > 
> > zookeeper.create("/zk-test-ephemeral-", "".getBytes(), Ids.OPEN\_ACL\_UNSAFE, CreateMode.EPHEMERAL\_SEQUENTIAL, new IStringCallback(), "I am context.");
> > 
> > Thread.sleep(Integer.MAX\_VALUE);  
> >

> \}
> 
> public void process(WatchedEvent event) \{
> 
> > if (KeeperState.SyncConnected == event.getState()) \{
> > 
> > > connectedSemaphore.countDown();  
> > > 
> > 
> > \}  
> > 
> 
> \}  
>

class IStringCallback implements AsyncCallback.StringCallback \{

> public void processResult(int rc, String path, Object ctx, String name) \{
> 
> > System.out.println("Create path result: \[" + rc + ", " + path + ", " + ctx + ", real path name: " + name);  
> > 
> 
> \}  
>

运行程序，输出结果如下：

> ![20171201170301223][]

从这个程序片段中可以看出，使用异步方式创建接口也很简单。用户仅仅需要实现AsyncCallback.StringCallback()接口即可。AsyncCallback包含了StatCallback、DataCallback、ACLCallback、ChildrenCallback、Children2Callback、StringCallback和VoidCallback七种不同的回调接口，用户可以在不同的异步接口中实现不同的接口。

**和同步接口方法最大的区别在于，节点的创建过程（包括网络通信和服务端的节点创建过程）是异步的。并且，在同步接口调用过程中，我们需要关注接口抛出异常的可能；但是在异步接口中，接口本身是不会抛出异常的，所有的异常都会在回调函数中通过Result Code（响应码）来体现。**

下面来重点看下回调方法：void processResult(int rc, String path, Object ctx, String name)。这个方法的几个参数主要如下表所示。

> <table> 
>  <tbody> 
>   <tr> 
>    <th>参数名</th> 
>    <th>说明</th> 
>   </tr> 
>  </tbody> 
>  <tbody> 
>   <tr> 
>    <td>rc</td> 
>    <td>Result Code，服务端响应码。客户端可以从这个响应码中识别出API调用的结果，常见的响应码如下。<br> 
>     <ul> 
>      <li>0（Ok）：接口调用成功。</li> 
>      <li>-4（ConnectionLoss）：客户端和服务端连接已断开。</li> 
>      <li>-110（NodeExists）：指定节点已存在。</li> 
>      <li>-112（SessionExpired）：会话已过期。<br> </li> 
>     </ul> </td> 
>   </tr> 
>   <tr> 
>    <td>path</td> 
>    <td>接口调用时传入API的数据节点的节点路径参数值。</td> 
>   </tr> 
>   <tr> 
>    <td>ctx</td> 
>    <td>接口调用时传入API的ctx参数值。</td> 
>   </tr> 
>   <tr> 
>    <td>name</td> 
>    <td>实际在服务端创建的节点名。在上面代码中，第三次创建节点时，由于创建的节点类型是顺序节点，因此在服务端没有真正创建好顺序节点之前，客户端无法知道节点的完整节点路径。于是，在回调方法中，服务端会返回这个数据节点的完整节点路径。</td> 
>   </tr> 
>  </tbody> 
> </table>
> 
>   
>

[20171201165132699]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/f8a665e83dc1471bb2f4d5e87f261580.png
[20171201170301223]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/f345ec4d43fe478182a35161b40e3e81.png