ZooKeeper的使用

我会带着你远行 2022-06-18 02:45 137阅读 0赞

Zookeeper 作为一个分布式的服务框架，主要用来解决分布式集群中应用系统的一致性问题，它能提供基于类似于文件系统的目录节点树方式的数据存储，但是 Zookeeper 并不是用来专门存储数据的，它的作用主要是用来维护和监控你存储的数据的状态变化。通过监控这些数据状态的变化，从而可以达到基于数据的集群管理，后面将会详细介绍 Zookeeper 能够解决的一些典型问题，这里先介绍一下，Zookeeper 的操作接口和简单使用示例。

常用接口列表

客户端要连接 Zookeeper 服务器可以通过创建 org.apache.zookeeper. ZooKeeper 的一个实例对象，然后调用这个类提供的接口来和服务器交互。

前面说了 ZooKeeper 主要是用来维护和监控一个目录节点树中存储的数据的状态，所有我们能够操作 ZooKeeper 的也和操作目录节点树大体一样，如创建一个目录节点，给某个目录节点设置数据，获取某个目录节点的所有子目录节点，给某个目录节点设置权限和监控这个目录节点的状态变化。

这些接口如下表所示：

**表 1 org.apache.zookeeper. ZooKeeper 方法列表**

<table> 
 <tbody> 
  <tr> 
   <th style="vertical-align:top"><span style="font-size:16px"><strong>方法名</strong></span></th> 
   <th style="vertical-align:top"><span style="font-size:16px"><strong>方法功能描述</strong></span></th> 
  </tr> 
  <tr> 
   <td style="text-align:center; vertical-align:top"><span style="font-size:16px"><a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" rel="nofollow">String</a><a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/ZooKeeper.html#create%28java.lang.String,%20byte[],%20java.util.List,%20org.apache.zookeeper.CreateMode%29" rel="nofollow">create</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" rel="nofollow">String</a>&nbsp;path, byte[]&nbsp;data, <a href="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" rel="nofollow"> List</a>&lt;<a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/data/ACL.html" rel="nofollow">ACL</a>&gt;&nbsp;acl,<a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/CreateMode.html" rel="nofollow">CreateMode</a>&nbsp;createMode)</span></td> 
   <td style="vertical-align:top"><span style="font-size:16px">创建一个给定的目录节点 path, 并给它设置数据，<a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/CreateMode.html" rel="nofollow">CreateMode</a>&nbsp;标识有四种形式的目录节点，分别是 PERSISTENT：持久化目录节点，这个目录节点存储的数据不会丢失；PERSISTENT_SEQUENTIAL：顺序自动编号的目录节点，这种目录节点会根据当前已近存在的节点数自动加 1，然后返回给客户端已经成功创建的目录节点名；EPHEMERAL：临时目录节点，一旦创建这个节点的客户端与服务器端口也就是 session 超时，这种节点会被自动删除；EPHEMERAL_SEQUENTIAL：临时自动编号节点</span></td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top"><span style="font-size:16px"><a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/data/Stat.html" rel="nofollow">Stat</a><a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/ZooKeeper.html#exists%28java.lang.String,%20boolean%29" rel="nofollow">exists</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" rel="nofollow">String</a>&nbsp;path, boolean&nbsp;watch) </span></td> 
   <td style="vertical-align:top"><span style="font-size:16px">判断某个 path 是否存在，并设置是否监控这个目录节点，这里的 watcher 是在创建 ZooKeeper 实例时指定的 watcher，<a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/ZooKeeper.html#exists%28java.lang.String,%20boolean%29" rel="nofollow">exists</a>方法还有一个重载方法，可以指定特定的<a rel="nofollow"></a><a rel="nofollow"></a>watcher</span></td> 
  </tr> 
  <tr> 
   <td style="text-align:center; vertical-align:top"><span style="font-size:16px"><a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/data/Stat.html" rel="nofollow">Stat</a><a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/ZooKeeper.html#exists%28java.lang.String,%20org.apache.zookeeper.Watcher%29" rel="nofollow">exists</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" rel="nofollow">String</a>&nbsp;path,<a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/Watcher.html" rel="nofollow">Watcher</a>&nbsp;watcher)</span></td> 
   <td style="vertical-align:top"><span style="font-size:16px">重载方法，这里给某个目录节点设置特定的 watcher，Watcher 在 ZooKeeper 是一个核心功能，Watcher 可以监控目录节点的数据变化以及子目录的变化，一旦这些状态发生变化，服务器就会通知所有设置在这个目录节点上的 Watcher，从而每个客户端都很快知道它所关注的目录节点的状态发生变化，而做出相应的反应</span></td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top"><span style="font-size:16px">void <a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/ZooKeeper.html#delete%28java.lang.String,%20int%29" rel="nofollow"> delete</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" rel="nofollow">String</a>&nbsp;path, int&nbsp;version)</span></td> 
   <td style="vertical-align:top"><span style="font-size:16px">删除 path 对应的目录节点，version 为 -1 可以匹配任何版本，也就删除了这个目录节点所有数据</span></td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top"><span style="font-size:16px"><a href="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" rel="nofollow">List</a>&lt;<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" rel="nofollow">String</a>&gt;<a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/ZooKeeper.html#getChildren%28java.lang.String,%20boolean%29" rel="nofollow">getChildren</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" rel="nofollow">String</a>&nbsp;path, boolean&nbsp;watch)</span></td> 
   <td style="vertical-align:top"><span style="font-size:16px">获取指定 path 下的所有子目录节点，同样<a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/ZooKeeper.html#getChildren%28java.lang.String,%20boolean%29" rel="nofollow">getChildren</a>方法也有一个重载方法可以设置特定的 watcher 监控子节点的状态</span></td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top"><span style="font-size:16px"><a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/data/Stat.html" rel="nofollow">Stat</a><a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/ZooKeeper.html#setData%28java.lang.String,%20byte[],%20int%29" rel="nofollow">setData</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" rel="nofollow">String</a>&nbsp;path, byte[]&nbsp;data, int&nbsp;version) </span></td> 
   <td style="vertical-align:top"><span style="font-size:16px">给 path 设置数据，可以指定这个数据的版本号，如果 version 为 -1 怎可以匹配任何版本</span></td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top"><span style="font-size:16px">byte[] <a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/ZooKeeper.html#getData%28java.lang.String,%20boolean,%20org.apache.zookeeper.data.Stat%29" rel="nofollow"> getData</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" rel="nofollow">String</a>&nbsp;path, boolean&nbsp;watch,<a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/data/Stat.html" rel="nofollow">Stat</a>&nbsp;stat)</span></td> 
   <td style="vertical-align:top"><span style="font-size:16px">获取这个 path 对应的目录节点存储的数据，数据的版本等信息可以通过 stat 来指定，同时还可以设置是否监控这个目录节点数据的状态</span></td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top"><span style="font-size:16px">void <a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/ZooKeeper.html#addAuthInfo%28java.lang.String,%20byte[]%29" rel="nofollow"> addAuthInfo</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" rel="nofollow">String</a>&nbsp;scheme, byte[]&nbsp;auth)</span></td> 
   <td style="vertical-align:top"><span style="font-size:16px">客户端将自己的授权信息提交给服务器，服务器将根据这个授权信息验证客户端的访问权限。</span></td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top"><span style="font-size:16px"><a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/data/Stat.html" rel="nofollow">Stat</a><a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/ZooKeeper.html#setACL%28java.lang.String,%20java.util.List,%20int%29" rel="nofollow">setACL</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" rel="nofollow">String</a>&nbsp;path,<a href="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" rel="nofollow">List</a>&lt;<a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/data/ACL.html" rel="nofollow">ACL</a>&gt;&nbsp;acl, int&nbsp;version)</span></td> 
   <td style="vertical-align:top"><span style="font-size:16px">给某个目录节点重新设置访问权限，需要注意的是 Zookeeper 中的目录节点权限不具有传递性，父目录节点的权限不能传递给子目录节点。目录节点 ACL 由两部分组成：perms 和 id。<br> Perms 有 ALL、READ、WRITE、CREATE、DELETE、ADMIN 几种 <br> 而 id 标识了访问目录节点的身份列表，默认情况下有以下两种：<br> ANYONE_ID_UNSAFE = new Id("world", "anyone") 和 AUTH_IDS = new Id("auth", "") 分别表示任何人都可以访问和创建者拥有访问权限。</span></td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top"><span style="font-size:16px"><a href="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" rel="nofollow">List</a>&lt;<a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/data/ACL.html" rel="nofollow">ACL</a>&gt;<a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/ZooKeeper.html#getACL%28java.lang.String,%20org.apache.zookeeper.data.Stat%29" rel="nofollow">getACL</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" rel="nofollow">String</a>&nbsp;path,<a href="http://hadoop.apache.org/zookeeper/docs/r3.2.2/api/org/apache/zookeeper/data/Stat.html" rel="nofollow">Stat</a>&nbsp;stat)</span></td> 
   <td style="vertical-align:top"><span style="font-size:16px">获取某个目录节点的访问权限列表</span></td> 
  </tr> 
 </tbody> 
</table>

除了以上这些上表中列出的方法之外还有一些重载方法，如都提供了一个回调类的重载方法以及可以设置特定 Watcher 的重载方法，具体的方法可以参考 org.apache.zookeeper. ZooKeeper 类的 API 说明。

基本操作

下面给出基本的操作 ZooKeeper 的示例代码，这样你就能对 ZooKeeper 有直观的认识了。下面的清单包括了创建与 ZooKeeper 服务器的连接以及最基本的数据操作：

**清单 2. ZooKeeper 基本的操作示例**

<table> 
 <tbody> 
  <tr> 
   <td> <pre><span style="font-size:16px">				
 // 创建一个与服务器的连接
ZooKeeper zk = new ZooKeeper("localhost:" + CLIENT_PORT, 
        ClientBase.CONNECTION_TIMEOUT, new Watcher() { 
            // 监控所有被触发的事件
            public void process(WatchedEvent event) { 
                System.out.println("已经触发了" + event.getType() + "事件！"); 
            } 
        }); 
 // 创建一个目录节点

zk.create("/testRootPath", "testRootData".getBytes(), Ids.OPEN_ACL_UNSAFE,
   CreateMode.PERSISTENT); 
 // 创建一个子目录节点

zk.create("/testRootPath/testChildPathOne", "testChildDataOne".getBytes(),
   Ids.OPEN_ACL_UNSAFE,CreateMode.PERSISTENT);

System.out.println(new String(zk.getData("/testRootPath",false,null))); 
 // 取出子目录节点列表

System.out.println(zk.getChildren("/testRootPath",true)); 
 // 修改子目录节点数据
 zk.setData("/testRootPath/testChildPathOne","modifyChildDataOne".getBytes(),-1); 
 System.out.println("目录节点状态：["+zk.exists("/testRootPath",true)+"]"); 
 // 创建另外一个子目录节点
 zk.create("/testRootPath/testChildPathTwo", "testChildDataTwo".getBytes(), 
   Ids.OPEN_ACL_UNSAFE,CreateMode.PERSISTENT); 
 System.out.println(new String(zk.getData("/testRootPath/testChildPathTwo",true,null))); 
 // 删除子目录节点
 zk.delete("/testRootPath/testChildPathTwo",-1); 
 zk.delete("/testRootPath/testChildPathOne",-1); 
 // 删除父目录节点
 zk.delete("/testRootPath",-1); 
 // 关闭连接
 zk.close(); 
</span></pre> </td> 
  </tr> 
 </tbody> 
</table>

输出的结果如下：

<table> 
 <tbody> 
  <tr> 
   <td> <pre><span style="font-size:16px">已经触发了 None 事件！
 testRootData 
 [testChildPathOne] 
目录节点状态：[5,5,1281804532336,1281804532336,0,1,0,0,12,1,6] 
已经触发了 NodeChildrenChanged 事件！
 testChildDataTwo 
已经触发了 NodeDeleted 事件！
已经触发了 NodeDeleted 事件！
</span></pre> </td> 
  </tr> 
 </tbody> 
</table>

当对目录节点监控状态打开时，一旦目录节点的状态发生变化，Watcher 对象的 process 方法就会被调用。