蚂蚁金服SOFA-Boot整合SOFA-RPC（下篇）

前言

上文介绍了SOFA-RPC 的几种调用方式，包括单向调用、同步调用、Future调用、回调，引入了泛化调用和过滤器。本文将对 SOFA-RPC 的高级功能，包括参数配置、自定义线程池、预热权重和自动故障剔除等。

其余文章

• 蚂蚁金服RPC框架SOFA-RPC初体验

• 蚂蚁金服SOFA-Boot整合SOFA-RPC（上篇）

• 蚂蚁金服SOFA-Boot整合SOFA-RPC（中篇）

• 蚂蚁金服SOFA-Boot整合SOFA-RPC（下篇）

正文

1. 参数配置

SOFABoot RPC Starter 提供了方便的参数设置方式。这些参数目前能够分为两个部分。一部分是如端口，注册中心地址等配置，这类配置在 application.properties 中。另外一部分是如超时时间等配置，这类配置在 XML 中。

XML 配置

• 调用超时时间

以下是设置超时时间的方式，单位为 ms ，若是调用超过了这个时间则会抛出异常。服务端和客户端均可以设置，以客户端的超时时间设置优先。默认客户端为 3000 ，目前对 bolt，rest，dubbo 生效。

<sofa:binding.bolt>
    <sofa:global-attrs timeout="5000"/>
</sofa:binding.bolt>
复制代码

• 获取地址等待时间

以下是设置获取地址等待时间，单位为ms。在启动时若是服务引用方等待超过了这个时间则不会再等待地址，会继续启动。客户端设置，默认为-1，表示会一直等待到地址为止。目前对 bolt，rest 生效。

<sofa:binding.bolt>
    <sofa:global-attrs address-wait-time="30000"/>
</sofa:binding.bolt>
复制代码

• 创建链接超时时间

以下是设置创建链接超时时间，单位为 ms 。在创建链接时若是耗时超过了这个时间则会抛出异常。客户端设，默认为 5000。目前对 bolt，rest 生效。

<sofa:binding.bolt>
    <sofa:global-attrs connect.timeout="30000"
</sofa:binding.bolt>
复制代码

• 权重

以下是设置权重。客户端在发起调用时，若是采用的算法是随机调用，则会根据该权重来进行随机。服务端设置，默认为 100。目前对 bolt 生效。

<sofa:binding.bolt>
    <sofa:global-attrs weight="200"/>
</sofa:binding.bolt>
复制代码

• lazy 链接

默认状况下客户端在注册中心推送地址到客户端时，就当即创建好链接，这个过程一般是在第一次调用以前进行的。若是设置服务引用的属性 lazy 为 true，客户端在第一次调用时才和所要调用的远程地址创建链接。默认为 false。

以下设置 lazy 链接方式，将 lazy 属性设为 true。目前支持 bolt 和 dubbo 协议。

<sofa:reference id="lazyServiceReferenceBolt" interface="com.ostenant.sofa.rpc.example.lazy.LazyService">
    <sofa:binding.bolt>
        <sofa:global-attrs lazy="true"/>
    </sofa:binding.bolt>
</sofa:reference>
复制代码

• check 属性

默认状况下客户端在启动时，服务引用不要求存在可用的地址和链接。若是设置服务引用的属性 check 为 true，客户端在启动时，服务引用会检查是否存在对应的地址和链接，若是不存在会抛出异常。默认为 false。

以下设置 check 链接方式，将 check 属性设为 true。目前支持 bolt 和 dubbo 协议。

<sofa:reference id="checkServiceReferenceBolt" interface="com.ostenant.sofa.rpc.example.check.CheckService">
    <sofa:binding.bolt>
        <sofa:global-attrs check="true"/>
    </sofa:binding.bolt>
</sofa:reference>
复制代码

• 重试次数

重试次数，即在第一次调用失败后重试的最大次数，若是重试成功则再也不继续重试。默认为 0。以下设置调用次数，利用 retries 属性指定重试次数。目前支持 bolt 和 dubbo 协议。

<sofa:reference id="retriesServiceReferenceBolt" interface="com.ostenant.sofa.rpc.example.retries.RetriesService">
    <sofa:binding.bolt>
        <sofa:global-attrs retries="2"/>
    </sofa:binding.bolt>
</sofa:reference>
复制代码

• 负载均衡

以下选择负载均衡的方式，利用 loadBalancer 属性指定调用时候使用的负载均衡策略，默认为 random。

目前支持 random，localPref，roundRobin，consistentHash，weightRoundRobin 五种负载均衡策略，具体可见 SOFARPC 负载均衡相关介绍。目前支持bolt协议。

<sofa:reference id="loadBalancerServiceReference" interface="com.ostenant.sofa.rpc.example.loadBalancer.LoadBalancerService">
    <sofa:binding.bolt>
        <sofa:global-attrs loadBalancer="random"/>
    </sofa:binding.bolt>
</sofa:reference>
复制代码

• 方法级别配置

以下，sofa:method 元素是方法级别的配置。方法级别的配置优先级比服务级别的更高。name 属性指定了方法的名字。支持调用超时时间，调用方式，回调类的设置。方法级别的配置与服务级别的配置所生效的协议同样。

<sofa:binding.bolt>
    <sofa:method name="sayMethod" timeout="3000" type="sync" callback-ref="xxx"/>
</sofa:binding.bolt>
复制代码

Properties 配置

属性	描述	默认值
spring.application.name	应用名
logging.path	日志路径
logging.level.com.alipay.sofa.rpc.boot	sofa-rpc-boot-start的日志级别(starter自身的日志)	info
logging.level.com.alipay.sofa.rpc	sofa-rpc的日志级别(sofa-rpc核心日志基本在这里)	info
com.alipay.sofa.rpc.bolt.port	bolt 端口	22000
com.alipay.sofa.rpc.bolt.io.thread.count	bolt 的 io 线程数
com.alipay.sofa.rpc.bolt.executor.thread.count	bolt 的业务线程最大值	200
com.alipay.sofa.rpc.bolt.accepts.count	bolt 可以支持的最大长链接数	100000
com.alipay.sofa.rpc.rest.hostname	rest 的 hostname
com.alipay.sofa.rpc.rest.port	rest 端口	8341
com.alipay.sofa.rpc.rest.io.thread.count	rest 的 io 线程数	cpu 核数 * 2
com.alipay.sofa.rpc.rest.executor.thread.count	rest 的业务线程数	200
com.alipay.sofa.rpc.rest.max.request.size	rest 的最大 byte 请求长度	1024 * 1024 * 10
com.alipay.sofa.rpc.rest.telnet	rest 是否支持 telnet	true
com.alipay.sofa.rpc.rest.daemon	rest 是否支持 daemon	true
com.alipay.sofa.rpc.dubbo.port	dubbo 的端口	20880
com.alipay.sofa.rpc.dubbo.io.thread.count	dubbo 的 io 线程数	cpu 核数 + 1
com.alipay.sofa.rpc.dubbo.executor.thread.count	dubbo 的业务线程数	100
com.alipay.sofa.rpc.dubbo.accepts.count	dubbo可以支持的最大长链接数	0，表示不限制

2. 自定义线程池

SOFA-RPC 支持自定义业务线程池。能够为指定服务设置一个独立的业务线程池，和 SOFA-RPC 自身的业务线程池是隔离的，多个服务能够共用一个独立的线程池。目前支持 bolt 协议。

在 SOFA-Boot 环境中能够为一个服务设置一个自定义线程池，配置以下：

• 声明自定义线程池

以下声明一个自定义线程池，class 必须为 com.alipay.sofa.rpc.server.UserThreadPool，这是 SOFA-RPC 提供的类，init-method="init" 也必须声明以进行初始化。

<bean id="customerThreadPool" class="com.alipay.sofa.rpc.server.UserThreadPool" init-method="init">
    <property name="corePoolSize" value="10"/>
    <property name="maximumPoolSize" value="10"/>
    <property name="queueSize" value="5"/>
    <property name="threadPoolName" value="customerThreadPool_name"/>
</bean>
复制代码

• 为服务设置自定义线程池

以下经过 sofa:global-attrs 元素的 thread-pool-ref 属性为该服务设置自定义线程池。customerThreadPool 是上面自定义线程池的 bean id。

<bean id="threadPoolServiceImpl" class="com.ostenant.sofa.rpc.example.threadpool.ThreadPoolServiceImpl"/>
<sofa:service ref="threadPoolServiceImpl" interface="com.alipay.sofa.rpc.samples.threadpool.ThreadPoolService">
    <sofa:binding.bolt>
        <sofa:global-attrs thread-pool-ref="customerThreadPool"/>
    </sofa:binding.bolt>
</sofa:service>
复制代码

3. 预热权重

SOFA-RPC 提供了预热权重功能让客户端机器可以根据服务端的相应权重进行流量的分发。目前支持 bolt 协议。

SOFA-Boot 中提供了一系列参数属性，对指定服务进行预热配置。客户端机器可以自动解析这些参数，并按权重进行流量分发。

• warm-up-time: 服务的预热时间
• warm-up-weight: 服务设置预热期间权重
• weight: 服务设置预热完后的权重

<sofa:reference id="sampleRestFacadeReferenceBolt" interface="com.alipay.sofa.endpoint.facade.SampleFacade">
    <sofa:binding.bolt>
         <sofa:global-attrs warm-up-time="10000" warm-up-weight="10" weight="100"/>
     </sofa:binding.bolt>
</sofa:reference>
复制代码

上述配置中，该服务的预热期为10s，在预热期内权重为10，预热期结束后的正常权重为100。

若是该服务一共发布到A，B两个机器上。A机器正处于预热期内，使用上述配置；B已经完成预热，正常权重为200。那么客户端在调用的时候，此时流量分发的比重为10：200；A机器预热结束后，流量分发比重为100：200。

4. 自动故障剔除

自动故障剔除会自动监控 RPC 调用的状况，对故障节点进行权重降级，并在节点恢复健康时进行权重恢复。目前支持 bolt 协议。

在 SOFA-Boot 中，只须要将自动故障剔除的参数配置到 application.properties 便可。只配置本身关心的参数，其他参数会取默认值。须要注意的是，rpc.aft.regulation.effective 是该功能的全局开关，若是关闭则该功能不会运行，其余参数也都不生效。

• 自动故障剔除的配置参数意义

属性	描述	默认值
com.alipay.sofa.rpc.aft.time.window	时间窗口大小：对统计信息计算的周期。	10s
com.alipay.sofa.rpc.aft.least.window.count	时间窗口内最少调用数：只有在时间窗口内达到了该最低值的数据才会被加入到计算和调控中。	10次
com.alipay.sofa.rpc.aft.least.window.exception.rate.multiple	时间窗口内异常率与服务平均异常率的降级比值：在对统计信息进行计算的时候，会计算出该服务全部有效调用ip的平均异常率，若是某个ip的异常率大于等于了这个最低比值，则会被降级。	6倍
com.alipay.sofa.rpc.aft.weight.degrade.rate	降级比率：地址在进行权重降级时的降级比率。	1/20
com.alipay.sofa.rpc.aft.weight.recover.rate	恢复比率：地址在进行权重恢复时的恢复比率。	2倍
com.alipay.sofa.rpc.aft.degrade.effective	降级开关：若是应用打开了这个开关，则会对符合降级的地址进行降级，不然只会进行日志打印。	false(关闭)
com.alipay.sofa.rpc.aft.degrade.least.weight	降级最小权重：地址权重被降级后的值若是小于这个最小权重，则会以该最小权重做为降级后的值。	0
com.alipay.sofa.rpc.aft.degrade.max.ip.count	降级的最大ip数：同一个服务被降级的ip数不能超过该值。	2
com.alipay.sofa.rpc.aft.regulation.effective	全局开关：若是应用打开了这个开关，则会开启整个单点故障自动剔除摘除功能，不然彻底不进入该功能的逻辑。	false(关闭)

• 配置示例

com.alipay.sofa.rpc.aft.time.window=20
com.alipay.sofa.rpc.aft.least.window.count=30
com.alipay.sofa.rpc.aft.least.window.exception.rate.multiple=6
com.alipay.sofa.rpc.aft.weight.degrade.rate=0.5
com.alipay.sofa.rpc.aft.weight.recover.rate=1.2
com.alipay.sofa.rpc.aft.degrade.effective=ture
com.alipay.sofa.rpc.aft.degrade.least.weight=1
com.alipay.sofa.rpc.aft.degrade.max.ip.count=2
com.alipay.sofa.rpc.aft.regulation.effective=true
复制代码

上述配置中，默认打开了自动故障剔除功能和降级开关。当节点出现故障时会被进行权重降级，在恢复时会被进行权重恢复。

每隔 20s 进行一次节点健康状态的度量，20s 内调用次数超过 30 次的节点才被做为计算数据。

若是单个节点的异常率超过了全部节点的平均异常率的 6 倍，则对该节点进行权重降级，降级的比率为 0.5。权重最小降级到 1。若是单个节点的异常率低于了平均异常率的 6 倍，则对该节点进行权重恢复，恢复的比率为1.2。单个服务最多降级 2 个 IP。

小结

本文介绍了 SOFA-RPC 的高级功能，包括参数配置，自定义线程池，服务预热和自动降级与权重恢复等用法。对于 SOFA-RPC 提供的基本功能，以及整合 SOFA-Boot 的配置和用法就介绍完了。对此有了初步的认识后，有利于后续深刻实现原理和剖析源码。

---

欢迎关注技术公众号： 零壹技术栈

本账号将持续分享后端技术干货，包括虚拟机基础，多线程编程，高性能框架，异步、缓存和消息中间件，分布式和微服务，架构学习和进阶等学习资料和文章。