12.Curator扩展库

Recipes组件包含了丰富的Curator应用的组件。但是这些并不是ZooKeeper Recipe的全部。大量的分布式应用已经抽象出了许许多多的的Recipe，其中有些还是可以通过Curator来实现。

如果不断都将这些Recipe都增加到Recipes中，Recipes会变得越来越大。为了避免这种状况，Curator把一些其它的Recipe放在单独的包中，命名方式就是curator-x-,比如curator-x-discovery， curator-x-rpc。本文就是主要介绍curator-x-discovery。

1.curator-x-discovery介绍

curator-x-discovery是一个服务发现的解决方案。我们在介绍临时节点Ephemeral Node的时候就讲到，可以通过临时节点创建一个服务注册机制。服务启动后创建临时节点，服务断掉后临时节点就不存在了。这个扩展抽象了这种功能，通过一套API,可以实现服务发现机制。具体示例参考官网：http://curator.apache.org/curator-x-discovery/index.html

1.ServiceInstance类

ServiceInstance是一个服务实例所代表的类。ServiceInstances有名称、id、地址、端口和/或ssl端口,和一个可选的payload属性(用户定义的)。 ServiceInstances序列化并存储在Zookeeper中的方式如下：

base path
       |_______ service A name
                    |__________ instance 1 id --> (serialized ServiceInstance)
                    |__________ instance 2 id --> (serialized ServiceInstance)
                    |__________ ...
       |_______ service B name
                    |__________ instance 1 id --> (serialized ServiceInstance)
                    |__________ instance 2 id --> (serialized ServiceInstance)
                    |__________ ...
       |_______ ...

ServiceInstances类的成员如下图：

2.ServiceProvider类

ServiceProvider是主要的抽象类。它封装了发现服务为特定的命名服务和提供者策略。提供者策略方案选择一个实例从一组给定的服务实例。有三个捆绑策略:轮询调度、随机和粘性(总是选择相同的一个)。

serviceprovider分配使用ServiceProviderBuilder。你获得一个ServiceProviderBuilder ServiceDiscovery(见下文)。 ServiceProviderBuilder允许您设置服务名称和其他几个可选值。

ServiceProvider开始必须调用start()方法。当使用完成应该调用close()方法。ServiceProvider接口有以下两个重要的方法:

/**
 * Return an instance for a single use. <b>IMPORTANT: </b> users
 * should not hold on to the instance returned. They should always get a fresh instance.
 *
 * @return the instance to use
 * @throws Exception any errors
 */
public ServiceInstance<T> getInstance() throws Exception;

/**
 * Return the current available set of instances <b>IMPORTANT: </b> users
 * should not hold on to the instance returned. They should always get a fresh list.
 *
 * @return all known instances
 * @throws Exception any errors
 */
public Collection<ServiceInstance<T>> getAllInstances() throws Exception;

getInstance()方法用于获取服务实例。getAllInstances()方法获取所有的服务实例。以下是ServiceProvider接口的所有成员。

3.ServiceDiscovery类

为了创建ServiceProvider,你必须有一个ServiceDiscovery。它是由一个ServiceDiscoveryBuilder创建。开始必须调用start()方法。当使用完成应该调用close()方法。

实例的稳定性：如果一个特定的实例有一个错误(如：I/O错误),你应该调用ServiceProvider.noteError()。该ServiceProvider将暂时认为有错误的情况下，确定为“down”的实例。The thresholds and timeouts for down instances are set via the DownInstancePolicy which can be passed to ServiceProviderBuilder (note: a default DownInstancePolicy is used if you don‘t specify one).

2.低级别的API介绍

ServiceProvider API都是你应该给最需要的目的。然而,对于更细粒度的控制,您可以使用这些方法:

1.服务注册/取消注册

通常,您将您的应用程序的服务描述符传递给ServiceDiscovery构造函数,它会自动注册/注销。不过,如果您需要手动做这个,使用这些方法:

/**
 * Register/re-register a service 注册服务
 *
 * @param service service to add
 * @throws Exception errors
 */
public void     registerService(ServiceInstance<T> service) throws Exception;

/**
 * Unregister/remove a service instance 取消注册服务
 *
 * @param service the service
 * @throws Exception errors
 */
public void     unregisterService(ServiceInstance<T> service) throws Exception;

2.查询服务

您可以查询服务名称,特定服务的所有实例,或单一的服务实例。

/**
 * Return the names of all known services
 *
 * @return list of service names
 * @throws Exception errors
 */
public Collection<String> queryForNames() throws Exception;

/**
 * Return all known instances for the given service
 *
 * @param name name of the service
 * @return list of instances (or an empty list)
 * @throws Exception errors
 */
public Collection<ServiceInstance<T>>  queryForInstances(String name) throws Exception;

/**
 * Return a service instance POJO
 *
 * @param name name of the service
 * @param id ID of the instance
 * @return the instance or <code>null</code> if not found
 * @throws Exception errors
 */
public ServiceInstance<T> queryForInstance(String name, String id) throws Exception;

3.服务缓存

上面的查询方法直接调用Zookeeper。 如果你需要经常查询的服务可以使用ServiceCache。它在内存中缓存实例的列表为特定的服务。它使用一个观察者保持最新的列表。

你创建一个ServiceCache通过调用ServiceDiscovery.serviceCacheBuilder()方法。ServiceCache对象开始必须调用start()方法。当使用完成应该调用close()方法。你可以得到当前已知的实例列表服务通过调用:

/**
 * Return the current list of instances. NOTE: there is no guarantee of freshness. This is
 * merely the last known list of instances. However, the list is updated via a ZooKeeper watcher
 * so it should be fresh within a window of a second or two.
 *
 * @return the list
 */
public List<ServiceInstance<T>> getInstances();

ServiceCache支持得到通知的侦听器,当观察者更新实例的列表(需要增加监听ServiceCacheListener):

/**
 * Listener for changes to a service cache
 */
public interface ServiceCacheListener extends ConnectionStateListener
{
    /**
     * Called when the cache has changed (instances added/deleted, etc.)
     */
    public void cacheChanged();
}

3.curator-x-discovery使用实例

1.定义服务基本信息的类

2.服务类

3.发现中心

4.测试结果及其分析

4.其他扩展介绍

其它两个扩展Curator RPC Proxy（curator-x-rpc）扩展和Service Discovery Server（curator-x-discovery-server）是为了桥接非Java应用的扩展，本系列将不再介绍了。感兴趣的朋友可以看下面的文档。

Curator Service Discovery ：http://curator.apache.org/curator-x-discovery-server/index.html

Curator RPC Proxy ：http://curator.apache.org/curator-x-rpc/index.html

-------------------------------------------------------------------------------------------------------------------------------

来自为知笔记(Wiz)