序列化表格

程序包 com.alipay.sofa.rpc.client

类com.alipay.sofa.rpc.client.ProviderInfo扩展Object实现可序列化

serialVersionUID:

-6438690329875954051L

序列化字段

protocolType

String protocolType

The Protocol type.

host

String host

The Ip.

port

int port

The Port.

path

String path

The path

serializationType

String serializationType

序列化方式，服务端指定，以服务端的为准

rpcVersion

int rpcVersion

The rpc Version

staticAttrs

ConcurrentHashMap<K,V> staticAttrs

静态属性，不会变的

程序包 com.alipay.sofa.rpc.codec.snappy

类com.alipay.sofa.rpc.codec.snappy.CorruptionException扩展RuntimeException实现可序列化

程序包 com.alipay.sofa.rpc.common.json

类com.alipay.sofa.rpc.common.json.ParseException扩展RuntimeException实现可序列化

serialVersionUID:

2560442967697088006L

序列化字段

position

int position

jsonString

String jsonString

程序包 com.alipay.sofa.rpc.common.struct

类com.alipay.sofa.rpc.common.struct.ConcurrentHashSet扩展AbstractSet<E>实现可序列化

serialVersionUID:

-8672117787651310382L

序列化字段

map

ConcurrentHashMap<K,V> map

类com.alipay.sofa.rpc.common.struct.OrderedComparator扩展Object实现可序列化

序列化字段

order

boolean order

顺序（true:从小到大）还是倒序（false:从大到小）

程序包 com.alipay.sofa.rpc.config

类com.alipay.sofa.rpc.config.AbstractIdConfig扩展Object实现可序列化

serialVersionUID:

-1932911135229369183L

序列化字段

id

String id

config id

类com.alipay.sofa.rpc.config.AbstractInterfaceConfig扩展AbstractIdConfig<S extends AbstractInterfaceConfig>实现可序列化

serialVersionUID:

-8738241729920479618L

序列化字段

application

ApplicationConfig application

应用信息

interfaceId

String interfaceId

服务接口：做为服务唯一标识的组成部分
不管普通调用和泛化调用，都是设置实际的接口类名称，

另请参阅:

AbstractInterfaceConfig.uniqueId

uniqueId

String uniqueId

服务标签：做为服务唯一标识的组成部分

另请参阅:

AbstractInterfaceConfig.interfaceId

filter

List<E> filter

过滤器配置别名，多个用逗号隔开

registry

List<E> registry

注册中心配置，可配置多个

methods

Map<K,V> methods

方法配置，可配置多个

serialization

String serialization

默认序列化

register

boolean register

是否注册，如果是false只订阅不注册

subscribe

boolean subscribe

是否订阅服务

proxy

String proxy

代理类型

group

String group

已过时。 不再作为服务唯一标识，请直接使用 AbstractInterfaceConfig.uniqueId 代替

服务分组：不做为服务唯一标识的一部分

version

String version

已过时。 从5.4.0开始，不再作为服务唯一标识，请直接使用 AbstractInterfaceConfig.uniqueId 代替

服务版本：不做为服务唯一标识的一部分

另请参阅:

AbstractInterfaceConfig.interfaceId, AbstractInterfaceConfig.uniqueId

parameters

Map<K,V> parameters

自定义参数

cache

boolean cache

是否启动结果缓存

mock

boolean mock

是否开启mock

validation

boolean validation

是否开启参数验证(jsr303)

compress

String compress

压缩算法，为空则不压缩

类com.alipay.sofa.rpc.config.ApplicationConfig扩展Object实现可序列化

序列化字段

appName

String appName

The App name.

appId

String appId

The App id.

insId

String insId

The Ins id.

类com.alipay.sofa.rpc.config.ConsumerConfig扩展AbstractInterfaceConfig<T,ConsumerConfig<T>>实现可序列化

serialVersionUID:

4244077707655448146L

序列化字段

protocol

String protocol

调用的协议

directUrl

String directUrl

直连调用地址

generic

boolean generic

是否泛化调用

invokeType

String invokeType

是否异步调用

connectTimeout

int connectTimeout

连接超时时间

disconnectTimeout

int disconnectTimeout

关闭超时时间（如果还有请求，会等待请求结束或者超时）

cluster

String cluster

集群处理，默认是failover

connectionHolder

String connectionHolder

The ConnectionHolder 连接管理器

addressHolder

String addressHolder

地址管理器

loadBalancer

String loadBalancer

负载均衡

lazy

boolean lazy

是否延迟建立长连接（第一次调用时新建，注意此参数可能和check冲突，开启check后lazy自动失效）

另请参阅:

ConsumerConfig.check

sticky

boolean sticky

粘滞连接，一个断开才选下一个 change transport when current is disconnected

inJVM

boolean inJVM

是否jvm内部调用（provider和consumer配置在同一个jvm内，则走本地jvm内部，不走远程）

check

boolean check

是否强依赖（即没有服务节点就启动失败，注意此参数可能和lazy冲突，开启check后lazy自动失效)

另请参阅:

ConsumerConfig.lazy

connectionNum

int connectionNum

长连接个数，不是所有的框架都支持一个地址多个长连接

heartbeatPeriod

int heartbeatPeriod

Consumer给Provider发心跳的间隔

reconnectPeriod

int reconnectPeriod

Consumer给Provider重连的间隔

router

List<E> router

路由配置别名

bootstrap

String bootstrap

启动器

addressWait

int addressWait

等待地址获取时间(毫秒)，-1表示等到拿到地址位置

repeatedReferLimit

int repeatedReferLimit

同一个服务（接口协议uniqueId相同）的最大引用次数，防止由于代码bug导致重复引用，每次引用都会生成一个代理类对象，-1表示不检查

从以下版本开始:

5.2.0

timeout

int timeout

客户端调用超时时间(毫秒)

retries

int retries

The Retries. 失败后重试次数

concurrents

int concurrents

接口下每方法的最大可并行执行请求数，配置-1关闭并发过滤器，等于0表示开启过滤但是不限制

类com.alipay.sofa.rpc.config.MethodConfig扩展Object实现可序列化

serialVersionUID:

-8594337650648536897L

序列化字段

name

String name

方法名称，无法做到重载方法的配置

parameters

Map<K,V> parameters

The Parameters. 自定义参数

timeout

Integer timeout

The Timeout. 远程调用超时时间(毫秒)

retries

Integer retries

The Retries. 失败后重试次数

invokeType

String invokeType

调用方式

validation

Boolean validation

The Validation. 是否jsr303验证

onReturn

SofaResponseCallback<T> onReturn

返回值之前的listener

concurrents

Integer concurrents

最大并发执行（不管服务端还是客户端）

cache

Boolean cache

是否启用客户端缓存

compress

String compress

是否启动压缩

dstParam

Integer dstParam

目标参数（机房/分组）索引，第一个参数从0开始 // TODO 待实现

类com.alipay.sofa.rpc.config.ParameterConfig扩展Object实现可序列化

serialVersionUID:

-8438415130253334898L

序列化字段

key

String key

关键字

value

String value

值

hide

boolean hide

是否隐藏（是的话，业务代码不能获取到）

类com.alipay.sofa.rpc.config.ProviderConfig扩展AbstractInterfaceConfig<T,ProviderConfig<T>>实现可序列化

serialVersionUID:

-3058073881775315962L

序列化字段

server

List<E> server

配置的协议列表

delay

int delay

服务发布延迟,单位毫秒，默认0，配置为-1代表spring加载完毕（通过spring才生效）

weight

int weight

权重

include

String include

包含的方法

exclude

String exclude

不发布的方法列表，逗号分隔

dynamic

boolean dynamic

是否动态注册，默认为true，配置为false代表不主动发布，需要到管理端进行上线操作

priority

int priority

服务优先级，越大越高

bootstrap

String bootstrap

启动器

timeout

int timeout

服务端执行超时时间(毫秒)，不会打断执行线程，只是打印警告

concurrents

int concurrents

接口下每方法的最大可并行执行请求数，配置-1关闭并发过滤器，等于0表示开启过滤但是不限制

repeatedExportLimit

int repeatedExportLimit

同一个服务（接口协议uniqueId相同）的最大发布次数，防止由于代码bug导致重复发布。注意：后面的发布可能会覆盖前面的实现，-1表示不检查

从以下版本开始:

5.2.0

类com.alipay.sofa.rpc.config.RegistryConfig扩展AbstractIdConfig实现可序列化

serialVersionUID:

-2921019924557602234L

序列化字段

protocol

String protocol

协议

address

String address

指定注册中心的地址, 和index必须填一个，address优先

index

String index

指定注册中心寻址服务的地址, 和address必须填一个

register

boolean register

是否注册，如果是false只订阅不注册

subscribe

boolean subscribe

是否订阅服务

timeout

int timeout

调用注册中心超时时间

connectTimeout

int connectTimeout

连接注册中心超时时间

file

String file

保存到本地文件的位置，默认$HOME下

batch

boolean batch

是否批量操作

batchSize

int batchSize

定时批量检查时的条目数

heartbeatPeriod

int heartbeatPeriod

Consumer给Provider发心跳的间隔

reconnectPeriod

int reconnectPeriod

Consumer给Provider重连的间隔

parameters

Map<K,V> parameters

The Parameters. 自定义参数

类com.alipay.sofa.rpc.config.ServerConfig扩展AbstractIdConfig实现可序列化

serialVersionUID:

-574374673831680403L

序列化字段

protocol

String protocol

配置名称

host

String host

实际监听IP，与网卡对应

port

int port

监听端口

contextPath

String contextPath

基本路径

ioThreads

int ioThreads

io线程池大小

threadPoolType

String threadPoolType

线程池类型

coreThreads

int coreThreads

业务线程池大小

maxThreads

int maxThreads

业务线程池大小

telnet

boolean telnet

是否允许telnet，针对自定义协议

queueType

String queueType

线程池类型，默认普通线程池

queues

int queues

业务线程池回收时间

aliveTime

int aliveTime

线程池回收时间

preStartCore

boolean preStartCore

线程池是否初始化核心线程

accepts

int accepts

服务端允许客户端建立的连接数

payload

int payload

已过时。

最大数据包大小

serialization

String serialization

序列化方式

dispatcher

String dispatcher

已过时。

事件分发规则。

parameters

Map<K,V> parameters

The Parameters. 自定义参数

virtualHost

String virtualHost

镜像ip，例如监听地址是1.2.3.4，告诉注册中心的确是3.4.5.6

virtualPort

Integer virtualPort

镜像端口

epoll

boolean epoll

是否启动epoll

daemon

boolean daemon

是否hold住端口，true的话随主线程退出而退出，false的话则要主动退出

adaptivePort

boolean adaptivePort

The Adaptive port.

transport

String transport

传输层

autoStart

boolean autoStart

是否自动启动

stopTimeout

int stopTimeout

服务端关闭超时时间

程序包 com.alipay.sofa.rpc.core.exception

类com.alipay.sofa.rpc.core.exception.SofaRouteException扩展SofaRpcException实现可序列化

类com.alipay.sofa.rpc.core.exception.SofaRpcException扩展RuntimeException实现可序列化

序列化字段

errorType

int errorType

异常类型

类com.alipay.sofa.rpc.core.exception.SofaRpcRuntimeException扩展RuntimeException实现可序列化

类com.alipay.sofa.rpc.core.exception.SofaTimeOutException扩展SofaRpcException实现可序列化

serialVersionUID:

1L

程序包 com.alipay.sofa.rpc.core.request

类com.alipay.sofa.rpc.core.request.RequestBase扩展Object实现可序列化

serialVersionUID:

-7323141575870688636L

序列化字段

methodName

String methodName

Method name

methodArgSigs

String[] methodArgSigs

Argument type strings of method

targetServiceUniqueName

String targetServiceUniqueName

Target service unique name, contains interfaceName, uniqueId and etc.

类com.alipay.sofa.rpc.core.request.SofaRequest扩展RequestBase实现可序列化

serialVersionUID:

7329530374415722876L

序列化字段

targetAppName

String targetAppName

Target app name. If progress of 'AppA' want to call the progress which contains two apps('AppB1' and 'AppB2'), You need specified the target app name here. such as 'AppB2'

requestProps

Map<K,V> requestProps

Extensional properties of request

程序包 com.alipay.sofa.rpc.core.response

类com.alipay.sofa.rpc.core.response.SofaResponse扩展Object实现可序列化

serialVersionUID:

-4364536436151723421L

序列化字段

isError

boolean isError

框架异常

errorMsg

String errorMsg

框架异常的消息

appResponse

Object appResponse

业务返回或者业务异常

responseProps

Map<K,V> responseProps

extensional properties

程序包 com.alipay.sofa.rpc.log.exception

类com.alipay.sofa.rpc.log.exception.LogCodeNotFoundException扩展RuntimeException实现可序列化

类com.alipay.sofa.rpc.log.exception.LogFormatException扩展RuntimeException实现可序列化