AddressPool (Hasor-RSF/RPC 4.2.5 API)

java.lang.Object
- net.hasor.rsf.address.AddressPool

所有已实现的接口:

RsfUpdater

直接已知子类:

DiskCacheAddressPool
```
public class AddressPool
extends Object
implements RsfUpdater
```
服务地址池
路由策略：随机选址
流控规则：服务级、方法级、参数级

版本:

: 2014年9月12日

作者:

赵永春 (zyc@hasor.net)

字段概要

字段
限定符和类型字段和说明

protected org.slf4j.Logger logger

字段
限定符和类型	字段和说明
`protected org.slf4j.Logger`	`logger`

构造器概要

构造器
构造器和说明

AddressPool(RsfEnvironment rsfEnvironment)

构造器
构造器和说明
`AddressPool(RsfEnvironment rsfEnvironment)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Map<String,List<InterAddress>>`	`allServiceAddressToSnapshot()` 所有服务地址快照功能，该接口获得的数据不可以进行写操作。
`void`	`appendAddress(String serviceID, Collection<InterAddress> newHostSet)` 新增或追加更新服务地址信息。
`void`	`appendAddress(String serviceID, InterAddress newHost)` 新增或追加更新服务地址信息。
`void`	`appendStaticAddress(String serviceID, Collection<InterAddress> newHostSet)` 新增或追加更新服务地址信息。
`void`	`appendStaticAddress(String serviceID, InterAddress newHost)` 新增或追加更新服务地址信息。
`String`	`argsRoute(String serviceID)` 更新本地参数级地址计算脚本。
`String`	`flowControl(String serviceID)` 更新服务路由策略
`protected ArgsKey`	`getArgsKey()`
`AddressBucket`	`getBucket(String serviceID)`
`Set<String>`	`getBucketNames()` 获取地址池中注册的服务列表。
`protected RuleRef`	`getRefRule(String serviceID)` 获取地址路由规则引用。
`RsfEnvironment`	`getRsfEnvironment()` 获取所使用的RsfEnvironment
`String`	`getUnitName()` 获取本机所属单元（虚机房 or 集群）
`void`	`invalidAddress(InterAddress address)` 将服务的地址设置成临时失效状态。
`String`	`methodRoute(String serviceID)` 更新本地方法级地址计算脚本。
`InterAddress`	`nextAddress(String serviceID, String methodName, Object[] args)` 从服务地址本中获取一条可用的地址。
`List<InterAddress>`	`queryAllAddresses(String serviceID)` 获取所有地址（包括本地的和无效的）。
`List<InterAddress>`	`queryAvailableAddresses(String serviceID)` 获取计算之后可用的地址。
`List<InterAddress>`	`queryInvalidAddresses(String serviceID)` 失效地址。
`List<InterAddress>`	`queryLocalUnitAddresses(String serviceID)` 获取计算之后同一单元地址。
`void`	`refreshAddress(String serviceID, List<InterAddress> addressList)` 刷新服务的地址本，使其使用全新的地址本。
`void`	`refreshAddressCache()` 刷新地址缓存
`void`	`removeAddress(InterAddress address)` 某一个地址不可用了，从所有服务中删除这个地址
`void`	`removeAddress(String serviceID, Collection<InterAddress> invalidAddressSet)` 将服务的地址设置成临时失效状态，把地址从服务的地址本中彻底删除。
`void`	`removeAddress(String serviceID, InterAddress invalidAddress)` 将服务的地址设置成临时失效状态，把地址从服务的地址本中彻底删除。
`boolean`	`removeBucket(String serviceID)` 从地址池中，删除指定服务的地址本。
`void`	`restoreConfig(InputStream inStream)` 从保存的地址本中恢复数据。
`String`	`serviceRoute(String serviceID)` 更新服务地址本计算规则（服务级）
`void`	`storeConfig(OutputStream outStream)` 保存地址列表到zip流中。
`String`	`toString()`
`boolean`	`updateArgsRoute(String serviceID, String scriptBody)` 更新本地参数级地址计算脚本。
`boolean`	`updateFlowControl(String serviceID, String flowControl)` 更新服务的流控规则。
`boolean`	`updateMethodRoute(String serviceID, String scriptBody)` 更新本地方法级地址计算脚本。
`boolean`	`updateRoute(String serviceID, RouteTypeEnum routeType, String script)` 更新某个服务的路由规则脚本。
`boolean`	`updateServiceRoute(String serviceID, String scriptBody)` 更新服务地址本计算规则（服务级）

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

- 字段详细资料
  - logger
```
protected final org.slf4j.Logger logger
```
- 构造器详细资料
  - AddressPool
```
public AddressPool(RsfEnvironment rsfEnvironment)
```
- 方法详细资料
  - getBucket
```
public AddressBucket getBucket(String serviceID)
```
  - getUnitName
```
public String getUnitName()
```
    获取本机所属单元（虚机房 or 集群）
    
    返回:
    
    返回单元名（虚机房 or 集群）
  - getRsfEnvironment
```
public RsfEnvironment getRsfEnvironment()
```
    获取所使用的RsfEnvironment
  - allServiceAddressToSnapshot
```
public Map<String,List<InterAddress>> allServiceAddressToSnapshot()
```
    所有服务地址快照功能，该接口获得的数据不可以进行写操作。通过这个接口可以获得到此刻地址池中所有服务的：
    1. 原始服务地址列表，以{serviceID}_ALL作为key
    2. 本单元服务地址列表，以{serviceID}_UNIT作为key
    3. 不可用服务地址列表，以{serviceID}_INVALID作为key
    4. 所有可用服务地址列表，以{serviceID}作为key
  - getBucketNames
```
public Set<String> getBucketNames()
```
    获取地址池中注册的服务列表。
    
    返回:
    
    返回地址池中注册的服务列表。
    
    另请参阅:
    
    RsfBindInfo.getBindID()
  - appendStaticAddress
```
public void appendStaticAddress(String serviceID,
                                InterAddress newHost)
```
    新增或追加更新服务地址信息。
    如果追加的地址是已存在的失效地址，那么updateAddress方法将重新激活这些失效地址。
    
    参数:
    
    serviceID - 服务ID。
    
    newHost - 追加更新的地址。
  - appendStaticAddress
```
public void appendStaticAddress(String serviceID,
                                Collection<InterAddress> newHostSet)
```
    新增或追加更新服务地址信息。
    如果追加的地址是已存在的失效地址，那么updateAddress方法将重新激活这些失效地址。
    
    指定者:
    
    appendStaticAddress 在接口中 RsfUpdater
    
    参数:
    
    serviceID - 服务ID。
    
    newHostSet - 追加更新的地址。
  - appendAddress
```
public void appendAddress(String serviceID,
                          InterAddress newHost)
```
    新增或追加更新服务地址信息。
    如果追加的地址是已存在的失效地址，那么updateAddress方法将重新激活这些失效地址。
    
    参数:
    
    serviceID - 服务ID。
    
    newHost - 追加更新的地址。
  - appendAddress
```
public void appendAddress(String serviceID,
                          Collection<InterAddress> newHostSet)
```
    新增或追加更新服务地址信息。
    如果追加的地址是已存在的失效地址，那么updateAddress方法将重新激活这些失效地址。
    
    指定者:
    
    appendAddress 在接口中 RsfUpdater
    
    参数:
    
    serviceID - 服务ID。
    
    newHostSet - 追加更新的地址。
  - invalidAddress
```
public void invalidAddress(InterAddress address)
```
    将服务的地址设置成临时失效状态。在RsfSettings.getInvalidWaitTime()毫秒之后，失效的地址会重新被列入备选地址池。置为失效，失效并不意味着永久的。
    
    参数:
    
    address - 失效的地址。
  - removeAddress
```
public void removeAddress(String serviceID,
                          InterAddress invalidAddress)
```
    将服务的地址设置成临时失效状态，把地址从服务的地址本中彻底删除。
    
    指定者:
    
    removeAddress 在接口中 RsfUpdater
    
    参数:
    
    serviceID - 服务ID。
    
    invalidAddress - 将要删除的地址。
  - removeAddress
```
public void removeAddress(String serviceID,
                          Collection<InterAddress> invalidAddressSet)
```
    将服务的地址设置成临时失效状态，把地址从服务的地址本中彻底删除。
    
    指定者:
    
    removeAddress 在接口中 RsfUpdater
    
    参数:
    
    serviceID - 服务ID。
    
    invalidAddressSet - 将要删除的地址。
  - removeAddress
```
public void removeAddress(InterAddress address)
```
    从接口复制的说明: RsfUpdater
    
    某一个地址不可用了，从所有服务中删除这个地址
    
    指定者:
    
    removeAddress 在接口中 RsfUpdater
  - removeBucket
```
public boolean removeBucket(String serviceID)
```
    从地址池中，删除指定服务的地址本。
    
    参数:
    
    serviceID - 服务ID。
  - refreshAddress
```
public void refreshAddress(String serviceID,
                           List<InterAddress> addressList)
```
    从接口复制的说明: RsfUpdater
    
    刷新服务的地址本，使其使用全新的地址本。
    
    指定者:
    
    refreshAddress 在接口中 RsfUpdater
  - refreshAddressCache
```
public void refreshAddressCache()
```
    刷新地址缓存
    
    指定者:
    
    refreshAddressCache 在接口中 RsfUpdater
  - nextAddress
```
public InterAddress nextAddress(String serviceID,
                                String methodName,
                                Object[] args)
```
    从服务地址本中获取一条可用的地址。
    当一个服务具有多个地址的情况下，为了保证公平性地址池采取了随机选取的方式（路由策略：随机选址）
    - 如果地址池中没有定义这个服务的Bucket，那么将会返回一个null。
    - 如果地址本或者地址池上配置了流控机制，那么选择到的地址将会被限制固定的速率，进而限制nextAddress方法的整个QPS。
    - 默认情况下地址的获取，会受到路由规则、流控规则的影响。
    当地址获取和地址更新同时进行时候，不需要保证瞬时的一致性，只要保证最终一致性就好。
    参数:
    
    serviceID - 服务id。
    
    methodName - 调用该服务的方法名。
    
    args - 方法调用时用到的参数。
    
    返回:
    
    返回可以使用的地址。
  - getArgsKey
```
protected ArgsKey getArgsKey()
```
  - getRefRule
```
protected RuleRef getRefRule(String serviceID)
```
    获取地址路由规则引用。
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - updateServiceRoute
```
public boolean updateServiceRoute(String serviceID,
                                  String scriptBody)
```
    从接口复制的说明: RsfUpdater
    
    更新服务地址本计算规则（服务级）
    
    指定者:
    
    updateServiceRoute 在接口中 RsfUpdater
  - updateMethodRoute
```
public boolean updateMethodRoute(String serviceID,
                                 String scriptBody)
```
    从接口复制的说明: RsfUpdater
    
    更新本地方法级地址计算脚本。
    
    指定者:
    
    updateMethodRoute 在接口中 RsfUpdater
  - updateArgsRoute
```
public boolean updateArgsRoute(String serviceID,
                               String scriptBody)
```
    从接口复制的说明: RsfUpdater
    
    更新本地参数级地址计算脚本。
    
    指定者:
    
    updateArgsRoute 在接口中 RsfUpdater
  - updateFlowControl
```
public boolean updateFlowControl(String serviceID,
                                 String flowControl)
```
    更新服务的流控规则。
    
    指定者:
    
    updateFlowControl 在接口中 RsfUpdater
    
    参数:
    
    serviceID - 应用到的服务。
    
    flowControl - 流控规则
  - updateRoute
```
public boolean updateRoute(String serviceID,
                           RouteTypeEnum routeType,
                           String script)
```
    更新某个服务的路由规则脚本。
    
    参数:
    
    serviceID - 要更新的服务。
    
    routeType - 更新的路由规则类型。
    
    script - 路由规则脚本内容。
  - serviceRoute
```
public String serviceRoute(String serviceID)
```
    从接口复制的说明: RsfUpdater
    
    更新服务地址本计算规则（服务级）
    
    指定者:
    
    serviceRoute 在接口中 RsfUpdater
  - methodRoute
```
public String methodRoute(String serviceID)
```
    从接口复制的说明: RsfUpdater
    
    更新本地方法级地址计算脚本。
    
    指定者:
    
    methodRoute 在接口中 RsfUpdater
  - argsRoute
```
public String argsRoute(String serviceID)
```
    从接口复制的说明: RsfUpdater
    
    更新本地参数级地址计算脚本。
    
    指定者:
    
    argsRoute 在接口中 RsfUpdater
  - flowControl
```
public String flowControl(String serviceID)
```
    从接口复制的说明: RsfUpdater
    
    更新服务路由策略
    
    指定者:
    
    flowControl 在接口中 RsfUpdater
  - queryAllAddresses
```
public List<InterAddress> queryAllAddresses(String serviceID)
```
    从接口复制的说明: RsfUpdater
    
    获取所有地址（包括本地的和无效的）。
    
    指定者:
    
    queryAllAddresses 在接口中 RsfUpdater
  - queryAvailableAddresses
```
public List<InterAddress> queryAvailableAddresses(String serviceID)
```
    从接口复制的说明: RsfUpdater
    
    获取计算之后可用的地址。
    
    指定者:
    
    queryAvailableAddresses 在接口中 RsfUpdater
  - queryInvalidAddresses
```
public List<InterAddress> queryInvalidAddresses(String serviceID)
```
    从接口复制的说明: RsfUpdater
    
    失效地址。
    
    指定者:
    
    queryInvalidAddresses 在接口中 RsfUpdater
  - queryLocalUnitAddresses
```
public List<InterAddress> queryLocalUnitAddresses(String serviceID)
```
    从接口复制的说明: RsfUpdater
    
    获取计算之后同一单元地址。
    
    指定者:
    
    queryLocalUnitAddresses 在接口中 RsfUpdater
  - storeConfig
```
public void storeConfig(OutputStream outStream)
                 throws IOException
```
    保存地址列表到zip流中。
    
    抛出:
    
    IOException
  - restoreConfig
```
public void restoreConfig(InputStream inStream)
                   throws IOException
```
    从保存的地址本中恢复数据。
    
    抛出:
    
    IOException

类 AddressPool

字段概要

构造器概要

方法概要

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

字段详细资料

logger

构造器详细资料

AddressPool

方法详细资料

getBucket

getUnitName

getRsfEnvironment

allServiceAddressToSnapshot

getBucketNames

appendStaticAddress

appendStaticAddress

appendAddress

appendAddress

invalidAddress

removeAddress

removeAddress

removeAddress

removeBucket

refreshAddress

refreshAddressCache

nextAddress

getArgsKey

getRefRule

toString

updateServiceRoute

updateMethodRoute

updateArgsRoute

updateFlowControl

updateRoute

serviceRoute

methodRoute

argsRoute

flowControl

queryAllAddresses

queryAvailableAddresses

queryInvalidAddresses

queryLocalUnitAddresses

storeConfig

restoreConfig