com.alipay.sofa.rpc.registry.zk

类 ZookeeperRegistry

java.lang.Object

com.alipay.sofa.rpc.registry.Registry

com.alipay.sofa.rpc.registry.zk.ZookeeperRegistry

所有已实现的接口:

Destroyable, Initializable

@Extension(value="zookeeper")
public class ZookeeperRegistry
extends Registry

简单的Zookeeper注册中心,具有如下特性：
1.可以设置优先读取远程，还是优先读取本地备份文件
2.如果zk不可用，自动读取本地备份文件
3.可以设置使用临时节点还是永久节点
4.断线了会自动重连，并且自动recover数据

  在zookeeper上存放的数据结构为：
  -$rootPath (根路径)
         └--sofa-rpc
             |--com.alipay.sofa.rpc.example.HelloService （服务）
             |       |-providers （服务提供者列表）
             |       |     |--bolt://192.168.1.100:22000?xxx=yyy [1]
             |       |     |--bolt://192.168.1.110:22000?xxx=yyy [1]
             |       |     └--bolt://192.168.1.120?xxx=yyy [1]
             |       |-consumers （服务调用者列表）
             |       |     |--bolt://192.168.3.100?xxx=yyy []
             |       |     |--bolt://192.168.3.110?xxx=yyy []
             |       |     └--bolt://192.168.3.120?xxx=yyy []
             |       |-configs （接口级配置）
             |       |     |--invoke.blacklist ["xxxx"]
             |       |     └--monitor.open ["true"]
             |       └overrides （IP级配置）
             |       |     └--bolt://192.168.3.100?xxx=yyy []
             |--com.alipay.sofa.rpc.example.EchoService （下一个服务）
             | ......
  

嵌套类概要

从接口继承的嵌套类/接口 com.alipay.sofa.rpc.base.Destroyable

Destroyable.DestroyHook

字段概要

字段

限定符和类型	字段和说明
static String	PARAM_CREATE_EPHEMERAL 配置项：是否使用临时节点。
static String	PARAM_PREFER_LOCAL_FILE 配置项：是否本地优先

从类继承的字段 com.alipay.sofa.rpc.registry.Registry

registryConfig

构造器概要

构造器

限定符	构造器和说明
protected	ZookeeperRegistry(RegistryConfig registryConfig) 注册中心配置

方法概要

方法

限定符和类型	方法和说明
void	batchUnRegister(List<ProviderConfig> configs) 反注册服务提供者
void	batchUnSubscribe(List<ConsumerConfig> configs) 反订阅服务调用者相关配置
void	destroy() 销毁接口
void	destroy(Destroyable.DestroyHook hook) Do destroy with hook.
protected org.apache.curator.framework.CuratorFramework	getZkClient()
void	init() 初始化
void	register(ProviderConfig config) 注册服务提供者
boolean	start() 启动
List<ProviderGroup>	subscribe(ConsumerConfig config) 订阅服务列表
protected void	subscribeConfig(AbstractInterfaceConfig config, ConfigListener listener) 订阅接口级配置
protected void	subscribeOverride(ConsumerConfig config, ConfigListener listener) 订阅IP级配置（服务发布暂时不支持动态配置,暂时支持订阅ConsumerConfig参数设置）
void	unRegister(ProviderConfig config) 反注册服务提供者
void	unSubscribe(ConsumerConfig config) 反订阅服务调用者相关配置

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

PARAM_PREFER_LOCAL_FILE

public static final String PARAM_PREFER_LOCAL_FILE

配置项：是否本地优先

另请参阅:

常量字段值

PARAM_CREATE_EPHEMERAL

public static final String PARAM_CREATE_EPHEMERAL

配置项：是否使用临时节点。
如果使用临时节点：那么断开连接的时候，将zookeeper将自动消失。好处是如果服务端异常关闭，也不会有垃圾数据。
坏处是如果和zookeeper的网络闪断也通知客户端，客户端以为是服务端下线
如果使用永久节点：好处：网络闪断时不会影响服务端，而是由客户端进行自己判断长连接
坏处：服务端如果是异常关闭（无反注册），那么数据里就由垃圾节点，得由另外的哨兵程序进行判断

另请参阅:

常量字段值

构造器详细资料

ZookeeperRegistry

protected ZookeeperRegistry(RegistryConfig registryConfig)

注册中心配置

参数:

registryConfig - 注册中心配置

方法详细资料

init

public void init()

从接口复制的说明: Initializable

初始化

start

public boolean start()

从类复制的说明: Registry

启动

指定者:

start 在类中 Registry

返回:

is started

destroy

public void destroy()

从接口复制的说明: Destroyable

销毁接口

destroy

public void destroy(Destroyable.DestroyHook hook)

从接口复制的说明: Destroyable

Do destroy with hook.

指定者:

destroy 在接口中 Destroyable

覆盖:

destroy 在类中 Registry

参数:

hook - DestroyHook

register

public void register(ProviderConfig config)

从类复制的说明: Registry

注册服务提供者

指定者:

register 在类中 Registry

参数:

config - Provider配置

subscribeConfig

protected void subscribeConfig(AbstractInterfaceConfig config,
                   ConfigListener listener)

订阅接口级配置

参数:

config - provider/consumer config

listener - config listener

subscribeOverride

protected void subscribeOverride(ConsumerConfig config,
                     ConfigListener listener)

订阅IP级配置（服务发布暂时不支持动态配置,暂时支持订阅ConsumerConfig参数设置）

参数:

config - consumer config

listener - config listener

unRegister

public void unRegister(ProviderConfig config)

从类复制的说明: Registry

反注册服务提供者

指定者:

unRegister 在类中 Registry

参数:

config - Provider配置

batchUnRegister

public void batchUnRegister(List<ProviderConfig> configs)

从类复制的说明: Registry

反注册服务提供者

指定者:

batchUnRegister 在类中 Registry

参数:

configs - Provider配置

subscribe

public List<ProviderGroup> subscribe(ConsumerConfig config)

从类复制的说明: Registry

订阅服务列表

指定者:

subscribe 在类中 Registry

参数:

config - Consumer配置

返回:

当前Provider列表，返回null表示未同步获取到地址

unSubscribe

public void unSubscribe(ConsumerConfig config)

从类复制的说明: Registry

反订阅服务调用者相关配置

指定者:

unSubscribe 在类中 Registry

参数:

config - Consumer配置

batchUnSubscribe

public void batchUnSubscribe(List<ConsumerConfig> configs)

从类复制的说明: Registry

反订阅服务调用者相关配置

指定者:

batchUnSubscribe 在类中 Registry

参数:

configs - Consumer配置

getZkClient

protected org.apache.curator.framework.CuratorFramework getZkClient()