Curator 使用详解

Zookeeper 客户端 Curator 使用详解

简介

Curator 是 Netflix 公司开源的一套 zookeeper 客户端框架，解决了很多 Zookeeper 客户端非常底层的细节开发工作，包括连接重连、反复注册 Watcher 和 NodeExistsException 异常等等。Patrixck Hunt（Zookeeper）以一句“Guava is to Java that Curator to Zookeeper”给 Curator 予高度评价。

引子和趣闻：

Zookeeper 名字的由来是比较有趣的，下面的片段摘抄自《从 PAXOS 到 ZOOKEEPER 分布式一致性原理与实践》一

书：

Zookeeper 最早起源于雅虎的研究院的一个研究小组。在当时，研究人员发现，在雅虎内部很多大型的系统需要依赖一个类似的系统进行分布式协调，但是这些系统往往存在分布式单点问题。所以雅虎的开发人员就试图开发一个通用的无单点问题的分布式协调框架。在立项初期，考虑到很多项目都是用动物的名字来命名的(例如著名的 Pig 项目)，雅虎的工程师希望给这个项目也取一个动物的名字。时任研究院的首席科学家 Raghu Ramakrishnan 开玩笑说：再这样下去，我们这儿就变成动物园了。此话一出，大家纷纷表示就叫动物园管理员吧——因为各个以动物命名的分布式组件放在一起，雅虎的整个分布式系统看上去就像一个大型的动物园了，而 Zookeeper 正好用来进行分布式环境的协调——于是，Zookeeper 的名字由此诞生了。

Curator 无疑是 Zookeeper 客户端中的瑞士军刀，它译作"馆长"或者''管理者''，不知道是不是开发小组有意而为之，笔者猜测有可能这样命名的原因是说明 Curator 就是 Zookeeper 的馆长(脑洞有点大：Curator 就是动物园的园长)。

Curator 包含了几个包：

curator-framework： 对 zookeeper 的底层 api 的一些封装

curator-client： 提供一些客户端的操作，例如重试策略等

curator-recipes： 封装了一些高级特性，如：Cache 事件监听、选举、分布式锁、分布式计数器、分布式 Barrier 等

Maven 依赖(使用 curator 的版本：2.12.0，对应 Zookeeper 的版本为：3.4.x，如果跨版本会有兼容性问题，很有可能导致节点操作失败)：

        <dependency>
            <groupId>org.apache.curator</groupId>
            <artifactId>curator-framework</artifactId>
            <version>2.12.0</version>
        </dependency>

        <dependency>
            <groupId>org.apache.curator</groupId>
            <artifactId>curator-recipes</artifactId>
            <version>2.12.0</version>
        </dependency>

Curator 的基本 Api

创建会话

1.使用静态工程方法创建客户端

一个例子如下：

RetryPolicy retryPolicy = new ExponentialBackoffRetry(1000, 3);
CuratorFramework client =
CuratorFrameworkFactory.newClient(
                  connectionInfo,
                  5000,
                  3000,
                  retryPolicy);

newClient 静态工厂方法包含四个主要参数：

2.使用 Fluent 风格的 Api 创建会话

核心参数变为流式设置，一个列子如下：

        RetryPolicy retryPolicy = new ExponentialBackoffRetry(1000, 3);
      CuratorFramework client =
      CuratorFrameworkFactory.builder()
            .connectString(connectionInfo)
            .sessionTimeoutMs(5000)
            .connectionTimeoutMs(5000)
            .retryPolicy(retryPolicy)
            .build();

3.创建包含隔离命名空间的会话

为了实现不同的 Zookeeper 业务之间的隔离，需要为每个业务分配一个独立的命名空间（NameSpace），即指定一个 Zookeeper 的根路径（官方术语：为 Zookeeper 添加“Chroot”特性）。例如（下面的例子）当客户端指定了独立命名空间为“/base”，那么该客户端对 Zookeeper 上的数据节点的操作都是基于该目录进行的。通过设置 Chroot 可以将客户端应用与 Zookeeper 服务端的一课子树相对应，在多个应用共用一个 Zookeeper 集群的场景下，这对于实现不同应用之间的相互隔离十分有意义。

RetryPolicy retryPolicy = new ExponentialBackoffRetry(1000, 3);
      CuratorFramework client =
      CuratorFrameworkFactory.builder()
            .connectString(connectionInfo)
            .sessionTimeoutMs(5000)
            .connectionTimeoutMs(5000)
            .retryPolicy(retryPolicy)
            .namespace("base")
            .build();

启动客户端

当创建会话成功，得到 client 的实例然后可以直接调用其 start( )方法：

client.start();

数据节点操作

创建数据节点

Zookeeper 的节点创建模式：

• PERSISTENT：持久化
• PERSISTENT_SEQUENTIAL：持久化并且带序列号
• EPHEMERAL：临时
• EPHEMERAL_SEQUENTIAL：临时并且带序列号

**创建一个节点，初始内容为空 **

client.create().forPath("path");

注意：如果没有设置节点属性，节点创建模式默认为持久化节点，内容默认为空

创建一个节点，附带初始化内容

client.create().forPath("path","init".getBytes());

创建一个节点，指定创建模式（临时节点），内容为空

client.create().withMode(CreateMode.EPHEMERAL).forPath("path");

创建一个节点，指定创建模式（临时节点），附带初始化内容

client.create().withMode(CreateMode.EPHEMERAL).forPath("path","init".getBytes());

创建一个节点，指定创建模式（临时节点），附带初始化内容，并且自动递归创建父节点

client.create()
      .creatingParentContainersIfNeeded()
      .withMode(CreateMode.EPHEMERAL)
      .forPath("path","init".getBytes());

这个 creatingParentContainersIfNeeded()接口非常有用，因为一般情况开发人员在创建一个子节点必须判断它的父节点是否存在，如果不存在直接创建会抛出 NoNodeException，使用 creatingParentContainersIfNeeded()之后 Curator 能够自动递归创建所有所需的父节点。

删除数据节点

删除一个节点

client.delete().forPath("path");

注意，此方法只能删除叶子节点，否则会抛出异常。

删除一个节点，并且递归删除其所有的子节点

client.delete().deletingChildrenIfNeeded().forPath("path");

删除一个节点，强制指定版本进行删除

client.delete().withVersion(10086).forPath("path");

删除一个节点，强制保证删除

client.delete().guaranteed().forPath("path");

guaranteed()接口是一个保障措施，只要客户端会话有效，那么 Curator 会在后台持续进行删除操作，直到删除节点成功。

注意： 上面的多个流式接口是可以自由组合的，例如：

client.delete().guaranteed().deletingChildrenIfNeeded().withVersion(10086).forPath("path");

读取数据节点数据

读取一个节点的数据内容

client.getData().forPath("path");

注意，此方法返的返回值是 byte[ ];

读取一个节点的数据内容，同时获取到该节点的 stat

Stat stat = new Stat();
client.getData().storingStatIn(stat).forPath("path");

更新数据节点数据

更新一个节点的数据内容

client.setData().forPath("path","data".getBytes());

注意：该接口会返回一个 Stat 实例

更新一个节点的数据内容，强制指定版本进行更新

client.setData().withVersion(10086).forPath("path","data".getBytes());

检查节点是否存在

client.checkExists().forPath("path");

注意：该方法返回一个 Stat 实例，用于检查 ZNode 是否存在的操作. 可以调用额外的方法(监控或者后台处理)并在最后调用 forPath( )指定要操作的 ZNode

获取某个节点的所有子节点路径

client.getChildren().forPath("path");

注意：该方法的返回值为 List,获得 ZNode 的子节点 Path 列表。 可以调用额外的方法(监控、后台处理或者获取状态 watch, background or get stat) 并在最后调用 forPath()指定要操作的父 ZNode

事务

CuratorFramework 的实例包含 inTransaction( )接口方法，调用此方法开启一个 ZooKeeper 事务. 可以复合 create, setData, check, and/or delete 等操作然后调用 commit()作为一个原子操作提交。一个例子如下：

client.inTransaction().check().forPath("path")
      .and()
      .create().withMode(CreateMode.EPHEMERAL).forPath("path","data".getBytes())
      .and()
      .setData().withVersion(10086).forPath("path","data2".getBytes())
      .and()
      .commit();

异步接口

上面提到的创建、删除、更新、读取等方法都是同步的，Curator 提供异步接口，引入了 BackgroundCallback 接口用于处理异步接口调用之后服务端返回的结果信息。BackgroundCallback 接口中一个重要的回调值为 CuratorEvent，里面包含事件类型、响应吗和节点的详细信息。

CuratorEventType

响应码(#getResultCode())

一个异步创建节点的例子如下：

Executor executor = Executors.newFixedThreadPool(2);
client.create()
      .creatingParentsIfNeeded()
      .withMode(CreateMode.EPHEMERAL)
      .inBackground((curatorFramework, curatorEvent) -> {      System.out.println(String.format("eventType:%s,resultCode:%s",curatorEvent.getType(),curatorEvent.getResultCode()));
      },executor)
      .forPath("path");

注意：如果#inBackground()方法不指定 executor，那么会默认使用 Curator 的 EventThread 去进行异步处理。

Curator 食谱(高级特性)

提醒：首先你必须添加 curator-recipes 依赖，下文仅仅对 recipes 一些特性的使用进行解释和举例，不打算进行源码级别的探讨

        <dependency>
            <groupId>org.apache.curator</groupId>
            <artifactId>curator-recipes</artifactId>
            <version>2.12.0</version>
        </dependency>

重要提醒：强烈推荐使用 ConnectionStateListener 监控连接的状态，当连接状态为 LOST，curator-recipes 下的所有 Api 将会失效或者过期，尽管后面所有的例子都没有使用到 ConnectionStateListener。

缓存

Zookeeper 原生支持通过注册 Watcher 来进行事件监听，但是开发者需要反复注册(Watcher 只能单次注册单次使用)。Cache 是 Curator 中对事件监听的包装，可以看作是对事件监听的本地缓存视图，能够自动为开发者处理反复注册监听。Curator 提供了三种 Watcher(Cache)来监听结点的变化。

Path Cache

Path Cache 用来监控一个 ZNode 的子节点. 当一个子节点增加， 更新，删除时， Path Cache 会改变它的状态， 会包含最新的子节点， 子节点的数据和状态，而状态的更变将通过 PathChildrenCacheListener 通知。

实际使用时会涉及到四个类：

• PathChildrenCache
• PathChildrenCacheEvent
• PathChildrenCacheListener
• ChildData

通过下面的构造函数创建 Path Cache:

<span style="color:#c792ea;font-style:italic;">public</span> PathChildrenCache(CuratorFramework client, String path, boolean cacheData)

想使用 cache，必须调用它的 start 方法，使用完后调用 close 方法。 可以设置 StartMode 来实现启动的模式，

StartMode 有下面几种：

1. NORMAL：正常初始化。
2. BUILD_INITIAL_CACHE：在调用 start() 之前会调用 rebuild()。
3. POST_INITIALIZED_EVENT： 当 Cache 初始化数据后发送一个 PathChildrenCacheEvent.Type#INITIALIZED 事件

public void addListener(PathChildrenCacheListener listener) 可以增加 listener 监听缓存的变化。

getCurrentData() 方法返回一个 List 对象，可以遍历所有的子节点。

设置/更新、移除其实是使用 client (CuratorFramework)来操作, 不通过 PathChildrenCache 操作：

<span style="color:#c792ea;font-style:italic;">public</span> class PathCacheDemo {

   <span style="color:#c792ea;font-style:italic;">private static final</span> String PATH = "/example/pathCache";

   <span style="color:#c792ea;font-style:italic;">public static</span> void main(String[] args) throws Exception {
      TestingServer server = new TestingServer();
      CuratorFramework client = CuratorFrameworkFactory.newClient(server.getConnectString(), new ExponentialBackoffRetry(1000, 3));
      client.start();
      PathChildrenCache cache = new PathChildrenCache(client, PATH, true);
      cache.start();
      PathChildrenCacheListener cacheListener = (client1, event) -> {
         System.out.println("<span style="font-family:'AR PL UKai HK';">事件类型：</span>" + event.getType());
         if (null != event.getData()) {
            System.out.println("<span style="font-family:'AR PL UKai HK';">节点数据：</span>" + event.getData().getPath() + " = " + new String(event.getData().getData()));
         }
      };
      cache.getListenable().addListener(cacheListener);
      client.create().creatingParentsIfNeeded().forPath("/example/pathCache/test01", "01".getBytes());
      Thread.sleep(10);
      client.create().creatingParentsIfNeeded().forPath("/example/pathCache/test02", "02".getBytes());
      Thread.sleep(10);
      client.setData().forPath("/example/pathCache/test01", "01_V2".getBytes());
      Thread.sleep(10);
      for (ChildData data : cache.getCurrentData()) {
         System.out.println("getCurrentData:" + data.getPath() + " = " + new String(data.getData()));
      }
      client.delete().forPath("/example/pathCache/test01");
      Thread.sleep(10);
      client.delete().forPath("/example/pathCache/test02");
      Thread.sleep(1000 * 5);
      cache.close();
      client.close();
      System.out.println("OK!");
   }
}

注意： 如果 new PathChildrenCache(client, PATH, true)中的参数 cacheData 值设置为 false，则示例中的 event.getData().getData()、data.getData()将返回 null，cache 将不会缓存节点数据。

注意： 示例中的 Thread.sleep(10)可以注释掉，但是注释后事件监听的触发次数会不全，这可能与 PathCache 的实现原理有关，不能太过频繁的触发事件！

Node Cache

Node Cache 与 Path Cache 类似，Node Cache 只是监听某一个特定的节点。它涉及到下面的三个类：

• NodeCache - Node Cache 实现类
• NodeCacheListener - 节点监听器
• ChildData - 节点数据

注意： 使用 cache，依然要调用它的 start() 方法，使用完后调用 close() 方法。

getCurrentData()将得到节点当前的状态，通过它的状态可以得到当前的值。

<span style="color:#c792ea;font-style:italic;">public</span> class NodeCacheDemo {

   <span style="color:#c792ea;font-style:italic;">private static final</span> String PATH = "/example/cache";

   <span style="color:#c792ea;font-style:italic;">public static</span> void main(String[] args) throws Exception {
      TestingServer server = new TestingServer();
      CuratorFramework client = CuratorFrameworkFactory.newClient(server.getConnectString(), new ExponentialBackoffRetry(1000, 3));
      client.start();
      client.create().creatingParentsIfNeeded().forPath(PATH);
      <span style="color:#c792ea;font-style:italic;">final</span> NodeCache cache = new NodeCache(client, PATH);
      NodeCacheListener listener = () -> {
         ChildData data = cache.getCurrentData();
         if (null != data) {
            System.out.println("<span style="font-family:'AR PL UKai HK';">节点数据：</span>" + new String(cache.getCurrentData().getData()));
         } else {
            System.out.println("<span style="font-family:'AR PL UKai HK';">节点被删除</span>!");
         }
      };
      cache.getListenable().addListener(listener);
      cache.start();
      client.setData().forPath(PATH, "01".getBytes());
      Thread.sleep(100);
      client.setData().forPath(PATH, "02".getBytes());
      Thread.sleep(100);
      client.delete().deletingChildrenIfNeeded().forPath(PATH);
      Thread.sleep(1000 * 2);
      cache.close();
      client.close();
      System.out.println("OK!");
   }
}

注意： 示例中的 Thread.sleep(10)可以注释，但是注释后事件监听的触发次数会不全，这可能与 NodeCache 的实现原理有关，不能太过频繁的触发事件！

注意： NodeCache 只能监听一个节点的状态变化。

Tree Cache

Tree Cache 可以监控整个树上的所有节点，类似于 PathCache 和 NodeCache 的组合，主要涉及到下面四个类：

• TreeCache - Tree Cache 实现类
• TreeCacheListener - 监听器类
• TreeCacheEvent - 触发的事件类
• ChildData - 节点数据

<span style="color:#c792ea;font-style:italic;">public</span> class TreeCacheDemo {

   <span style="color:#c792ea;font-style:italic;">private static final</span> String PATH = "/example/cache";

   <span style="color:#c792ea;font-style:italic;">public static</span> void main(String[] args) throws Exception {
      TestingServer server = new TestingServer();
      CuratorFramework client = CuratorFrameworkFactory.newClient(server.getConnectString(), new ExponentialBackoffRetry(1000, 3));
      client.start();
      client.create().creatingParentsIfNeeded().forPath(PATH);
      TreeCache cache = new TreeCache(client, PATH);
      TreeCacheListener listener = (client1, event) ->
            System.out.println("<span style="font-family:'AR PL UKai HK';">事件类型：</span>" + event.getType() +
                  " | <span style="font-family:'AR PL UKai HK';">路径：</span>" + (null != event.getData() ? event.getData().getPath() : null));
      cache.getListenable().addListener(listener);
      cache.start();
      client.setData().forPath(PATH, "01".getBytes());
      Thread.sleep(100);
      client.setData().forPath(PATH, "02".getBytes());
      Thread.sleep(100);
      client.delete().deletingChildrenIfNeeded().forPath(PATH);
      Thread.sleep(1000 * 2);
      cache.close();
      client.close();
      System.out.println("OK!");
   }
}

注意： 在此示例中没有使用 Thread.sleep(10)，但是事件触发次数也是正常的。

注意： TreeCache 在初始化(调用 start() 方法)的时候会回调 TreeCacheListener 实例一个事 TreeCacheEvent，而回调的 TreeCacheEvent 对象的 Type 为 INITIALIZED，ChildData 为 null，此时 event.getData().getPath() 很有可能导致空指针异常，这里应该主动处理并避免这种情况。

Leader 选举

在分布式计算中， leader elections 是很重要的一个功能， 这个选举过程是这样子的： 指派一个进程作为组织者，将任务分发给各节点。 在任务开始前， 哪个节点都不知道谁是 leader(领导者)或者 coordinator(协调者). 当选举算法开始执行后， 每个节点最终会得到一个唯一的节点作为任务 leader. 除此之外， 选举还经常会发生在 leader 意外宕机的情况下，新的 leader 要被选举出来。

在 zookeeper 集群中，leader 负责写操作，然后通过 Zab 协议实现 follower 的同步，leader 或者 follower 都可以处理读操作。

Curator 有两种 leader 选举的 recipe,分别是 LeaderSelector 和 LeaderLatch。

前者是所有存活的客户端不间断的轮流做 Leader，大同社会。后者是一旦选举出 Leader，除非有客户端挂掉重新触发选举，否则不会交出领导权。某党?

LeaderLatch

LeaderLatch 有两个构造函数：

<span style="color:#c792ea;font-style:italic;">public</span> LeaderLatch(CuratorFramework client, String latchPath)
<span style="color:#c792ea;font-style:italic;">public</span> LeaderLatch(CuratorFramework client, String latchPath,  String id)

LeaderLatch 的启动：

leaderLatch.start( );

一旦启动，LeaderLatch 会和其它使用相同 latch path 的其它 LeaderLatch 交涉，然后其中一个最终会被选举为 leader，可以通过 hasLeadership 方法查看 LeaderLatch 实例是否 leader：

leaderLatch.hasLeadership( ); //返回 true 说明当前实例是 leader

类似 JDK 的 CountDownLatch， LeaderLatch 在请求成为 leadership 会 block(阻塞)，一旦不使用 LeaderLatch 了，必须调用 close 方法。 如果它是 leader,会释放 leadership， 其它的参与者将会选举一个 leader。

<span style="color:#c792ea;font-style:italic;">public</span> void await() throws InterruptedException,EOFException
/*Causes the current thread to wait until this instance acquires leadership
unless the thread is interrupted or closed.*/
<span style="color:#c792ea;font-style:italic;">public</span> boolean await(long timeout,TimeUnit unit)throws InterruptedException

异常处理： LeaderLatch 实例可以增加 ConnectionStateListener 来监听网络连接问题。 当 SUSPENDED 或 LOST 时, leader 不再认为自己还是 leader。当 LOST 后连接重连后 RECONNECTED,LeaderLatch 会删除先前的 ZNode 然后重新创建一个。LeaderLatch 用户必须考虑导致 leadership 丢失的连接问题。 强烈推荐你使用 ConnectionStateListener。

一个 LeaderLatch 的使用例子：

<span style="color:#c792ea;font-style:italic;">public</span> class LeaderLatchDemo extends BaseConnectionInfo {
   <span style="color:#c792ea;font-style:italic;">protected static</span> String PATH = "/francis/leader";
   <span style="color:#c792ea;font-style:italic;">private static final</span> int CLIENT_QTY = 10;

   <span style="color:#c792ea;font-style:italic;">public static</span> void main(String[] args) throws Exception {
      List<CuratorFramework> clients = Lists.newArrayList();
      List<LeaderLatch> examples = Lists.newArrayList();
      TestingServer server=new TestingServer();
      try {
         for (int i = 0; i < CLIENT_QTY; i++) {
            CuratorFramework client
                  = CuratorFrameworkFactory.newClient(server.getConnectString(), new ExponentialBackoffRetry(20000, 3));
            clients.add(client);
            LeaderLatch latch = new LeaderLatch(client, PATH, "Client #" + i);
            latch.addListener(new LeaderLatchListener() {

               @Override
               <span style="color:#c792ea;font-style:italic;">public</span> void isLeader() {
                  // <span style="color:#ffeb95;font-style:italic;">TODO Auto-generated method stub
</span>                  System.out.println("I am Leader");
               }

               @Override
               <span style="color:#c792ea;font-style:italic;">public</span> void notLeader() {
                  // <span style="color:#ffeb95;font-style:italic;">TODO Auto-generated method stub
</span>                  System.out.println("I am not Leader");
               }
            });
            examples.add(latch);
            client.start();
            latch.start();
         }
         Thread.sleep(10000);
         LeaderLatch currentLeader = null;
         for (LeaderLatch latch : examples) {
            if (latch.hasLeadership()) {
               currentLeader = latch;
            }
         }
         System.out.println("current leader is " + currentLeader.getId());
         System.out.println("release the leader " + currentLeader.getId());
         currentLeader.close();

         Thread.sleep(5000);

         for (LeaderLatch latch : examples) {
            if (latch.hasLeadership()) {
               currentLeader = latch;
            }
         }
         System.out.println("current leader is " + currentLeader.getId());
         System.out.println("release the leader " + currentLeader.getId());
      } finally {
         for (LeaderLatch latch : examples) {
            if (null != latch.getState())
            CloseableUtils.closeQuietly(latch);
         }
         for (CuratorFramework client : clients) {
            CloseableUtils.closeQuietly(client);
         }
      }
   }
}

可以添加 test module 的依赖方便进行测试，不需要启动真实的 zookeeper 服务端：

        <dependency>
            <groupId>org.apache.curator</groupId>
            <artifactId>curator-test</artifactId>
            <version>2.12.0</version>
        </dependency>

首先我们创建了 10 个 LeaderLatch，启动后它们中的一个会被选举为 leader。 因为选举会花费一些时间，start 后并不能马上就得到 leader。
通过 hasLeadership 查看自己是否是 leader， 如果是的话返回 true。
可以通过 .getLeader().getId() 可以得到当前的 leader 的 ID。
只能通过 close 释放当前的领导权。
await 是一个阻塞方法， 尝试获取 leader 地位，但是未必能上位。

LeaderSelector

LeaderSelector 使用的时候主要涉及下面几个类：

• LeaderSelector
• LeaderSelectorListener
• LeaderSelectorListenerAdapter
• CancelLeadershipException

核心类是 LeaderSelector，它的构造函数如下：

<span style="color:#c792ea;font-style:italic;">public</span> LeaderSelector(CuratorFramework client, String mutexPath,LeaderSelectorListener listener)
<span style="color:#c792ea;font-style:italic;">public</span> LeaderSelector(CuratorFramework client, String mutexPath, ThreadFactory threadFactory, Executor executor, LeaderSelectorListener listener)

类似 LeaderLatch,LeaderSelector 必须 start: leaderSelector.start(); 一旦启动，当实例取得领导权时你的 listener 的 takeLeadership() 方法被调用。而 takeLeadership()方法只有领导权被释放时才返回。 当你不再使用 LeaderSelector 实例时，应该调用它的 close 方法。

异常处理 LeaderSelectorListener 类继承 ConnectionStateListener。LeaderSelector 必须小心连接状态的改变。如果实例成为 leader, 它应该响应 SUSPENDED 或 LOST。 当 SUSPENDED 状态出现时， 实例必须假定在重新连接成功之前它可能不再是 leader 了。 如果 LOST 状态出现， 实例不再是 leader， takeLeadership 方法返回。

重要: 推荐处理方式是当收到 SUSPENDED 或 LOST 时抛出 CancelLeadershipException 异常.。这会导致 LeaderSelector 实例中断并取消执行 takeLeadership 方法的异常.。这非常重要， 你必须考虑扩展 LeaderSelectorListenerAdapter. LeaderSelectorListenerAdapter 提供了推荐的处理逻辑。

下面的一个例子摘抄自官方：

<span style="color:#c792ea;font-style:italic;">public</span> class LeaderSelectorAdapter extends LeaderSelectorListenerAdapter implements Closeable {
   <span style="color:#c792ea;font-style:italic;">private final</span> String name;
   <span style="color:#c792ea;font-style:italic;">private final</span> LeaderSelector leaderSelector;
   <span style="color:#c792ea;font-style:italic;">private final</span> AtomicInteger leaderCount = new AtomicInteger();

   <span style="color:#c792ea;font-style:italic;">public</span> LeaderSelectorAdapter(CuratorFramework client, String path, String name) {
      <span style="color:#c792ea;font-style:italic;">this</span>.name = name;
      leaderSelector = new LeaderSelector(client, path, <span style="color:#c792ea;font-style:italic;">this</span>);
      leaderSelector.autoRequeue();
   }

   <span style="color:#c792ea;font-style:italic;">public</span> void start() throws IOException {
      leaderSelector.start();
   }

   @Override
   <span style="color:#c792ea;font-style:italic;">public</span> void close() throws IOException {
      leaderSelector.close();
   }

   @Override
   <span style="color:#c792ea;font-style:italic;">public</span> void takeLeadership(CuratorFramework client) throws Exception {
      <span style="color:#c792ea;font-style:italic;">final</span> int waitSeconds = (int) (5 * Math.random()) + 1;
      System.out.println(name + " is now the leader. Waiting " + waitSeconds + " seconds...");
      System.out.println(name + " has been leader " + leaderCount.getAndIncrement() + " time(s) before.");
      try {
         Thread.sleep(TimeUnit.SECONDS.toMillis(waitSeconds));
      } catch (InterruptedException e) {
         System.err.println(name + " was interrupted.");
         Thread.currentThread().interrupt();
      } finally {
         System.out.println(name + " relinquishing leadership.\n");
      }
   }
}

你可以在 takeLeadership 进行任务的分配等等，并且不要返回，如果你想要要此实例一直是 leader 的话可以加一个死循环。调用 leaderSelector.autoRequeue(); 保证在此实例释放领导权之后还可能获得领导权。 在这里我们使用 AtomicInteger 来记录此 client 获得领导权的次数， 它是”fair”， 每个 client 有平等的机会获得领导权。

<span style="color:#c792ea;font-style:italic;">public</span> class LeaderSelectorDemo {

   <span style="color:#c792ea;font-style:italic;">protected static</span> String PATH = "/francis/leader";
   <span style="color:#c792ea;font-style:italic;">private static final</span> int CLIENT_QTY = 10;

   <span style="color:#c792ea;font-style:italic;">public static</span> void main(String[] args) throws Exception {
      List<CuratorFramework> clients = Lists.newArrayList();
      List<LeaderSelectorAdapter> examples = Lists.newArrayList();
      TestingServer server = new TestingServer();
      try {
         for (int i = 0; i < CLIENT_QTY; i++) {
            CuratorFramework client
                  = CuratorFrameworkFactory.newClient(server.getConnectString(), new ExponentialBackoffRetry(20000, 3));
            clients.add(client);
            LeaderSelectorAdapter selectorAdapter = new LeaderSelectorAdapter(client, PATH, "Client #" + i);
            examples.add(selectorAdapter);
            client.start();
            selectorAdapter.start();
         }
         System.out.println("Press enter/return to quit\n");
         new BufferedReader(new InputStreamReader(System.in)).readLine();
      } finally {
         System.out.println("Shutting down...");
         for (LeaderSelectorAdapter exampleClient : examples) {
            CloseableUtils.closeQuietly(exampleClient);
         }
         for (CuratorFramework client : clients) {
            CloseableUtils.closeQuietly(client);
         }
         CloseableUtils.closeQuietly(server);
      }
   }
}

对比可知，LeaderLatch 必须调用 close() 方法才会释放领导权，而对于 LeaderSelector，通过 LeaderSelectorListener 可以对领导权进行控制， 在适当的时候释放领导权，这样每个节点都有可能获得领导权。从而，LeaderSelector 具有更好的灵活性和可控性，建议有 LeaderElection 应用场景下优先使用 LeaderSelector。

分布式锁

提醒：

1.推荐使用 ConnectionStateListener 监控连接的状态，因为当连接 LOST 时你不再拥有锁

2.分布式的锁全局同步， 这意味着任何一个时间点不会有两个客户端都拥有相同的锁。

可重入共享锁—Shared Reentrant Lock

Shared 意味着锁是全局可见的， 客户端都可以请求锁。 Reentrant 和 JDK 的 ReentrantLock 类似，即可重入， 意味着同一个客户端在拥有锁的同时，可以多次获取，不会被阻塞。 它是由类 InterProcessMutex 来实现。 它的构造函数为：

<span style="color:#c792ea;font-style:italic;">public</span> InterProcessMutex(CuratorFramework client, String path)

通过 acquire() 获得锁，并提供超时机制：

<span style="color:#c792ea;font-style:italic;">public</span> void acquire()
Acquire the mutex - blocking until it's available. Note: the same thread can call acquire
re-entrantly. Each call to acquire must be balanced by a call to release()

<span style="color:#c792ea;font-style:italic;">public</span> boolean acquire(long time,TimeUnit unit)
Acquire the mutex - blocks until it's available or the given time expires. Note: the same thread can call acquire re-entrantly. Each call to acquire that returns true must be balanced by a call to release()

Parameters:
time - time to wait
unit - time unit
Returns:
true if the mutex was acquired, false if not

通过 release() 方法释放锁。 InterProcessMutex 实例可以重用。

Revoking ZooKeeper recipes wiki 定义了可协商的撤销机制。 为了撤销 mutex, 调用下面的方法：

<span style="color:#c792ea;font-style:italic;">public</span> void makeRevocable(RevocationListener<T> listener)
<span style="font-family:'AR PL UKai HK';">将锁设为可撤销的</span>. <span style="font-family:'AR PL UKai HK';">当别的进程或线程想让你释放锁时</span>Listener<span style="font-family:'AR PL UKai HK';">会被调用。
</span>Parameters:
listener - the listener

如果你请求撤销当前的锁， 调用 attemptRevoke() 方法,注意锁释放时 RevocationListener 将会回调。

<span style="color:#c792ea;font-style:italic;">public static</span> void attemptRevoke(CuratorFramework client,String path) throws Exception
Utility to mark a lock for revocation. Assuming that the lock has been registered
with a RevocationListener, it will get called and the lock should be released. Note,
however, that revocation is cooperative.
Parameters:
client - the client
path - the path of the lock - usually from something like InterProcessMutex.getParticipantNodes()

二次提醒：错误处理 还是强烈推荐你使用 ConnectionStateListener 处理连接状态的改变。 当连接 LOST 时你不再拥有锁。

首先让我们创建一个模拟的共享资源， 这个资源期望只能单线程的访问，否则会有并发问题。

<span style="color:#c792ea;font-style:italic;">public</span> class FakeLimitedResource {
   <span style="color:#c792ea;font-style:italic;">private final</span> AtomicBoolean inUse = new AtomicBoolean(false);

   <span style="color:#c792ea;font-style:italic;">public</span> void use() throws InterruptedException {
      // <span style="font-family:'AR PL UKai HK';">真实环境中我们会在这里访问</span>/<span style="font-family:'AR PL UKai HK';">维护一个共享的资源
</span>      //<span style="font-family:'AR PL UKai HK';">这个例子在使用锁的情况下不会非法并发异常</span>IllegalStateException
      //<span style="font-family:'AR PL UKai HK';">但是在无锁的情况由于</span>sleep<span style="font-family:'AR PL UKai HK';">了一段时间，很容易抛出异常
</span>      if (!inUse.compareAndSet(false, true)) {
         throw new IllegalStateException("Needs to be used by one client at a time");
      }
      try {
         Thread.sleep((long) (3 * Math.random()));
      } finally {
         inUse.set(false);
      }
   }
}

然后创建一个 InterProcessMutexDemo 类， 它负责请求锁， 使用资源，释放锁这样一个完整的访问过程。

<span style="color:#c792ea;font-style:italic;">public</span> class InterProcessMutexDemo {

   <span style="color:#c792ea;font-style:italic;">private</span> InterProcessMutex lock;
   <span style="color:#c792ea;font-style:italic;">private final</span> FakeLimitedResource resource;
   <span style="color:#c792ea;font-style:italic;">private final</span> String clientName;

   <span style="color:#c792ea;font-style:italic;">public</span> InterProcessMutexDemo(CuratorFramework client, String lockPath, FakeLimitedResource resource, String clientName) {
      <span style="color:#c792ea;font-style:italic;">this</span>.resource = resource;
      <span style="color:#c792ea;font-style:italic;">this</span>.clientName = clientName;
      <span style="color:#c792ea;font-style:italic;">this</span>.lock = new InterProcessMutex(client, lockPath);
   }

   <span style="color:#c792ea;font-style:italic;">public</span> void doWork(long time, TimeUnit unit) throws Exception {
      if (!lock.acquire(time, unit)) {
         throw new IllegalStateException(clientName + " could not acquire the lock");
      }
      try {
         System.out.println(clientName + " get the lock");
         resource.use(); //access resource exclusively
      } finally {
         System.out.println(clientName + " releasing the lock");
         lock.release(); // always release the lock in a finally block
      }
   }

   <span style="color:#c792ea;font-style:italic;">private static final</span> int QTY = 5;
   <span style="color:#c792ea;font-style:italic;">private static final</span> int REPETITIONS = QTY * 10;
   <span style="color:#c792ea;font-style:italic;">private static final</span> String PATH = "/examples/locks";

   <span style="color:#c792ea;font-style:italic;">public static</span> void main(String[] args) throws Exception {
      <span style="color:#c792ea;font-style:italic;">final</span> FakeLimitedResource resource = new FakeLimitedResource();
      ExecutorService service = Executors.newFixedThreadPool(QTY);
      <span style="color:#c792ea;font-style:italic;">final</span> TestingServer server = new TestingServer();
      try {
         for (int i = 0; i < QTY; ++i) {
            <span style="color:#c792ea;font-style:italic;">final</span> int index = i;
            Callable<Void> task = new Callable<Void>() {
               @Override
               <span style="color:#c792ea;font-style:italic;">public</span> Void call() throws Exception {
                  CuratorFramework client = CuratorFrameworkFactory.newClient(server.getConnectString(), new ExponentialBackoffRetry(1000, 3));
                  try {
                     client.start();
                     <span style="color:#c792ea;font-style:italic;">final</span> InterProcessMutexDemo example = new InterProcessMutexDemo(client, PATH, resource, "Client " + index);
                     for (int j = 0; j < REPETITIONS; ++j) {
                        example.doWork(10, TimeUnit.SECONDS);
                     }
                  } catch (Throwable e) {
                     e.printStackTrace();
                  } finally {
                     CloseableUtils.closeQuietly(client);
                  }
                  return null;
               }
            };
            service.submit(task);
         }
         service.shutdown();
         service.awaitTermination(10, TimeUnit.MINUTES);
      } finally {
         CloseableUtils.closeQuietly(server);
      }
   }
}

代码也很简单，生成 10 个 client， 每个 client 重复执行 10 次 请求锁–访问资源–释放锁的过程。每个 client 都在独立的线程中。 结果可以看到，锁是随机的被每个实例排他性的使用。

既然是可重用的，你可以在一个线程中多次调用 acquire(),在线程拥有锁时它总是返回 true。

你不应该在多个线程中用同一个 InterProcessMutex， 你可以在每个线程中都生成一个新的 InterProcessMutex 实例，它们的 path 都一样，这样它们可以共享同一个锁。

不可重入共享锁—Shared Lock

这个锁和上面的 InterProcessMutex 相比，就是少了 Reentrant 的功能，也就意味着它不能在同一个线程中重入。这个类是 InterProcessSemaphoreMutex,使用方法和 InterProcessMutex 类似

<span style="color:#c792ea;font-style:italic;">public</span> class InterProcessSemaphoreMutexDemo {

   <span style="color:#c792ea;font-style:italic;">private</span> InterProcessSemaphoreMutex lock;
   <span style="color:#c792ea;font-style:italic;">private final</span> FakeLimitedResource resource;
   <span style="color:#c792ea;font-style:italic;">private final</span> String clientName;

   <span style="color:#c792ea;font-style:italic;">public</span> InterProcessSemaphoreMutexDemo(CuratorFramework client, String lockPath, FakeLimitedResource resource, String clientName) {
      <span style="color:#c792ea;font-style:italic;">this</span>.resource = resource;
      <span style="color:#c792ea;font-style:italic;">this</span>.clientName = clientName;
      <span style="color:#c792ea;font-style:italic;">this</span>.lock = new InterProcessSemaphoreMutex(client, lockPath);
   }

   <span style="color:#c792ea;font-style:italic;">public</span> void doWork(long time, TimeUnit unit) throws Exception {
      if (!lock.acquire(time, unit))
      {
         throw new IllegalStateException(clientName + " <span style="font-family:'AR PL UKai HK';">不能得到互斥锁</span>");
      }
      System.out.println(clientName + " <span style="font-family:'AR PL UKai HK';">已获取到互斥锁</span>");
      if (!lock.acquire(time, unit))
      {
         throw new IllegalStateException(clientName + " <span style="font-family:'AR PL UKai HK';">不能得到互斥锁</span>");
      }
      System.out.println(clientName + " <span style="font-family:'AR PL UKai HK';">再次获取到互斥锁</span>");
      try {
         System.out.println(clientName + " get the lock");
         resource.use(); //access resource exclusively
      } finally {
         System.out.println(clientName + " releasing the lock");
         lock.release(); // always release the lock in a finally block
         lock.release(); // <span style="font-family:'AR PL UKai HK';">获取锁几次 释放锁也要几次
</span>      }
   }

   <span style="color:#c792ea;font-style:italic;">private static final</span> int QTY = 5;
   <span style="color:#c792ea;font-style:italic;">private static final</span> int REPETITIONS = QTY * 10;
   <span style="color:#c792ea;font-style:italic;">private static final</span> String PATH = "/examples/locks";

   <span style="color:#c792ea;font-style:italic;">public static</span> void main(String[] args) throws Exception {
      <span style="color:#c792ea;font-style:italic;">final</span> FakeLimitedResource resource = new FakeLimitedResource();
      ExecutorService service = Executors.newFixedThreadPool(QTY);
      <span style="color:#c792ea;font-style:italic;">final</span> TestingServer server = new TestingServer();
      try {
         for (int i = 0; i < QTY; ++i) {
            <span style="color:#c792ea;font-style:italic;">final</span> int index = i;
            Callable<Void> task = new Callable<Void>() {
               @Override
               <span style="color:#c792ea;font-style:italic;">public</span> Void call() throws Exception {
                  CuratorFramework client = CuratorFrameworkFactory.newClient(server.getConnectString(), new ExponentialBackoffRetry(1000, 3));
                  try {
                     client.start();
                     <span style="color:#c792ea;font-style:italic;">final</span> InterProcessSemaphoreMutexDemo example = new InterProcessSemaphoreMutexDemo(client, PATH, resource, "Client " + index);
                     for (int j = 0; j < REPETITIONS; ++j) {
                        example.doWork(10, TimeUnit.SECONDS);
                     }
                  } catch (Throwable e) {
                     e.printStackTrace();
                  } finally {
                     CloseableUtils.closeQuietly(client);
                  }
                  return null;
               }
            };
            service.submit(task);
         }
         service.shutdown();
         service.awaitTermination(10, TimeUnit.MINUTES);
      } finally {
         CloseableUtils.closeQuietly(server);
      }
      Thread.sleep(Integer.MAX_VALUE);
   }
}

运行后发现，有且只有一个 client 成功获取第一个锁(第一个 acquire() 方法返回 true)，然后它自己阻塞在第二个 acquire() 方法，获取第二个锁超时；其他所有的客户端都阻塞在第一个 acquire() 方法超时并且抛出异常。

这样也就验证了 InterProcessSemaphoreMutex 实现的锁是不可重入的。

可重入读写锁—Shared Reentrant Read Write Lock

类似 JDK 的 ReentrantReadWriteLock。一个读写锁管理一对相关的锁。一个负责读操作，另外一个负责写操作。读操作在写锁没被使用时可同时由多个进程使用，而写锁在使用时不允许读(阻塞)。

此锁是可重入的。一个拥有写锁的线程可重入读锁，但是读锁却不能进入写锁。这也意味着写锁可以降级成读锁， 比如请求写锁 ---> 请求读锁---> 释放读锁 ----> 释放写锁。从读锁升级成写锁是不行的。

可重入读写锁主要由两个类实现：InterProcessReadWriteLock、InterProcessMutex。使用时首先创建一个 InterProcessReadWriteLock 实例，然后再根据你的需求得到读锁或者写锁，读写锁的类型是 InterProcessMutex。

<span style="color:#c792ea;font-style:italic;">public</span> class ReentrantReadWriteLockDemo {

   <span style="color:#c792ea;font-style:italic;">private final</span> InterProcessReadWriteLock lock;
   <span style="color:#c792ea;font-style:italic;">private final</span> InterProcessMutex readLock;
   <span style="color:#c792ea;font-style:italic;">private final</span> InterProcessMutex writeLock;
   <span style="color:#c792ea;font-style:italic;">private final</span> FakeLimitedResource resource;
   <span style="color:#c792ea;font-style:italic;">private final</span> String clientName;

   <span style="color:#c792ea;font-style:italic;">public</span> ReentrantReadWriteLockDemo(CuratorFramework client, String lockPath, FakeLimitedResource resource, String clientName) {
      <span style="color:#c792ea;font-style:italic;">this</span>.resource = resource;
      <span style="color:#c792ea;font-style:italic;">this</span>.clientName = clientName;
      lock = new InterProcessReadWriteLock(client, lockPath);
      readLock = lock.readLock();
      writeLock = lock.writeLock();
   }

   <span style="color:#c792ea;font-style:italic;">public</span> void doWork(long time, TimeUnit unit) throws Exception {
      // <span style="font-family:'AR PL UKai HK';">注意只能先得到写锁再得到读锁，不能反过来！！！
</span>      if (!writeLock.acquire(time, unit)) {
         throw new IllegalStateException(clientName + " <span style="font-family:'AR PL UKai HK';">不能得到写锁</span>");
      }
      System.out.println(clientName + " <span style="font-family:'AR PL UKai HK';">已得到写锁</span>");
      if (!readLock.acquire(time, unit)) {
         throw new IllegalStateException(clientName + " <span style="font-family:'AR PL UKai HK';">不能得到读锁</span>");
      }
      System.out.println(clientName + " <span style="font-family:'AR PL UKai HK';">已得到读锁</span>");
      try {
         resource.use(); // <span style="font-family:'AR PL UKai HK';">使用资源
</span>         Thread.sleep(1000);
      } finally {
         System.out.println(clientName + " <span style="font-family:'AR PL UKai HK';">释放读写锁</span>");
         readLock.release();
         writeLock.release();
      }
   }

   <span style="color:#c792ea;font-style:italic;">private static final</span> int QTY = 5;
   <span style="color:#c792ea;font-style:italic;">private static final</span> int REPETITIONS = QTY ;
   <span style="color:#c792ea;font-style:italic;">private static final</span> String PATH = "/examples/locks";

   <span style="color:#c792ea;font-style:italic;">public static</span> void main(String[] args) throws Exception {
      <span style="color:#c792ea;font-style:italic;">final</span> FakeLimitedResource resource = new FakeLimitedResource();
      ExecutorService service = Executors.newFixedThreadPool(QTY);
      <span style="color:#c792ea;font-style:italic;">final</span> TestingServer server = new TestingServer();
      try {
         for (int i = 0; i < QTY; ++i) {
            <span style="color:#c792ea;font-style:italic;">final</span> int index = i;
            Callable<Void> task = new Callable<Void>() {
               @Override
               <span style="color:#c792ea;font-style:italic;">public</span> Void call() throws Exception {
                  CuratorFramework client = CuratorFrameworkFactory.newClient(server.getConnectString(), new ExponentialBackoffRetry(1000, 3));
                  try {
                     client.start();
                     <span style="color:#c792ea;font-style:italic;">final</span> ReentrantReadWriteLockDemo example = new ReentrantReadWriteLockDemo(client, PATH, resource, "Client " + index);
                     for (int j = 0; j < REPETITIONS; ++j) {
                        example.doWork(10, TimeUnit.SECONDS);
                     }
                  } catch (Throwable e) {
                     e.printStackTrace();
                  } finally {
                     CloseableUtils.closeQuietly(client);
                  }
                  return null;
               }
            };
            service.submit(task);
         }
         service.shutdown();
         service.awaitTermination(10, TimeUnit.MINUTES);
      } finally {
         CloseableUtils.closeQuietly(server);
      }
   }
}

信号量—Shared Semaphore

一个计数的信号量类似 JDK 的 Semaphore。 JDK 中 Semaphore 维护的一组许可(permits)，而 Curator 中称之为租约(Lease)。 有两种方式可以决定 semaphore 的最大租约数。第一种方式是用户给定 path 并且指定最大 LeaseSize。第二种方式用户给定 path 并且使用 SharedCountReader 类。如果不使用 SharedCountReader, 必须保证所有实例在多进程中使用相同的(最大)租约数量,否则有可能出现 A 进程中的实例持有最大租约数量为 10，但是在 B 进程中持有的最大租约数量为 20，此时租约的意义就失效了。

这次调用 acquire() 会返回一个租约对象。 客户端必须在 finally 中 close 这些租约对象，否则这些租约会丢失掉。 但是， 但是，如果客户端 session 由于某种原因比如 crash 丢掉， 那么这些客户端持有的租约会自动 close， 这样其它客户端可以继续使用这些租约。 租约还可以通过下面的方式返还：

<span style="color:#c792ea;font-style:italic;">public</span> void returnAll(Collection<Lease> leases)
<span style="color:#c792ea;font-style:italic;">public</span> void returnLease(Lease lease)

注意你可以一次性请求多个租约，如果 Semaphore 当前的租约不够，则请求线程会被阻塞。 同时还提供了超时的重载方法。

<span style="color:#c792ea;font-style:italic;">public</span> Lease acquire()
<span style="color:#c792ea;font-style:italic;">public</span> Collection<Lease> acquire(int qty)
<span style="color:#c792ea;font-style:italic;">public</span> Lease acquire(long time, TimeUnit unit)
<span style="color:#c792ea;font-style:italic;">public</span> Collection<Lease> acquire(int qty, long time, TimeUnit unit)

Shared Semaphore 使用的主要类包括下面几个：

• InterProcessSemaphoreV2
• Lease
• SharedCountReader

<span style="color:#c792ea;font-style:italic;">public</span> class InterProcessSemaphoreDemo {

   <span style="color:#c792ea;font-style:italic;">private static final</span> int MAX_LEASE = 10;
   <span style="color:#c792ea;font-style:italic;">private static final</span> String PATH = "/examples/locks";

   <span style="color:#c792ea;font-style:italic;">public static</span> void main(String[] args) throws Exception {
      FakeLimitedResource resource = new FakeLimitedResource();
      try (TestingServer server = new TestingServer()) {

         CuratorFramework client = CuratorFrameworkFactory.newClient(server.getConnectString(), new ExponentialBackoffRetry(1000, 3));
         client.start();

         InterProcessSemaphoreV2 semaphore = new InterProcessSemaphoreV2(client, PATH, MAX_LEASE);
         Collection<Lease> leases = semaphore.acquire(5);
         System.out.println("get " + leases.size() + " leases");
         Lease lease = semaphore.acquire();
         System.out.println("get another lease");

         resource.use();

         Collection<Lease> leases2 = semaphore.acquire(5, 10, TimeUnit.SECONDS);
         System.out.println("Should timeout and acquire return " + leases2);

         System.out.println("return one lease");
         semaphore.returnLease(lease);
         System.out.println("return another 5 leases");
         semaphore.returnAll(leases);
      }
   }
}

首先我们先获得了 5 个租约， 最后我们把它还给了 semaphore。 接着请求了一个租约，因为 semaphore 还有 5 个租约，所以请求可以满足，返回一个租约，还剩 4 个租约。 然后再请求一个租约，因为租约不够，阻塞到超时，还是没能满足，返回结果为 null(租约不足会阻塞到超时，然后返回 null，不会主动抛出异常；如果不设置超时时间，会一致阻塞)。

上面说讲的锁都是公平锁(fair)。 总 ZooKeeper 的角度看， 每个客户端都按照请求的顺序获得锁，不存在非公平的抢占的情况。

多共享锁对象 —Multi Shared Lock

Multi Shared Lock 是一个锁的容器。 当调用 acquire()， 所有的锁都会被 acquire()，如果请求失败，所有的锁都会被 release。 同样调用 release 时所有的锁都被 release(失败被忽略)。 基本上，它就是组锁的代表，在它上面的请求释放操作都会传递给它包含的所有的锁。

主要涉及两个类：

• InterProcessMultiLock
• InterProcessLock

它的构造函数需要包含的锁的集合，或者一组 ZooKeeper 的 path。

<span style="color:#c792ea;font-style:italic;">public</span> InterProcessMultiLock(List<InterProcessLock> locks)
<span style="color:#c792ea;font-style:italic;">public</span> InterProcessMultiLock(CuratorFramework client, List<String> paths)

用法和 Shared Lock 相同。

<span style="color:#c792ea;font-style:italic;">public</span> class MultiSharedLockDemo {

   <span style="color:#c792ea;font-style:italic;">private static final</span> String PATH1 = "/examples/locks1";
   <span style="color:#c792ea;font-style:italic;">private static final</span> String PATH2 = "/examples/locks2";

   <span style="color:#c792ea;font-style:italic;">public static</span> void main(String[] args) throws Exception {
      FakeLimitedResource resource = new FakeLimitedResource();
      try (TestingServer server = new TestingServer()) {
         CuratorFramework client = CuratorFrameworkFactory.newClient(server.getConnectString(), new ExponentialBackoffRetry(1000, 3));
         client.start();

         InterProcessLock lock1 = new InterProcessMutex(client, PATH1);
         InterProcessLock lock2 = new InterProcessSemaphoreMutex(client, PATH2);

         InterProcessMultiLock lock = new InterProcessMultiLock(Arrays.asList(lock1, lock2));

         if (!lock.acquire(10, TimeUnit.SECONDS)) {
            throw new IllegalStateException("could not acquire the lock");
         }
         System.out.println("has got all lock");

         System.out.println("has got lock1: " + lock1.isAcquiredInThisProcess());
         System.out.println("has got lock2: " + lock2.isAcquiredInThisProcess());

         try {
            resource.use(); //access resource exclusively
         } finally {
            System.out.println("releasing the lock");
            lock.release(); // always release the lock in a finally block
         }
         System.out.println("has got lock1: " + lock1.isAcquiredInThisProcess());
         System.out.println("has got lock2: " + lock2.isAcquiredInThisProcess());
      }
   }
}

新建一个 InterProcessMultiLock， 包含一个重入锁和一个非重入锁。 调用 acquire() 后可以看到线程同时拥有了这两个锁。 调用 release() 看到这两个锁都被释放了。

最后再重申一次， 强烈推荐使用 ConnectionStateListener 监控连接的状态，当连接状态为 LOST，锁将会丢失。

分布式计数器

顾名思义，计数器是用来计数的, 利用 ZooKeeper 可以实现一个集群共享的计数器。 只要使用相同的 path 就可以得到最新的计数器值， 这是由 ZooKeeper 的一致性保证的。Curator 有两个计数器， 一个是用 int 来计数(SharedCount)，一个用 long 来计数(DistributedAtomicLong)。

分布式 int 计数器—SharedCount

这个类使用 int 类型来计数。 主要涉及三个类。

• SharedCount
• SharedCountReader
• SharedCountListener

SharedCount 代表计数器， 可以为它增加一个 SharedCountListener，当计数器改变时此 Listener 可以监听到改变的事件，而 SharedCountReader 可以读取到最新的值， 包括字面值和带版本信息的值 VersionedValue。

<span style="color:#c792ea;font-style:italic;">public</span> class SharedCounterDemo implements SharedCountListener {

   <span style="color:#c792ea;font-style:italic;">private static final</span> int QTY = 5;
   <span style="color:#c792ea;font-style:italic;">private static final</span> String PATH = "/examples/counter";

   <span style="color:#c792ea;font-style:italic;">public static</span> void main(String[] args) throws IOException, Exception {
      <span style="color:#c792ea;font-style:italic;">final</span> Random rand = new Random();
      SharedCounterDemo example = new SharedCounterDemo();
      try (TestingServer server = new TestingServer()) {
         CuratorFramework client = CuratorFrameworkFactory.newClient(server.getConnectString(), new ExponentialBackoffRetry(1000, 3));
         client.start();

         SharedCount baseCount = new SharedCount(client, PATH, 0);
         baseCount.addListener(example);
         baseCount.start();

         List<SharedCount> examples = Lists.newArrayList();
         ExecutorService service = Executors.newFixedThreadPool(QTY);
         for (int i = 0; i < QTY; ++i) {
            <span style="color:#c792ea;font-style:italic;">final</span> SharedCount count = new SharedCount(client, PATH, 0);
            examples.add(count);
            Callable<Void> task = () -> {
               count.start();
               Thread.sleep(rand.nextInt(10000));
               System.out.println("Increment:" + count.trySetCount(count.getVersionedValue(), count.getCount() + rand.nextInt(10)));
               return null;
            };
            service.submit(task);
         }

         service.shutdown();
         service.awaitTermination(10, TimeUnit.MINUTES);

         for (int i = 0; i < QTY; ++i) {
            examples.get(i).close();
         }
         baseCount.close();
      }
      Thread.sleep(Integer.MAX_VALUE);
   }

   @Override
   <span style="color:#c792ea;font-style:italic;">public</span> void stateChanged(CuratorFramework arg0, ConnectionState arg1) {
      System.out.println("State changed: " + arg1.toString());
   }

   @Override
   <span style="color:#c792ea;font-style:italic;">public</span> void countHasChanged(SharedCountReader sharedCount, int newCount) throws Exception {
      System.out.println("Counter's value is changed to " + newCount);
   }
}

在这个例子中，我们使用 baseCount 来监听计数值(addListener 方法来添加 SharedCountListener )。 任意的 SharedCount， 只要使用相同的 path，都可以得到这个计数值。 然后我们使用 5 个线程为计数值增加一个 10 以内的随机数。相同的 path 的 SharedCount 对计数值进行更改，将会回调给 baseCount 的 SharedCountListener。

count.trySetCount(count.getVersionedValue(), count.getCount() + rand.nextInt(10))

这里我们使用 trySetCount 去设置计数器。 第一个参数提供当前的 VersionedValue,如果期间其它 client 更新了此计数值， 你的更新可能不成功， 但是这时你的 client 更新了最新的值，所以失败了你可以尝试再更新一次。 而 setCount 是强制更新计数器的值。

注意计数器必须 start,使用完之后必须调用 close 关闭它。

强烈推荐使用 ConnectionStateListener。 在本例中 SharedCountListener 扩展 ConnectionStateListener。

分布式 long 计数器—DistributedAtomicLong

再看一个 Long 类型的计数器。 除了计数的范围比 SharedCount 大了之外， 它首先尝试使用乐观锁的方式设置计数器， 如果不成功(比如期间计数器已经被其它 client 更新了)， 它使用 InterProcessMutex 方式来更新计数值。

可以从它的内部实现 DistributedAtomicValue.trySet() 中看出：

   AtomicValue<byte[]>   trySet(MakeValue makeValue) throws Exception
    {
        MutableAtomicValue<byte[]>  result = new MutableAtomicValue<byte[]>(null, null, false);

        tryOptimistic(result, makeValue);
        if ( !result.succeeded() && (mutex != null) )
        {
            tryWithMutex(result, makeValue);
        }

        return result;
    }

此计数器有一系列的操作：

• get(): 获取当前值
• increment()： 加一
• decrement(): 减一
• add()： 增加特定的值
• subtract(): 减去特定的值
• trySet(): 尝试设置计数值
• forceSet(): 强制设置计数值

你必须检查返回结果的 succeeded()， 它代表此操作是否成功。 如果操作成功， preValue() 代表操作前的值， postValue() 代表操作后的值。

<span style="color:#c792ea;font-style:italic;">public</span> class DistributedAtomicLongDemo {

   <span style="color:#c792ea;font-style:italic;">private static final</span> int QTY = 5;
   <span style="color:#c792ea;font-style:italic;">private static final</span> String PATH = "/examples/counter";

   <span style="color:#c792ea;font-style:italic;">public static</span> void main(String[] args) throws IOException, Exception {
      List<DistributedAtomicLong> examples = Lists.newArrayList();
      try (TestingServer server = new TestingServer()) {
         CuratorFramework client = CuratorFrameworkFactory.newClient(server.getConnectString(), new ExponentialBackoffRetry(1000, 3));
         client.start();
         ExecutorService service = Executors.newFixedThreadPool(QTY);
         for (int i = 0; i < QTY; ++i) {
            <span style="color:#c792ea;font-style:italic;">final</span> DistributedAtomicLong count = new DistributedAtomicLong(client, PATH, new RetryNTimes(10, 10));

            examples.add(count);
            Callable<Void> task = () -> {
               try {
                  AtomicValue<Long> value = count.increment();
                  System.out.println("succeed: " + value.succeeded());
                  if (value.succeeded())
                     System.out.println("Increment: from " + value.preValue() + " to " + value.postValue());
               } catch (Exception e) {
                  e.printStackTrace();
               }
               return null;
            };
            service.submit(task);
         }

         service.shutdown();
         service.awaitTermination(10, TimeUnit.MINUTES);
         Thread.sleep(Integer.MAX_VALUE);
      }
   }
}

分布式队列

使用 Curator 也可以简化 Ephemeral Node (临时节点)的操作。Curator 也提供 ZK Recipe 的分布式队列实现。 利用 ZK 的 PERSISTENTS_EQUENTIAL 节点， 可以保证放入到队列中的项目是按照顺序排队的。 如果单一的消费者从队列中取数据， 那么它是先入先出的，这也是队列的特点。 如果你严格要求顺序，你就的使用单一的消费者，可以使用 Leader 选举只让 Leader 作为唯一的消费者。

但是， 根据 Netflix 的 Curator 作者所说， ZooKeeper 真心不适合做 Queue，或者说 ZK 没有实现一个好的 Queue，详细内容可以看 Tech Note 4， 原因有五：

1. ZK 有 1MB 的传输限制。 实践中 ZNode 必须相对较小，而队列包含成千上万的消息，非常的大。
2. 如果有很多节点，ZK 启动时相当的慢。 而使用 queue 会导致好多 ZNode. 你需要显著增大 initLimit 和 syncLimit.
3. ZNode 很大的时候很难清理。Netflix 不得不创建了一个专门的程序做这事。
4. 当很大量的包含成千上万的子节点的 ZNode 时， ZK 的性能变得不好
5. ZK 的数据库完全放在内存中。 大量的 Queue 意味着会占用很多的内存空间。

尽管如此， Curator 还是创建了各种 Queue 的实现。 如果 Queue 的数据量不太多，数据量不太大的情况下，酌情考虑，还是可以使用的。

分布式队列—DistributedQueue

DistributedQueue 是最普通的一种队列。 它设计以下四个类：

• QueueBuilder - 创建队列使用 QueueBuilder,它也是其它队列的创建类
• QueueConsumer - 队列中的消息消费者接口
• QueueSerializer - 队列消息序列化和反序列化接口，提供了对队列中的对象的序列化和反序列化
• DistributedQueue - 队列实现类

QueueConsumer 是消费者，它可以接收队列的数据。处理队列中的数据的代码逻辑可以放在 QueueConsumer.consumeMessage()中。

正常情况下先将消息从队列中移除，再交给消费者消费。但这是两个步骤，不是原子的。可以调用 Builder 的 lockPath()消费者加锁，当消费者消费数据时持有锁，这样其它消费者不能消费此消息。如果消费失败或者进程死掉，消息可以交给其它进程。这会带来一点性能的损失。最好还是单消费者模式使用队列。

<span style="color:#c792ea;font-style:italic;">public</span> class DistributedQueueDemo {

   <span style="color:#c792ea;font-style:italic;">private static final</span> String PATH = "/example/queue";

   <span style="color:#c792ea;font-style:italic;">public static</span> void main(String[] args) throws Exception {
      TestingServer server = new TestingServer();
      CuratorFramework clientA = CuratorFrameworkFactory.newClient(server.getConnectString(), new ExponentialBackoffRetry(1000, 3));
      clientA.start();
      CuratorFramework clientB = CuratorFrameworkFactory.newClient(server.getConnectString(), new ExponentialBackoffRetry(1000, 3));
      clientB.start();
      DistributedQueue<String> queueA;
      QueueBuilder<String> builderA = QueueBuilder.builder(clientA, createQueueConsumer("A"), createQueueSerializer(), PATH);
      queueA = builderA.buildQueue();
      queueA.start();

      DistributedQueue<String> queueB;
      QueueBuilder<String> builderB = QueueBuilder.builder(clientB, createQueueConsumer("B"), createQueueSerializer(), PATH);
      queueB = builderB.buildQueue();
      queueB.start();
      for (int i = 0; i < 100; i++) {
         queueA.put(" test-A-" + i);
         Thread.sleep(10);
         queueB.put(" test-B-" + i);
      }
      Thread.sleep(1000 * 10);// <span style="font-family:'AR PL UKai HK';">等待消息消费完成
</span>      queueB.close();
      queueA.close();
      clientB.close();
      clientA.close();
      System.out.println("OK!");
   }

   /**
    * <span style="font-family:'AR PL UKai HK';">队列消息序列化实现类
</span>    */
   <span style="color:#c792ea;font-style:italic;">private static</span> QueueSerializer<String> createQueueSerializer() {
      return new QueueSerializer<String>() {
         @Override
         <span style="color:#c792ea;font-style:italic;">public</span> byte[] serialize(String item) {
            return item.getBytes();
         }

         @Override
         <span style="color:#c792ea;font-style:italic;">public</span> String deserialize(byte[] bytes) {
            return new String(bytes);
         }
      };
   }

   /**
    * <span style="font-family:'AR PL UKai HK';">定义队列消费者
</span>    */
   <span style="color:#c792ea;font-style:italic;">private static</span> QueueConsumer<String> createQueueConsumer(<span style="color:#c792ea;font-style:italic;">final</span> String name) {
      return new QueueConsumer<String>() {
         @Override
         <span style="color:#c792ea;font-style:italic;">public</span> void stateChanged(CuratorFramework client, ConnectionState newState) {
            System.out.println("<span style="font-family:'AR PL UKai HK';">连接状态改变</span>: " + newState.name());
         }

         @Override
         <span style="color:#c792ea;font-style:italic;">public</span> void consumeMessage(String message) throws Exception {
            System.out.println("<span style="font-family:'AR PL UKai HK';">消费消息</span>(" + name + "): " + message);
         }
      };
   }
}