AbstractCluster (com.alipay.sofa:sofa-rpc-all 5.4.0 API)

java.lang.Object
- com.alipay.sofa.rpc.client.Cluster
- - com.alipay.sofa.rpc.client.AbstractCluster

所有已实现的接口:

Destroyable, Initializable, Invoker, ProviderInfoListener

直接已知子类:

FailFastCluster, FailoverCluster
```
public abstract class AbstractCluster
extends Cluster
```
Abstract cluster, contains router chain, filter chain, address holder, connection holder and load balancer.

嵌套类概要

嵌套类
限定符和类型类和说明

protected class AbstractCluster.GracefulDestroyHook
优雅关闭的钩子
- 从接口继承的嵌套类/接口 com.alipay.sofa.rpc.base.Destroyable
  Destroyable.DestroyHook

嵌套类
限定符和类型	类和说明
`protected class`	`AbstractCluster.GracefulDestroyHook` 优雅关闭的钩子

字段概要

字段
限定符和类型	字段和说明
`protected AddressHolder`	`addressHolder` 地址保持器
`protected ConnectionHolder`	`connectionHolder` 连接管理器
`protected AtomicInteger`	`countOfInvoke` 当前Client正在发送的调用数量
`protected boolean`	`destroyed` 是否已经销毁（已经销毁不能再继续使用）
`protected FilterChain`	`filterChain` 过滤器链
`protected boolean`	`initialized` 是否已启动(已建立连接)
`protected LoadBalancer`	`loadBalancer` 负载均衡接口
`protected RouterChain`	`routerChain` 路由列表

从类继承的字段 com.alipay.sofa.rpc.client.Cluster
consumerBootstrap, consumerConfig

构造器概要

构造器
构造器和说明

AbstractCluster(ConsumerBootstrap consumerBootstrap)
构造函数

构造器
构造器和说明
`AbstractCluster(ConsumerBootstrap consumerBootstrap)` 构造函数

方法概要

方法
限定符和类型	方法和说明
`void`	`addProvider(ProviderGroup providerGroup)` 增加某标签的服务端列表（增量）
`protected void`	`checkAlias(ProviderInfo providerInfo, SofaRequest message)` 检查分组映射
`protected void`	`checkClusterState()` 检测状态
`protected void`	`checkProviderInfo(ProviderGroup providerGroup)` 检测服务节点的一些信息
`protected void`	`checkProviderVersion(ProviderInfo providerInfo, SofaRequest request)` 检查服务端版本，特殊处理
`void`	`checkStateChange(boolean originalState)` 状态变化通知
`protected void`	`closeTransports()` 关闭连接注意：关闭有风险，可能有正在调用的请求，建议判断下isAvailable()
`Collection<ProviderInfo>`	`currentProviderList()` 获取当前的Provider全部列表（包括连上和没连上的），比较费性能，慎用
`void`	`destroy()` 销毁接口
`void`	`destroy(Destroyable.DestroyHook hook)` Do destroy with hook.
`protected abstract SofaResponse`	`doInvoke(SofaRequest msg)` 子类实现各自逻辑的调用，例如重试等
`protected SofaResponse`	`doSendMsg(ProviderInfo providerInfo, ClientTransport transport, SofaRequest request)` 调用客户端
`protected SofaResponse`	`filterChain(ProviderInfo providerInfo, SofaRequest request)` 发起调用链
`AddressHolder`	`getAddressHolder()` 地址管理器
`ConnectionHolder`	`getConnectionHolder()` 连接管理器
`ConsumerConfig<?>`	`getConsumerConfig()`
`FilterChain`	`getFilterChain()` 过滤器链
`RouterChain`	`getRouterChain()` 路由器链
`void`	`init()` 初始化
`SofaResponse`	`invoke(SofaRequest request)` 执行调用
`boolean`	`isAvailable()` 是否可用
`protected SofaRouteException`	`noAvailableProviderException(String serviceKey)` 找不到可用的服务列表的异常
`void`	`notifyStateChangeToAvailable()` 通知状态变成可用,主要是： 1.启动成功变成可用时 2.注册中心增加，更新节点后变成可用时 3.重连上从一个可用节点都没有-->有可用节点时
`void`	`notifyStateChangeToUnavailable()` 通知状态变成不可用,主要是： 1.注册中心删除，更新节点后变成不可用时 2.连接断线后（心跳+调用），如果是可用节点为空
`void`	`removeProvider(ProviderGroup providerGroup)` 删除某标签的服务端列表（增量）
`protected ProviderInfo`	`select(SofaRequest message)` 根据规则进行负载均衡
`protected ProviderInfo`	`select(SofaRequest message, List<ProviderInfo> invokedProviderInfos)` 根据规则进行负载均衡
`protected ClientTransport`	`selectByProvider(SofaRequest message, ProviderInfo providerInfo)` 得到provider得到连接
`protected ProviderInfo`	`selectPinpointProvider(String targetIP, List<ProviderInfo> providerInfos)` Select provider.
`SofaResponse`	`sendMsg(ProviderInfo providerInfo, SofaRequest request)` 调用远程地址发送消息
`protected SofaRouteException`	`unavailableProviderException(String serviceKey, String providerInfo)` 指定地址不可用
`void`	`updateAllProviders(List<ProviderGroup> providerGroups)` 更新全部服务端列表（全量）
`void`	`updateProviders(ProviderGroup providerGroup)` 更新某标签的服务端列表（全量）

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - initialized
```
protected volatile boolean initialized
```
    是否已启动(已建立连接)
  - destroyed
```
protected volatile boolean destroyed
```
    是否已经销毁（已经销毁不能再继续使用）
  - countOfInvoke
```
protected AtomicInteger countOfInvoke
```
    当前Client正在发送的调用数量
  - routerChain
```
protected RouterChain routerChain
```
    路由列表
  - loadBalancer
```
protected LoadBalancer loadBalancer
```
    负载均衡接口
  - addressHolder
```
protected AddressHolder addressHolder
```
    地址保持器
  - connectionHolder
```
protected ConnectionHolder connectionHolder
```
    连接管理器
  - filterChain
```
protected FilterChain filterChain
```
    过滤器链
- 构造器详细资料
  - AbstractCluster
```
public AbstractCluster(ConsumerBootstrap consumerBootstrap)
```
    构造函数
    
    参数:
    consumerBootstrap - 服务端消费者启动器
- 方法详细资料
  - init
```
public void init()
```
    从接口复制的说明: Initializable
    
    初始化
  - checkClusterState
```
protected void checkClusterState()
```
    检测状态
  - addProvider
```
public void addProvider(ProviderGroup providerGroup)
```
    从接口复制的说明: ProviderInfoListener
    
    增加某标签的服务端列表（增量）
    
    参数:
    providerGroup - 服务端列表组
  - removeProvider
```
public void removeProvider(ProviderGroup providerGroup)
```
    从接口复制的说明: ProviderInfoListener
    
    删除某标签的服务端列表（增量）
    
    参数:
    providerGroup - 服务端列表组
  - updateProviders
```
public void updateProviders(ProviderGroup providerGroup)
```
    从接口复制的说明: ProviderInfoListener
    
    更新某标签的服务端列表（全量）
    
    参数:
    providerGroup - 服务端列表组
  - updateAllProviders
```
public void updateAllProviders(List<ProviderGroup> providerGroups)
```
    从接口复制的说明: ProviderInfoListener
    
    更新全部服务端列表（全量）
    
    参数:
    providerGroups - 全部服务端列表，为空代表清空已有列表
  - checkProviderInfo
```
protected void checkProviderInfo(ProviderGroup providerGroup)
```
    检测服务节点的一些信息
    
    参数:
    providerGroup - 服务列表分组
  - invoke
```
public SofaResponse invoke(SofaRequest request)
                    throws SofaRpcException
```
    从接口复制的说明: Invoker
    
    执行调用
    
    参数:
    request - 请求
    
    返回:
    SofaResponse 响应
    
    抛出:
    
    SofaRpcException - rpc异常
  - doInvoke
```
protected abstract SofaResponse doInvoke(SofaRequest msg)
                                  throws SofaRpcException
```
    子类实现各自逻辑的调用，例如重试等
    
    参数:
    msg - Request对象
    
    返回:
    调用结果
    
    抛出:
    
    SofaRpcException - rpc异常
  - checkProviderVersion
```
protected void checkProviderVersion(ProviderInfo providerInfo,
                        SofaRequest request)
```
    检查服务端版本，特殊处理
    
    参数:
    providerInfo - 服务端
    request - 请求对象
  - select
```
protected ProviderInfo select(SofaRequest message)
                       throws SofaRpcException
```
    根据规则进行负载均衡
    
    参数:
    message - 调用对象
    
    返回:
    一个可用的provider
    
    抛出:
    
    SofaRpcException - rpc异常
  - select
```
protected ProviderInfo select(SofaRequest message,
                  List<ProviderInfo> invokedProviderInfos)
                       throws SofaRpcException
```
    根据规则进行负载均衡
    
    参数:
    message - 调用对象
    invokedProviderInfos - 已调用列表
    
    返回:
    一个可用的provider
    
    抛出:
    
    SofaRpcException - rpc异常
  - selectPinpointProvider
```
protected ProviderInfo selectPinpointProvider(String targetIP,
                                  List<ProviderInfo> providerInfos)
```
    Select provider.
    
    参数:
    targetIP - the target ip
    
    返回:
    the provider
  - noAvailableProviderException
```
protected SofaRouteException noAvailableProviderException(String serviceKey)
```
    找不到可用的服务列表的异常
    
    参数:
    serviceKey - 服务关键字
    
    返回:
    服务端
  - unavailableProviderException
```
protected SofaRouteException unavailableProviderException(String serviceKey,
                                              String providerInfo)
```
    指定地址不可用
    
    参数:
    serviceKey - 服务关键字
    
    返回:
    服务端
  - selectByProvider
```
protected ClientTransport selectByProvider(SofaRequest message,
                               ProviderInfo providerInfo)
```
    得到provider得到连接
    
    参数:
    message - 调用对象
    providerInfo - 指定Provider
    
    返回:
    一个可用的transport或者null
  - checkAlias
```
protected void checkAlias(ProviderInfo providerInfo,
              SofaRequest message)
```
    检查分组映射
    
    参数:
    providerInfo - 服务端
    message - 请求对象
  - filterChain
```
protected SofaResponse filterChain(ProviderInfo providerInfo,
                       SofaRequest request)
                            throws SofaRpcException
```
    发起调用链
    
    参数:
    providerInfo - 服务端信息
    request - 请求对象
    
    返回:
    执行后返回的响应
    
    抛出:
    
    SofaRpcException - 请求RPC异常
  - sendMsg
```
public SofaResponse sendMsg(ProviderInfo providerInfo,
                   SofaRequest request)
                     throws SofaRpcException
```
    从类复制的说明: Cluster
    
    调用远程地址发送消息
    
    指定者:
    
    sendMsg 在类中 Cluster
    
    参数:
    providerInfo - 服务提供者信息
    request - 请求
    
    返回:
    状态
    
    抛出:
    
    SofaRpcException - RPC异常
  - doSendMsg
```
protected SofaResponse doSendMsg(ProviderInfo providerInfo,
                     ClientTransport transport,
                     SofaRequest request)
                          throws SofaRpcException
```
    调用客户端
    
    参数:
    transport - 客户端连接
    request - Request对象
    
    返回:
    调用结果
    
    抛出:
    
    SofaRpcException - rpc异常
  - destroy
```
public void destroy()
```
    从接口复制的说明: Destroyable
    
    销毁接口
  - destroy
```
public void destroy(Destroyable.DestroyHook hook)
```
    从接口复制的说明: Destroyable
    
    Do destroy with hook.
    
    参数:
    hook - DestroyHook
  - closeTransports
```
protected void closeTransports()
```
    关闭连接
    注意：关闭有风险，可能有正在调用的请求，建议判断下isAvailable()
  - isAvailable
```
public boolean isAvailable()
```
    从类复制的说明: Cluster
    
    是否可用
    
    指定者:
    
    isAvailable 在类中 Cluster
    
    返回:
    Is cluster available
  - checkStateChange
```
public void checkStateChange(boolean originalState)
```
    从类复制的说明: Cluster
    
    状态变化通知
    
    指定者:
    
    checkStateChange 在类中 Cluster
    
    参数:
    originalState - Origin state
  - notifyStateChangeToUnavailable
```
public void notifyStateChangeToUnavailable()
```
    通知状态变成不可用,主要是：
    1.注册中心删除，更新节点后变成不可用时
    2.连接断线后（心跳+调用），如果是可用节点为空
  - notifyStateChangeToAvailable
```
public void notifyStateChangeToAvailable()
```
    通知状态变成可用,主要是：
    1.启动成功变成可用时
    2.注册中心增加，更新节点后变成可用时
    3.重连上从一个可用节点都没有-->有可用节点时
  - currentProviderList
```
public Collection<ProviderInfo> currentProviderList()
```
    获取当前的Provider全部列表（包括连上和没连上的），比较费性能，慎用
    
    返回:
    当前的Provider列表
  - getConsumerConfig
```
public ConsumerConfig<?> getConsumerConfig()
```
    返回:
    the consumerConfig
  - getAddressHolder
```
public AddressHolder getAddressHolder()
```
    从类复制的说明: Cluster
    
    地址管理器
    
    指定者:
    
    getAddressHolder 在类中 Cluster
    
    返回:
    Current AddressHolder
  - getConnectionHolder
```
public ConnectionHolder getConnectionHolder()
```
    从类复制的说明: Cluster
    
    连接管理器
    
    指定者:
    
    getConnectionHolder 在类中 Cluster
    
    返回:
    Current ConnectionHolder
  - getFilterChain
```
public FilterChain getFilterChain()
```
    从类复制的说明: Cluster
    
    过滤器链
    
    指定者:
    
    getFilterChain 在类中 Cluster
    
    返回:
    Current FilterChain
  - getRouterChain
```
public RouterChain getRouterChain()
```
    从类复制的说明: Cluster
    
    路由器链
    
    指定者:
    
    getRouterChain 在类中 Cluster
    
    返回:
    Current RouterChain

类 AbstractCluster

嵌套类概要

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

字段概要

从类继承的字段 com.alipay.sofa.rpc.client.Cluster

构造器概要

方法概要

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

字段详细资料

initialized

destroyed

countOfInvoke

routerChain

loadBalancer

addressHolder

connectionHolder

filterChain

构造器详细资料

AbstractCluster

方法详细资料

init

checkClusterState

addProvider

removeProvider

updateProviders

updateAllProviders

checkProviderInfo

invoke

doInvoke

checkProviderVersion

select

select

selectPinpointProvider

noAvailableProviderException

unavailableProviderException

selectByProvider

checkAlias

filterChain

sendMsg

doSendMsg

destroy

destroy

closeTransports

isAvailable

checkStateChange

notifyStateChangeToUnavailable

notifyStateChangeToAvailable

currentProviderList

getConsumerConfig

getAddressHolder

getConnectionHolder

getFilterChain

getRouterChain