HSFApiConsumerBean (edas-sdk 1.8.0 API)

java.lang.Object
- com.taobao.hsf.app.api.util.HSFApiConsumerBean

```
public class HSFApiConsumerBean
extends Object
```
描述：提供给用户单独的Bean，为单元测试、开发环境部署以及正式部署提供支持

作者:

kongming.lrq

构造器概要

构造器
构造器和说明

HSFApiConsumerBean()

构造器
构造器和说明
`HSFApiConsumerBean()`

方法概要

方法
限定符和类型	方法和说明
`Object`	`getObject()`
`void`	`init()` 初始化
`void`	`init(boolean sync)`
`void`	`init(long timeout)`
`void`	`setAsyncallMethods(List<String> asyncallMethods)` 设置需要异步调用的方法
`void`	`setBroadcast(boolean broadcast)`
`void`	`setCallbackHandler(Object callbackHandler)` 用于可靠异步调用
`void`	`setCallbackInvoker(Object callbackInvoker)` 在callback调用的时候，设置统一的回调函数，支持callback的context传递。
`void`	`setCallbackMethodSuffix(String suffix)` 默认为_callback, 含义参见callbackHandler
`void`	`setClientTimeout(int clientTimeout)`
`void`	`setConfigStyle(String configStyle)` 设置服务的配置方式，dubbo或者hsf
`void`	`setConnectionNum(int connectionNum)`
`void`	`setConsistent(String consistent)`
`void`	`setDubboVersion(String version)`
`void`	`setEnvID(String envID)`
`void`	`setFilter(String filter)`
`void`	`setGeneric(String generic)`
`void`	`setGroup(String group)` 设置服务所属的组
`void`	`setIncludeFilters(List<String> rpcFilterNameList)` 设置需要额外包括的RPCFilter列表
`void`	`setInterfaceClass(Class<?> interfaceClass)`
`void`	`setInterfaceMethodToAttachContext(String methodName)`
`void`	`setInterfaceName(String interfaceName)` 设置接口名。
`void`	`setInvokeContextThreadLocal(ThreadLocal<Serializable> invokeContext)`
`void`	`setInvokeType(String invokeType)`
`void`	`setMaxThreadPool(String poolSize)` 用户调用的线程通常希望控制调用的线程池大小，该属性用来设置用户调用的线程池大小。
`void`	`setMaxWaitTimeForCsAddress(int timeout)`
`void`	`setMethodSpecials(MethodSpecial[] methodSpecials)`
`void`	`setProxyStyle(String proxyStyle)`
`void`	`setRetries(int retries)`
`void`	`setRPCProtocols(Map<String,Properties> rpcProtocols)` 设置调用的方式，支持多种rpc方式，但只能设置成一种
`void`	`setSecureKey(String secureKey)`
`void`	`setSupportEcho(boolean value)`
`void`	`setTarget(String target)` 设置调用的服务的目标地址
`void`	`setTenantID(String tenantID)`
`void`	`setVersion(String version)` 设置调用的服务的版本

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

构造器详细资料
- HSFApiConsumerBean
```
public HSFApiConsumerBean()
```

方法详细资料

getObject

public Object getObject()
                 throws Exception

抛出:: Exception

init
```
public void init(boolean sync)
          throws Exception
```
参数:
sync - 是否和地址推送同步，默认false(异步)，同步默认超时时间3000毫秒

抛出:

Exception

init
```
public void init(long timeout)
          throws Exception
```
参数:
timeout - 与地址同步的超时时间，单位：毫秒

抛出:

Exception

init

public void init()
          throws Exception

初始化

抛出:: Exception

setAsyncallMethods

public void setAsyncallMethods(List<String> asyncallMethods)

设置需要异步调用的方法

setGroup
```
public void setGroup(String group)
```
设置服务所属的组

setCallbackInvoker
```
public void setCallbackInvoker(Object callbackInvoker)
```
在callback调用的时候，设置统一的回调函数，支持callback的context传递。

参数:
callbackInvoker -

setInterfaceName
```
public void setInterfaceName(String interfaceName)
```
设置接口名。如果该接口无法装载到，则抛出IllegalArgumentException

setInterfaceClass

public void setInterfaceClass(Class<?> interfaceClass)

setSupportEcho

public void setSupportEcho(boolean value)

setMaxThreadPool
```
public void setMaxThreadPool(String poolSize)
```
用户调用的线程通常希望控制调用的线程池大小，该属性用来设置用户调用的线程池大小。

参数:
poolSize -

setMethodSpecials

public void setMethodSpecials(MethodSpecial[] methodSpecials)

setRPCProtocols
```
public void setRPCProtocols(Map<String,Properties> rpcProtocols)
```
设置调用的方式，支持多种rpc方式，但只能设置成一种

参数:
rpcProtocols -

setConfigStyle
```
public void setConfigStyle(String configStyle)
```
设置服务的配置方式，dubbo或者hsf

参数:
configStyle -

setTarget
```
public void setTarget(String target)
```
设置调用的服务的目标地址

setVersion

public void setVersion(String version)

设置调用的服务的版本

setDubboVersion

public void setDubboVersion(String version)

setProxyStyle

public void setProxyStyle(String proxyStyle)

setConnectionNum
```
public void setConnectionNum(int connectionNum)
```
参数:
connectionNum -
从以下版本开始:

2.0 有些consumer对延迟很关心，可以多设置几个connection来降低延迟对那些小数据请求比较有用

setBroadcast

public void setBroadcast(boolean broadcast)

setGeneric

public void setGeneric(String generic)

setRetries
```
public void setRetries(int retries)
```

setFilter
```
public void setFilter(String filter)
```

setSecureKey

public void setSecureKey(String secureKey)

setMaxWaitTimeForCsAddress

public void setMaxWaitTimeForCsAddress(int timeout)

setClientTimeout

public void setClientTimeout(int clientTimeout)

setCallbackHandler
```
public void setCallbackHandler(Object callbackHandler)
```
用于可靠异步调用

参数:
callbackHandler -

setCallbackMethodSuffix
```
public void setCallbackMethodSuffix(String suffix)
```
默认为_callback, 含义参见callbackHandler

setInterfaceMethodToAttachContext

public void setInterfaceMethodToAttachContext(String methodName)

setInvokeContextThreadLocal

public void setInvokeContextThreadLocal(ThreadLocal<Serializable> invokeContext)

setConsistent

public void setConsistent(String consistent)

setIncludeFilters
```
public void setIncludeFilters(List<String> rpcFilterNameList)
```
设置需要额外包括的RPCFilter列表

参数:
rpcFilterNameList - 配置的RpcFilter列表

setInvokeType

public void setInvokeType(String invokeType)

setTenantID

public void setTenantID(String tenantID)

setEnvID
```
public void setEnvID(String envID)
```

类 HSFApiConsumerBean

构造器概要

方法概要

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

构造器详细资料

HSFApiConsumerBean

方法详细资料

getObject

init

init

init

setAsyncallMethods

setGroup

setCallbackInvoker

setInterfaceName

setInterfaceClass

setSupportEcho

setMaxThreadPool

setMethodSpecials

setRPCProtocols

setConfigStyle

setTarget

setVersion

setDubboVersion

setProxyStyle

setConnectionNum

setBroadcast

setGeneric

setRetries

setFilter

setSecureKey

setMaxWaitTimeForCsAddress

setClientTimeout

setCallbackHandler

setCallbackMethodSuffix

setInterfaceMethodToAttachContext

setInvokeContextThreadLocal

setConsistent

setIncludeFilters

setInvokeType

setTenantID

setEnvID