目录



​​回到顶部​​


简介

Curator是Netflix公司开源的一套Zookeeper客户端框架。了解过Zookeeper原生API都会清楚其复杂度。Curator帮助我们在其基础上进行封装、实现一些开发细节，包括接连重连、反复注册Watcher和NodeExistsException等。目前已经作为Apache的顶级项目出现，是最流行的Zookeeper客户端之一。从编码风格上来讲，它提供了基于Fluent的编程风格支持。

除此之外，Curator还提供了Zookeeper的各种应用场景：Recipe、共享锁服务、Master选举机制和分布式计数器等。 

Zookeeper框架Curator使用_ZooKeeper

具体信息可以参考Apache官网提供的关于​​Curator​​的资料信息


​​回到顶部​​


版本

目前Curator有2.x.x和3.x.x两个系列的版本，支持不同版本的Zookeeper。其中Curator 2.x.x兼容Zookeeper的3.4.x和3.5.x。而Curator 3.x.x只兼容Zookeeper 3.5.x，并且提供了一些诸如动态重新配置、watch删除等新特性。


​​回到顶部​​


项目组件

名称

描述

Recipes

Zookeeper典型应用场景的实现，这些实现是基于Curator Framework。

Framework

Zookeeper API的高层封装，大大简化Zookeeper客户端编程，添加了例如Zookeeper连接管理、重试机制等。

Utilities

为Zookeeper提供的各种实用程序。

Client

Zookeeper client的封装，用于取代原生的Zookeeper客户端（ZooKeeper类），提供一些非常有用的客户端特性。

Errors

Curator如何处理错误，连接问题，可恢复的例外等。

​​回到顶部​​


Maven依赖

Curator的jar包已经发布到Maven中心，由以下几个artifact的组成。根据需要选择引入具体的artifact。但大多数情况下只用引入curator-recipes即可。

 

GroupID/Org

ArtifactID/Name

描述

org.apache.curator

curator-recipes

所有典型应用场景。需要依赖client和framework，需设置自动获取依赖。

org.apache.curator

curator-framework

同组件中framework介绍。

org.apache.curator

curator-client

同组件中client介绍。

org.apache.curator

curator-test

包含TestingServer、TestingCluster和一些测试工具。

org.apache.curator

curator-examples

各种使用Curator特性的案例。

org.apache.curator

curator-x-discovery

在framework上构建的服务发现实现。

org.apache.curator

curator-x-discoveryserver

可以喝Curator Discovery一起使用的RESTful服务器。

org.apache.curator

curator-x-rpc

Curator framework和recipes非java环境的桥接。

 

根据上面的描述，开发人员大多数情况下使用的都是curator-recipes的依赖，此依赖的maven配置如下：



Zookeeper框架Curator使用_JDK_02

<!-- https://mvnrepository.com/artifact/org.apache.curator/curator-recipes -->
<dependency>
    <groupId>org.apache.curator</groupId>
    <artifactId>curator-recipes</artifactId>
    <version>2.12.0</version>
</dependency>


Zookeeper框架Curator使用_分布式_03


由于版本兼容原因，采用了2.x.x的最高版本。


​​回到顶部​​


案例及功能说明


创建会话

Curator的创建会话方式与原生的API和ZkClient的创建方式区别很大。Curator创建客户端是通过CuratorFrameworkFactory工厂类来实现的。其中，此工厂类提供了三种创建客户端的方法。 

前两种方法是通过newClient来实现，仅参数不同而已。



public static CuratorFramework newClient(String connectString, RetryPolicy retryPolicy)

public static CuratorFramework newClient(String connectString, int sessionTimeoutMs, int connectionTimeoutMs, RetryPolicy retryPolicy)


使用上面方法创建出一个CuratorFramework之后，需要再调用其start()方法完成会话创建。 

实例代码：



RetryPolicy retryPolicy = new ExponentialBackoffRetry(1000,3);
CuratorFramework client = CuratorFrameworkFactory.newClient("127.0.0.1:2181",retryPolicy);
client.start();



RetryPolicy retryPolicy = new ExponentialBackoffRetry(1000,3);
CuratorFramework client = CuratorFrameworkFactory.newClient("127.0.0.1:2181",
                5000,1000,retryPolicy);
client.start();


其中参数RetryPolicy提供重试策略的接口，可以让用户实现自定义的重试策略。默认提供了以下实现，分别为ExponentialBackoffRetry、BoundedExponentialBackoffRetry、RetryForever、RetryNTimes、RetryOneTime、RetryUntilElapsed。

进一步查看源代码可以得知，其实这两种方法内部实现一样，只是对外包装成不同的方法。它们的底层都是通过第三个方法builder来实现的。 

实例代码：



Zookeeper框架Curator使用_java经验集锦_04

RetryPolicy retryPolicy  = new ExponentialBackoffRetry(1000,3);
private static CuratorFramework Client = CuratorFrameworkFactory.builder()
            .connectString("hadoop1:2181,hadoop2:2181,hadoop3:2181")
            .sessionTimeoutMs(3000)
            .connectionTimeoutMs(5000)
            .retryPolicy(retryPolicy)
            .build();
client.start();


Zookeeper框架Curator使用_分布式_05


参数：

  • connectString：zk的server地址，多个server之间使用英文逗号分隔开
  • connectionTimeoutMs：连接超时时间，如上是30s，默认是15s
  • sessionTimeoutMs：会话超时时间，如上是50s，默认是60s
  • retryPolicy：失败重试策略
  • ExponentialBackoffRetry：构造器含有三个参数 ExponentialBackoffRetry(int baseSleepTimeMs, int maxRetries, int maxSleepMs)
  • baseSleepTimeMs：初始的sleep时间，用于计算之后的每次重试的sleep时间，
  • 计算公式：当前sleep时间=baseSleepTimeMs*Math.max(1, random.nextInt(1<<(retryCount+1)))
  • maxRetries：最大重试次数
  • maxSleepMs：最大sleep时间，如果上述的当前sleep计算出来比这个大，那么sleep用这个时间
  • 其他，查看org.apache.curator.RetryPolicy接口的实现类
  • start()会阻塞到会话创建成功为止。

重试策略

上面的例子中使用到了ExponentialBackoffRetry重试策略实现。此策略先给定一个初始化sleep时间baseSleepTimeMs，在此基础上结合重试次数，通过以下代码计算当前需要的sleep时间：



long sleepMs = baseSleepTimeMs * Math.max(1, random.nextInt(1 << (retryCount + 1)));
if ( sleepMs > maxSleepMs ){
            sleepMs = maxSleepMs;
 }


随着重试次数的增加，计算出的sleep时间也会越来越大。如果超过maxSleepMs则使用maxSleepMs的时间。其中maxRetries限制了最大的尝试次数。


创建节点

Curator创建节点的方法也是基于Fluent风格编码，原生API中的参数很多都转化为一层层的方法调用来进行设置。下面简单介绍一下常用的几个节点创建场景。 

（1）创建一个初始内容为空的节点



client.create().forPath(path);


Curator默认创建的是持久节点，内容为空。 

（2）创建一个包含内容的节点



client.create().forPath(path,"我是内容".getBytes());


Curator和ZkClient不同的是依旧采用Zookeeper原生API的风格，内容使用byte[]作为方法参数。 

（3）创建临时节点，并递归创建父节点



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


此处Curator和ZkClient一样封装了递归创建父节点的方法。在递归创建父节点时，父节点为持久节点。


删除节点

删除节点的方法也是基于Fluent方式来进行操作，不同类型的操作调用新增不同的方法调用即可。 

（1）删除一个子节点



client.delete().forPath(path);


（2）删除节点并递归删除其子节点



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


（3）指定版本进行删除



client.delete().withVersion(1).forPath(path);


如果此版本已经不存在，则删除异常，异常信息如下。



org.apache.zookeeper.KeeperException$BadVersionException: KeeperErrorCode = BadVersion for


（4）强制保证删除一个节点



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


只要客户端会话有效，那么Curator会在后台持续进行删除操作，直到节点删除成功。比如遇到一些网络异常的情况，此guaranteed的强制删除就会很有效果。


读取数据

读取节点数据内容API相当简单，Curator提供了传入一个Stat，使用节点当前的Stat替换到传入的Stat的方法，查询方法执行完成之后，Stat引用已经执行当前最新的节点Stat。



// 普通查询
client.getData().forPath(path);
// 包含状态查询
Stat stat = new Stat();
client.getData().storingStatIn(stat()).forPath(path);


更新数据

更新数据，如果未传入version参数，那么更新当前最新版本，如果传入version则更新指定version，如果version已经变更，则抛出异常。



// 普通更新
client.setData().forPath(path,"新内容".getBytes());
// 指定版本更新
client.setData().withVersion(1).forPath(path);


版本不一直异常信息：



org.apache.zookeeper.KeeperException$BadVersionException: KeeperErrorCode = BadVersion for


异步接口

在使用以上针对节点的操作API时，我们会发现每个接口都有一个inBackground()方法可供调用。此接口就是Curator提供的异步调用入口。对应的异步处理接口为BackgroundCallback。此接口指提供了一个processResult的方法，用来处理回调结果。其中processResult的参数event中的getType()包含了各种事件类型，getResultCode()包含了各种响应码。

重点说一下inBackground的以下接口：



public T inBackground(BackgroundCallback callback, Executor executor);


此接口就允许传入一个Executor实例，用一个专门线程池来处理返回结果之后的业务逻辑。


完整代码



Zookeeper框架Curator使用_ZooKeeper_06

import org.apache.curator.RetryPolicy;
import org.apache.curator.framework.CuratorFramework;
import org.apache.curator.framework.CuratorFrameworkFactory;
import org.apache.curator.framework.api.BackgroundCallback;
import org.apache.curator.framework.api.CuratorEvent;
import org.apache.curator.retry.ExponentialBackoffRetry;
import org.apache.zookeeper.CreateMode;
import org.apache.zookeeper.data.Stat;
import java.util.concurrent.Executors;

public class CuratorTest {

</span><span style="color: #0000ff;">private</span> <span style="color: #0000ff;">static</span> RetryPolicy retryPolicy  = <span style="color: #0000ff;">new</span> ExponentialBackoffRetry(1000,3<span style="color: #000000;">);
</span><span style="color: #0000ff;">private</span> <span style="color: #0000ff;">static</span> CuratorFramework client =<span style="color: #000000;"> CuratorFrameworkFactory.builder()
        .connectString(</span>"hadoop1:2181,hadoop2:2181,hadoop3:2181"<span style="color: #000000;">)
        .sessionTimeoutMs(</span>3000<span style="color: #000000;">)
        .connectionTimeoutMs(</span>5000<span style="color: #000000;">)
        .retryPolicy(retryPolicy)
        .build();

</span><span style="color: #0000ff;">public</span> <span style="color: #0000ff;">static</span> <span style="color: #0000ff;">void</span> main(String[] args) <span style="color: #0000ff;">throws</span><span style="color: #000000;"> Exception{
    </span><span style="color: #008000;">/**</span><span style="color: #008000;">
     * 创建会话
     * </span><span style="color: #008000;">*/</span><span style="color: #000000;">
    client.start();

    </span><span style="color: #008000;">/**</span><span style="color: #008000;">
     * 同步创建节点
     * 注意：
     *      1.除非指明创建节点的类型,默认是持久节点
     *      2.ZooKeeper规定:所有非叶子节点都是持久节点,所以递归创建出来的节点,
     *          只有最后的数据节点才是指定类型的节点,其父节点是持久节点
     * </span><span style="color: #008000;">*/</span>

    <span style="color: #008000;">//</span><span style="color: #008000;">创建一个初始内容为空的节点</span>
    client.create().forPath("/China"<span style="color: #000000;">);
    </span><span style="color: #008000;">//</span><span style="color: #008000;">创建一个初始内容不为空的节点</span>
    client.create().forPath("/Korea","jinzhengen"<span style="color: #000000;">.getBytes());
    </span><span style="color: #008000;">//</span><span style="color: #008000;">创建一个初始内容为空的临时节点</span>
    client.create().withMode(CreateMode.EPHEMERAL).forPath("America"<span style="color: #000000;">);
    </span><span style="color: #008000;">//</span><span style="color: #008000;">创建一个初始内容不为空的临时节点，可以实现递归创建</span>


client.create().creatingParentsIfNeeded().withMode(CreateMode.EPHEMERAL)

.forPath("Japan","xiaoriben".getBytes());

    </span><span style="color: #008000;">/**</span><span style="color: #008000;">
     *  异步创建节点
     *
     * 注意:如果自己指定了线程池,那么相应的操作就会在线程池中执行,如果没有指定,
     *   那么就会使用Zookeeper的EventThread线程对事件进行串行处理
     * </span><span style="color: #008000;">*/</span><span style="color: #000000;">
    client.create().withMode(CreateMode.EPHEMERAL).inBackground(</span><span style="color: #0000ff;">new</span><span style="color: #000000;"> BackgroundCallback() {
        </span><span style="color: #0000ff;">public</span> <span style="color: #0000ff;">void</span> processResult(CuratorFramework client, CuratorEvent event) <span style="color: #0000ff;">throws</span><span style="color: #000000;"> Exception {
            System.out.println(</span>"当前线程：" + Thread.currentThread().getName() + ",code:"
            + event.getResultCode() + ",type:" +<span style="color: #000000;"> event.getType());
        }
    },Executors.newFixedThreadPool(</span>10)).forPath("/async-China"<span style="color: #000000;">);


    client.create().withMode(CreateMode.EPHEMERAL).inBackground(</span><span style="color: #0000ff;">new</span><span style="color: #000000;"> BackgroundCallback() {
        </span><span style="color: #0000ff;">public</span> <span style="color: #0000ff;">void</span> processResult(CuratorFramework client, CuratorEvent event) <span style="color: #0000ff;">throws</span><span style="color: #000000;"> Exception {
            System.out.println(</span>"当前线程：" + Thread.currentThread().getName() + ",code:"
                    + event.getResultCode() + ",type:" +<span style="color: #000000;"> event.getType());
        }
    }).forPath(</span>"/async-America"<span style="color: #000000;">);

    </span><span style="color: #008000;">/**</span><span style="color: #008000;">
     * 获取节点内容
     * </span><span style="color: #008000;">*/</span>
    <span style="color: #0000ff;">byte</span>[] data = client.getData().forPath("/Korea"<span style="color: #000000;">);
    System.out.println(</span><span style="color: #0000ff;">new</span><span style="color: #000000;"> String(data));
    </span><span style="color: #008000;">//</span><span style="color: #008000;">传入一个旧的stat变量,来存储服务端返回的最新的节点状态信息</span>
    <span style="color: #0000ff;">byte</span>[] data2 = client.getData().storingStatIn(<span style="color: #0000ff;">new</span> Stat()).forPath("/Korea"<span style="color: #000000;">);
    System.out.println(</span><span style="color: #0000ff;">new</span><span style="color: #000000;"> String(data2));

    </span><span style="color: #008000;">/**</span><span style="color: #008000;">
     * 更新数据
     * </span><span style="color: #008000;">*/</span><span style="color: #000000;">
    Stat stat </span>= client.setData().forPath("/Korea"<span style="color: #000000;">);
    client.setData().withVersion(</span>4).forPath("/Korea", "jinsanpangzi"<span style="color: #000000;">.getBytes());

    </span><span style="color: #008000;">/**</span><span style="color: #008000;">
     * 删除节点
     * </span><span style="color: #008000;">*/</span>
    <span style="color: #008000;">//</span><span style="color: #008000;">只能删除叶子节点</span>
    client.delete().forPath("/China"<span style="color: #000000;">);
    </span><span style="color: #008000;">//</span><span style="color: #008000;">删除一个节点,并递归删除其所有子节点</span>
    client.delete().deletingChildrenIfNeeded().forPath("/aa"<span style="color: #000000;">);
    </span><span style="color: #008000;">//</span><span style="color: #008000;">强制指定版本进行删除</span>
    client.delete().withVersion(4).forPath("/Korea"<span style="color: #000000;">);
    </span><span style="color: #008000;">//</span><span style="color: #008000;">注意:由于一些网络原因,上述的删除操作有可能失败,使用guaranteed(),
    </span><span style="color: #008000;">//</span><span style="color: #008000;"> 如果删除失败,会记录下来,只要会话有效,就会不断的重试,直到删除成功为止</span>
    client.delete().guaranteed().forPath("/America"<span style="color: #000000;">);
    
    
    Thread.sleep(Integer.MAX_VALUE);


}


}


Zookeeper框架Curator使用_通用实践_07