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

java.lang.Object
- com.alipay.sofa.rpc.config.AbstractIdConfig<S>
- - com.alipay.sofa.rpc.config.AbstractInterfaceConfig<T,S>

类型参数:
T - the interface
S - the sub class of AbstractInterfaceConfig

所有已实现的接口:

Serializable

直接已知子类:

ConsumerConfig, ProviderConfig
```
public abstract class AbstractInterfaceConfig<T,S extends AbstractInterfaceConfig>
extends AbstractIdConfig<S>
implements Serializable
```
接口级的公共配置

另请参阅:
序列化表格

字段概要

字段
限定符和类型	字段和说明
`protected ApplicationConfig`	`application` 应用信息
`protected boolean`	`cache` 是否启动结果缓存
`protected Cache`	`cacheRef` 结果缓存实现类
`protected String`	`compress` 压缩算法，为空则不压缩
`protected ConfigListener`	`configListener` 服务配置的listener
`protected Map<String,Object>`	`configValueCache` 方法名称和方法参数配置的map，不需要遍历list
`protected List<String>`	`filter` 过滤器配置别名，多个用逗号隔开
`protected List<Filter>`	`filterRef` 过滤器配置实例
`protected String`	`group` 已过时。不再作为服务唯一标识，请直接使用 `uniqueId` 代替
`protected String`	`interfaceId` 服务接口：做为服务唯一标识的组成部分不管普通调用和泛化调用，都是设置实际的接口类名称，
`protected Map<String,MethodConfig>`	`methods` 方法配置，可配置多个
`protected boolean`	`mock` 是否开启mock
`protected T`	`mockRef` Mock实现类
`protected Map<String,String>`	`parameters` 自定义参数
`protected String`	`proxy` 代理类型
`protected Class`	`proxyClass` 代理接口类，和T对应，主要针对泛化调用
`protected boolean`	`register` 是否注册，如果是false只订阅不注册
`protected List<RegistryConfig>`	`registry` 注册中心配置，可配置多个
`protected String`	`serialization` 默认序列化
`protected boolean`	`subscribe` 是否订阅服务
`protected String`	`uniqueId` 服务标签：做为服务唯一标识的组成部分
`protected boolean`	`validation` 是否开启参数验证(jsr303)
`protected String`	`version` 已过时。从5.4.0开始，不再作为服务唯一标识，请直接使用 `uniqueId` 代替

构造器概要

构造器
构造器和说明

AbstractInterfaceConfig()

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

方法概要

方法
限定符和类型	方法和说明
`protected abstract String`	`buildKey()` 构造关键字方法
`ApplicationConfig`	`getApplication()` Gets application.
`String`	`getAppName()` Gets app name.
`Cache`	`getCacheRef()` Gets cache ref.
`String`	`getCompress()` Gets compress.
`ConfigListener`	`getConfigListener()` 得到配置监听器
`Map<String,Object>`	`getConfigValueCache()` Gets config value cache.
`Map<String,Object>`	`getConfigValueCache(boolean rebuild)` 接口属性和方法属性加载配置到缓存
`List<String>`	`getFilter()` Gets filters.
`List<Filter>`	`getFilterRef()` Gets filter ref.
`String`	`getGroup()` 已过时。
`String`	`getInterfaceId()` Gets interface id.
`Object`	`getMethodConfigValue(String methodName, String configKey)` 得到方法级配置，找不到则返回null
`Object`	`getMethodConfigValue(String methodName, String configKey, Object defaultValue)` 得到方法级配置，找不到则返回默认值
`Map<String,MethodConfig>`	`getMethods()` Gets methods.
`T`	`getMockRef()` Gets mock ref.
`String`	`getParameter(String key)` Gets parameter.
`Map<String,String>`	`getParameters()` Gets parameters.
`String`	`getProxy()` Gets proxy.
`protected abstract Class<?>`	`getProxyClass()` Gets proxy class.
`List<RegistryConfig>`	`getRegistry()` Gets registry.
`String`	`getSerialization()` Gets serialization.
`String`	`getUniqueId()` Gets uniqueId.
`String`	`getVersion()` 已过时。
`boolean`	`hasCache()` 是否有缓存
`abstract boolean`	`hasConcurrents()` 是否有并发限制配置
`abstract boolean`	`hasTimeout()` 是否有超时配置
`boolean`	`hasToken()` 是否有token配置
`boolean`	`hasValidation()` 除了判断自己，还有判断下面方法的自定义判断
`boolean`	`isCache()` Is cache boolean.
`boolean`	`isMock()` Is mock boolean.
`boolean`	`isRegister()` Is register boolean.
`boolean`	`isSubscribe()` Is subscribe boolean.
`boolean`	`isValidation()` Is validation boolean.
`String`	`queryAttribute(String property)` 查询属性值
`S`	`setApplication(ApplicationConfig application)` Sets application.
`S`	`setCache(boolean cache)` Sets cache.
`S`	`setCacheRef(Cache cacheRef)` Sets cache ref.
`S`	`setCompress(String compress)` Sets compress.
`S`	`setConfigListener(ConfigListener configListener)` Sets config listener.
`S`	`setFilter(List<String> filter)` Sets filter.
`S`	`setFilterRef(List<Filter> filterRef)` Sets filter ref.
`S`	`setGroup(String group)` 已过时。 Use `setUniqueId(String)`
`S`	`setInterfaceId(String interfaceId)` Sets interface id.
`S`	`setMethods(List<MethodConfig> methods)` Sets methods.
`S`	`setMethods(Map<String,MethodConfig> methods)` Sets methods.
`S`	`setMock(boolean mock)` Sets mock.
`S`	`setMockRef(T mockRef)` Sets mock ref.
`S`	`setParameter(String key, String value)` Sets parameter.
`S`	`setParameters(Map<String,String> parameters)` Sets parameters.
`S`	`setProxy(String proxy)` Sets proxy.
`S`	`setRegister(boolean register)` Sets register.
`S`	`setRegistry(List<RegistryConfig> registry)` Sets registry.
`S`	`setRegistry(RegistryConfig registry)` 设置注册中心
`S`	`setSerialization(String serialization)` Sets serialization.
`S`	`setSubscribe(boolean subscribe)` Sets subscribe.
`S`	`setUniqueId(String uniqueId)` Sets uniqueId.
`S`	`setValidation(boolean validation)` Sets validation.
`S`	`setVersion(String version)` 已过时。 Use `setUniqueId(String)`
`boolean`	`updateAttribute(String property, String newValueStr, boolean overwrite)` 覆盖属性，可以检查，或者更新

从类继承的方法 com.alipay.sofa.rpc.config.AbstractIdConfig
castThis, getId, setId

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

- 字段详细资料
  - application
```
protected ApplicationConfig application
```
    应用信息
  - interfaceId
```
protected String interfaceId
```
    服务接口：做为服务唯一标识的组成部分
    不管普通调用和泛化调用，都是设置实际的接口类名称，
    
    另请参阅:
    uniqueId
  - uniqueId
```
protected String uniqueId
```
    服务标签：做为服务唯一标识的组成部分
    
    另请参阅:
    interfaceId
  - filterRef
```
protected transient List<Filter> filterRef
```
    过滤器配置实例
  - filter
```
protected List<String> filter
```
    过滤器配置别名，多个用逗号隔开
  - registry
```
protected List<RegistryConfig> registry
```
    注册中心配置，可配置多个
  - methods
```
protected Map<String,MethodConfig> methods
```
    方法配置，可配置多个
  - serialization
```
protected String serialization
```
    默认序列化
  - register
```
protected boolean register
```
    是否注册，如果是false只订阅不注册
  - subscribe
```
protected boolean subscribe
```
    是否订阅服务
  - proxy
```
protected String proxy
```
    代理类型
  - group
```
@Deprecated
protected String group
```
    已过时。 不再作为服务唯一标识，请直接使用 uniqueId 代替
    
    服务分组：不做为服务唯一标识的一部分
  - version
```
protected String version
```
    已过时。 从5.4.0开始，不再作为服务唯一标识，请直接使用 uniqueId 代替
    
    服务版本：不做为服务唯一标识的一部分
    
    另请参阅:
    interfaceId, uniqueId
  - cacheRef
```
protected transient Cache cacheRef
```
    结果缓存实现类
  - mockRef
```
protected transient T mockRef
```
    Mock实现类
  - parameters
```
protected Map<String,String> parameters
```
    自定义参数
  - cache
```
protected boolean cache
```
    是否启动结果缓存
  - mock
```
protected boolean mock
```
    是否开启mock
  - validation
```
protected boolean validation
```
    是否开启参数验证(jsr303)
  - compress
```
protected String compress
```
    压缩算法，为空则不压缩
  - configValueCache
```
protected transient volatile Map<String,Object> configValueCache
```
    方法名称和方法参数配置的map，不需要遍历list
  - proxyClass
```
protected transient volatile Class proxyClass
```
    代理接口类，和T对应，主要针对泛化调用
  - configListener
```
protected transient volatile ConfigListener configListener
```
    服务配置的listener
- 构造器详细资料
  - AbstractInterfaceConfig
```
public AbstractInterfaceConfig()
```
- 方法详细资料
  - getProxyClass
```
protected abstract Class<?> getProxyClass()
```
    Gets proxy class.
    
    返回:
    the proxyClass
  - buildKey
```
protected abstract String buildKey()
```
    构造关键字方法
    
    返回:
    唯一标识 string
  - getApplication
```
public ApplicationConfig getApplication()
```
    Gets application.
    
    返回:
    the application
  - setApplication
```
public S setApplication(ApplicationConfig application)
```
    Sets application.
    
    参数:
    application - the application
    
    返回:
    the application
  - getInterfaceId
```
public String getInterfaceId()
```
    Gets interface id.
    
    返回:
    the interface id
  - setInterfaceId
```
public S setInterfaceId(String interfaceId)
```
    Sets interface id.
    
    参数:
    interfaceId - the interface id
    
    返回:
    the interface id
  - getUniqueId
```
public String getUniqueId()
```
    Gets uniqueId.
    
    返回:
    the uniqueId
  - setUniqueId
```
public S setUniqueId(String uniqueId)
```
    Sets uniqueId.
    
    参数:
    uniqueId - the uniqueId
    
    返回:
    this unique id
  - getFilterRef
```
public List<Filter> getFilterRef()
```
    Gets filter ref.
    
    返回:
    the filter ref
  - setFilterRef
```
public S setFilterRef(List<Filter> filterRef)
```
    Sets filter ref.
    
    参数:
    filterRef - the filter ref
    
    返回:
    the filter ref
  - getFilter
```
public List<String> getFilter()
```
    Gets filters.
    
    返回:
    the filters
  - setFilter
```
public S setFilter(List<String> filter)
```
    Sets filter.
    
    参数:
    filter - the filter
    
    返回:
    the filter
  - getRegistry
```
public List<RegistryConfig> getRegistry()
```
    Gets registry.
    
    返回:
    the registry
  - setRegistry
```
public S setRegistry(List<RegistryConfig> registry)
```
    Sets registry.
    
    参数:
    registry - the registry
    
    返回:
    the registry
  - getMethods
```
public Map<String,MethodConfig> getMethods()
```
    Gets methods.
    
    返回:
    the methods
  - setMethods
```
public S setMethods(Map<String,MethodConfig> methods)
```
    Sets methods.
    
    参数:
    methods - the methods
    
    返回:
    the methods
  - getSerialization
```
public String getSerialization()
```
    Gets serialization.
    
    返回:
    the serialization
  - setSerialization
```
public S setSerialization(String serialization)
```
    Sets serialization.
    
    参数:
    serialization - the serialization
    
    返回:
    the serialization
  - isRegister
```
public boolean isRegister()
```
    Is register boolean.
    
    返回:
    the boolean
  - setRegister
```
public S setRegister(boolean register)
```
    Sets register.
    
    参数:
    register - the register
    
    返回:
    the register
  - isSubscribe
```
public boolean isSubscribe()
```
    Is subscribe boolean.
    
    返回:
    the boolean
  - setSubscribe
```
public S setSubscribe(boolean subscribe)
```
    Sets subscribe.
    
    参数:
    subscribe - the subscribe
    
    返回:
    the subscribe
  - getProxy
```
public String getProxy()
```
    Gets proxy.
    
    返回:
    the proxy
  - setProxy
```
public S setProxy(String proxy)
```
    Sets proxy.
    
    参数:
    proxy - the proxy
    
    返回:
    the proxy
  - getGroup
```
@Deprecated
public String getGroup()
```
    已过时。
    
    Gets group.
    
    返回:
    the group
  - setGroup
```
@Deprecated
public S setGroup(String group)
```
    已过时。 Use setUniqueId(String)
    
    Sets group.
    
    参数:
    group - the group
    
    返回:
    the group
  - getVersion
```
@Deprecated
public String getVersion()
```
    已过时。
    
    Gets version.
    
    返回:
    the version
  - setVersion
```
@Deprecated
public S setVersion(String version)
```
    已过时。 Use setUniqueId(String)
    
    Sets version.
    
    参数:
    version - the version
    
    返回:
    the version
  - getCacheRef
```
public Cache getCacheRef()
```
    Gets cache ref.
    
    返回:
    the cache ref
  - setCacheRef
```
public S setCacheRef(Cache cacheRef)
```
    Sets cache ref.
    
    参数:
    cacheRef - the cache ref
    
    返回:
    the cache ref
  - getMockRef
```
public T getMockRef()
```
    Gets mock ref.
    
    返回:
    the mock ref
  - setMockRef
```
public S setMockRef(T mockRef)
```
    Sets mock ref.
    
    参数:
    mockRef - the mock ref
    
    返回:
    the mock ref
  - getParameters
```
public Map<String,String> getParameters()
```
    Gets parameters.
    
    返回:
    the parameters
  - setParameters
```
public S setParameters(Map<String,String> parameters)
```
    Sets parameters.
    
    参数:
    parameters - the parameters
    
    返回:
    the parameters
  - isMock
```
public boolean isMock()
```
    Is mock boolean.
    
    返回:
    the boolean
  - setMock
```
public S setMock(boolean mock)
```
    Sets mock.
    
    参数:
    mock - the mock
    
    返回:
    the mock
  - isValidation
```
public boolean isValidation()
```
    Is validation boolean.
    
    返回:
    the boolean
  - setValidation
```
public S setValidation(boolean validation)
```
    Sets validation.
    
    参数:
    validation - the validation
    
    返回:
    the validation
  - getCompress
```
public String getCompress()
```
    Gets compress.
    
    返回:
    the compress
  - setCompress
```
public S setCompress(String compress)
```
    Sets compress.
    
    参数:
    compress - the compress
    
    返回:
    the compress
  - isCache
```
public boolean isCache()
```
    Is cache boolean.
    
    返回:
    the boolean
  - setCache
```
public S setCache(boolean cache)
```
    Sets cache.
    
    参数:
    cache - the cache
    
    返回:
    the cache
  - getConfigValueCache
```
public Map<String,Object> getConfigValueCache()
```
    Gets config value cache.
    
    返回:
    the config value cache
  - setConfigListener
```
public S setConfigListener(ConfigListener configListener)
```
    Sets config listener.
    
    参数:
    configListener - the config listener
    
    返回:
    the config listener
  - getConfigListener
```
public ConfigListener getConfigListener()
```
    得到配置监听器
    
    返回:
    配置监听器 config listener
  - hasTimeout
```
public abstract boolean hasTimeout()
```
    是否有超时配置
    
    返回:
    是否配置了timeout boolean
  - hasConcurrents
```
public abstract boolean hasConcurrents()
```
    是否有并发限制配置
    
    返回:
    是否配置了并发限制 boolean
  - hasValidation
```
public boolean hasValidation()
```
    除了判断自己，还有判断下面方法的自定义判断
    
    返回:
    the validation
  - hasCache
```
public boolean hasCache()
```
    是否有缓存
    
    返回:
    是否配置了cache boolean
  - hasToken
```
public boolean hasToken()
```
    是否有token配置
    
    返回:
    是否配置了token boolean
  - setMethods
```
public S setMethods(List<MethodConfig> methods)
```
    Sets methods.
    
    参数:
    methods - the methods
    
    返回:
    the methods
  - setRegistry
```
public S setRegistry(RegistryConfig registry)
```
    设置注册中心
    
    参数:
    registry - RegistryConfig
    
    返回:
    the registry
  - getConfigValueCache
```
public Map<String,Object> getConfigValueCache(boolean rebuild)
```
    接口属性和方法属性加载配置到缓存
    
    参数:
    rebuild - 是否重建
    
    返回:
    Map unmodifiableMap
  - queryAttribute
```
public String queryAttribute(String property)
```
    查询属性值
    
    参数:
    property - 属性
    
    返回:
    oldValue 属性值
  - updateAttribute
```
public boolean updateAttribute(String property,
                      String newValueStr,
                      boolean overwrite)
```
    覆盖属性，可以检查，或者更新
    
    参数:
    property - 属性
    newValueStr - 要设置的值
    overwrite - 是否覆盖 true直接覆盖，false为检查
    
    返回:
    是否有变更 boolean
  - getMethodConfigValue
```
public Object getMethodConfigValue(String methodName,
                          String configKey,
                          Object defaultValue)
```
    得到方法级配置，找不到则返回默认值
    
    参数:
    methodName - 方法名
    configKey - 配置key，例如参数
    defaultValue - 默认值
    
    返回:
    配置值 method config value
  - getMethodConfigValue
```
public Object getMethodConfigValue(String methodName,
                          String configKey)
```
    得到方法级配置，找不到则返回null
    
    参数:
    methodName - 方法名
    configKey - 配置key，例如参数
    
    返回:
    配置值 method config value
  - setParameter
```
public S setParameter(String key,
             String value)
```
    Sets parameter.
    
    参数:
    key - the key
    value - the value
    
    返回:
    the parameter
  - getParameter
```
public String getParameter(String key)
```
    Gets parameter.
    
    参数:
    key - the key
    
    返回:
    the value
  - getAppName
```
public String getAppName()
```
    Gets app name.
    
    返回:
    the app name

类 AbstractInterfaceConfig<T,S extends AbstractInterfaceConfig>

字段概要

构造器概要

方法概要

从类继承的方法 com.alipay.sofa.rpc.config.AbstractIdConfig

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

字段详细资料

application

interfaceId

uniqueId

filterRef

filter

registry

methods

serialization

register

subscribe

proxy

group

version

cacheRef

mockRef

parameters

cache

mock

validation

compress

configValueCache

proxyClass

configListener

构造器详细资料

AbstractInterfaceConfig

方法详细资料

getProxyClass

buildKey

getApplication

setApplication

getInterfaceId

setInterfaceId

getUniqueId

setUniqueId

getFilterRef

setFilterRef

getFilter

setFilter

getRegistry

setRegistry

getMethods

setMethods

getSerialization

setSerialization

isRegister

setRegister

isSubscribe

setSubscribe

getProxy

setProxy

getGroup

setGroup

getVersion

setVersion

getCacheRef

setCacheRef

getMockRef

setMockRef

getParameters

setParameters

isMock

setMock

isValidation

setValidation

getCompress

setCompress

isCache

setCache

getConfigValueCache

setConfigListener

getConfigListener

hasTimeout

hasConcurrents