配置项参考手册

包含 Dubbo 支持的所有配置组件及每个配置组件支持的所有配置项

配置详情

application

每个应用必须要有且只有一个 application 配置,对应的配置类:org.apache.dubbo.config.ApplicationConfig

属性对应URL参数类型是否必填缺省值作用描述兼容性
nameapplicationstring必填服务治理当前应用名称,用于注册中心计算应用间依赖关系,注意:消费者和提供者应用名不要一样,此参数不是匹配条件,你当前项目叫什么名字就填什么,和提供者消费者角色无关,比如:kylin应用调用了morgan应用的服务,则kylin项目配成kylin,morgan项目配成morgan,可能kylin也提供其它服务给别人使用,但kylin项目永远配成kylin,这样注册中心将显示kylin依赖于morgan2.7.0以上版本
compilercompilerstring可选javassist性能优化Java字节码编译器,用于动态类的生成,可选:jdk或javassist2.7.0以上版本
loggerloggerstring可选slf4j性能优化日志输出方式,可选:slf4j,jcl,log4j,log4j2,jdk2.7.0以上版本
ownerownerstring可选服务治理应用负责人,用于服务治理,请填写负责人公司邮箱前缀2.0.5以上版本
organizationorganizationstring可选服务治理组织名称(BU或部门),用于注册中心区分服务来源,此配置项建议不要使用autoconfig,直接写死在配置中,比如china,intl,itu,crm,asc,dw,aliexpress等2.0.0以上版本
architecture
architecture
string可选服务治理用于服务分层对应的架构。如,intl、china。不同的架构使用不同的分层。2.0.7以上版本
environmentenvironmentstring可选服务治理应用环境,如:develop/test/product,不同环境使用不同的缺省值,以及作为只用于开发测试功能的限制条件2.0.0以上版本
versionapplication.versionstring可选服务治理当前应用的版本2.7.0以上版本
dumpDirectorydump.directorystring可选服务治理当进程出问题如线程池满时,框架自动dump文件的存储路径2.7.0以上版本
qosEnableqos.enableboolean可选服务治理是否启用 qos 运维端口2.7.0以上版本
qosHostqos.hoststring可选服务治理监听的网络接口地址,默认 0.0.0.02.7.3以上版本
qosPortqos.portint可选服务治理监听的网络端口2.7.0以上版本
qosAcceptForeignIpqos.accept.foreign.ipboolean可选服务治理安全配置,是否接收除localhost本机访问之外的外部请求2.7.0以上版本
shutwaitdubbo.service.shutdown.waitstring可选服务治理优雅停机时 shutdown 的等待时间(ms)2.7.0以上版本
hostnamestring可选本机主机名服务治理主机名2.7.5以上版本
registerConsumerregisterConsumerboolean可选true服务治理是否注册实例到注册中心。当时实例为纯消费者时才设置为false2.7.5以上版本
repositoryapplication.versionstring可选服务治理当前应用的版本2.7.6以上版本
enableFileCachefile.cacheboolean可选true服务治理是否开启本地缓存3.0.0以上版本
protocolstring可选dubbo服务治理首选协议,适用于无法确定首选协议的时候3.0.0以上版本
metadataTypemetadata-typeString可选local服务治理应用级服务发现 metadata 传递方式,是以 Provider 视角而言的,Consumer 侧配置无效,可选值有:
* remote - Provider 把 metadata 放到远端注册中心,Consumer 从注册中心获取;
* local - Provider 把 metadata 放在本地,Consumer 从 Provider 处直接获取;
2.7.5以上版本
metadataServiceProtocolmetadata-service-protocolstring可选dubbo服务治理如 metadataType 配置为 local,则该属性设置 MetadataService 服务所用的通信协议,默认为 dubbo3.0.0以上版本
metadataServicePortmetadata-service-portint可选服务治理如 metadataType 配置为 local,则该属性设置 MetadataService 服务所用的端口号2.7.9以上版本
livenessProbeliveness-probestring可选服务治理概念和格式对应 k8s 体系 liveness probe3.0.0以上版本
readinessProbereadiness-probestring可选服务治理概念和格式对应 k8s 体系 readiness probe3.0.0以上版本
startupProbestartup-probestring可选服务治理概念和格式对应 k8s 体系 startup probe3.0.0以上版本
registerModeregister-modestring可选all服务治理控制地址注册行为,应用级服务发现迁移用。
* instance 只注册应用级地址;
* interface 只注册接口级地址;
* all(默认) 同时注册应用级和接口级地址;
3.0.0以上版本
enableEmptyProtectionenable-empty-protectionboolean可选true服务治理是否全局启用消费端的空地址列表保护,开启后注册中心的空地址推送将被忽略,默认 true3.0.0以上版本
parametersMap<string, string>可选服务治理扩展预留,可扩展定义任意参数,所有扩展参数都将原样反映在 URL 配置上2.7.0以上版本

service

服务提供者暴露服务配置。对应的配置类:org.apache.dubbo.config.ServiceConfig

属性对应URL参数类型是否必填缺省值作用描述兼容性
interfaceclass必填服务发现服务接口名1.0.0以上版本
refobject必填服务发现服务对象实现引用1.0.0以上版本
versionversionstring可选0.0.0服务发现服务版本,建议使用两位数字版本,如:1.0,通常在接口不兼容时版本号才需要升级1.0.0以上版本
groupgroupstring可选服务发现服务分组,当一个接口有多个实现,可以用分组区分1.0.7以上版本
path<path>string可选缺省为接口名服务发现服务路径 (注意:1.0不支持自定义路径,总是使用接口名,如果有1.0调2.0,配置服务路径可能不兼容)1.0.12以上版本
delaydelayint可选0性能调优延迟注册服务时间(毫秒) ,设为-1时,表示延迟到Spring容器初始化完成时暴露服务1.0.14以上版本
timeouttimeoutint可选1000性能调优远程服务调用超时时间(毫秒)2.0.0以上版本
retriesretriesint可选2性能调优远程服务调用重试次数,不包括第一次调用,不需要重试请设为02.0.0以上版本
connectionsconnectionsint可选100性能调优对每个提供者的最大连接数,rmi、http、hessian等短连接协议表示限制连接数,dubbo等长连接协表示建立的长连接个数2.0.0以上版本
loadbalanceloadbalancestring可选random性能调优负载均衡策略,可选值:
* random - 随机;
* roundrobin - 轮询;
* leastactive - 最少活跃调用;
* consistenthash - 哈希一致 (2.1.0以上版本);
* shortestresponse - 最短响应 (2.7.7以上版本);
2.0.0以上版本
asyncasyncboolean可选false性能调优是否缺省异步执行,不可靠异步,只是忽略返回值,不阻塞执行线程2.0.0以上版本
locallocalclass/boolean可选false服务治理设为true,表示使用缺省代理类名,即:接口名 + Local后缀,已废弃,请使用stub2.0.0以上版本
stubstubclass/boolean可选false服务治理设为true,表示使用缺省代理类名,即:接口名 + Stub后缀,服务接口客户端本地代理类名,用于在客户端执行本地逻辑,如本地缓存等,该本地代理类的构造函数必须允许传入远程代理对象,构造函数如:public XxxServiceStub(XxxService xxxService)2.0.0以上版本
mockmockclass/boolean可选false服务治理设为true,表示使用缺省Mock类名,即:接口名 + Mock后缀,服务接口调用失败Mock实现类,该Mock类必须有一个无参构造函数,与Local的区别在于,Local总是被执行,而Mock只在出现非业务异常(比如超时,网络异常等)时执行,Local在远程调用之前执行,Mock在远程调用后执行。2.0.0以上版本
tokentokenstring/boolean可选false服务治理令牌验证,为空表示不开启,如果为true,表示随机生成动态令牌,否则使用静态令牌,令牌的作用是防止消费者绕过注册中心直接访问,保证注册中心的授权功能有效,如果使用点对点调用,需关闭令牌功能2.0.0以上版本
registrystring可选缺省向所有registry注册配置关联向指定注册中心注册,在多个注册中心时使用,值为<dubbo:registry>的id属性,多个注册中心ID用逗号分隔,如果不想将该服务注册到任何registry,可将值设为N/A2.0.0以上版本
providerstring可选缺省使用第一个provider配置配置关联指定provider,值为<dubbo:provider>的id属性2.0.0以上版本
deprecateddeprecatedboolean可选false服务治理服务是否过时,如果设为true,消费方引用时将打印服务过时警告error日志2.0.5以上版本
dynamicdynamicboolean可选true服务治理服务是否动态注册,如果设为false,注册后将显示后disable状态,需人工启用,并且服务提供者停止时,也不会自动取消册,需人工禁用。2.0.5以上版本
accesslogaccesslogstring/boolean可选false服务治理设为true,将向logger中输出访问日志,也可填写访问日志文件路径,直接把访问日志输出到指定文件2.0.5以上版本
ownerownerstring可选服务治理服务负责人,用于服务治理,请填写负责人公司邮箱前缀2.0.5以上版本
documentdocumentstring可选服务治理服务文档URL2.0.5以上版本
weightweightint可选性能调优服务权重2.0.5以上版本
executesexecutesint可选0性能调优服务提供者每服务每方法最大可并行执行请求数2.0.5以上版本
activesactivesint可选0性能调优每服务消费者每服务每方法最大并发调用数2.0.5以上版本
proxyproxystring可选javassist性能调优生成动态代理方式,可选:jdk/javassist2.0.5以上版本
clusterclusterstring可选failover性能调优集群方式,可选:failover/failfast/failsafe/failback/forking/available/mergeable(2.1.0以上版本)/broadcast(2.1.0以上版本)/zone-aware(2.7.5以上版本)2.0.5以上版本
filterservice.filterstring可选default性能调优服务提供方远程调用过程拦截器名称,多个名称用逗号分隔2.0.5以上版本
listenerexporter.listenerstring可选default性能调优服务提供方导出服务监听器名称,多个名称用逗号分隔
protocolstring可选配置关联使用指定的协议暴露服务,在多协议时使用,值为<dubbo:protocol>的id属性,多个协议ID用逗号分隔2.0.5以上版本
layerlayerstring可选服务治理服务提供者所在的分层。如:biz、dao、intl:web、china:acton。2.0.7以上版本
registerregisterboolean可选true服务治理该协议的服务是否注册到注册中心2.0.8以上版本
validationvalidationstring可选服务治理是否启用JSR303标准注解验证,如果启用,将对方法参数上的注解进行校验2.7.0以上版本
parametersMap<string, string>可选服务治理扩展预留,可扩展定义任意参数,所有扩展参数都将原样反映在 URL 配置上2.0.0以上版本

reference

服务消费者引用服务配置。对应的配置类: org.apache.dubbo.config.ReferenceConfig

属性对应URL参数类型是否必填缺省值作用描述兼容性
idstring必填配置关联服务引用BeanId1.0.0以上版本
interfaceclass必填服务发现服务接口名1.0.0以上版本
versionversionstring可选服务发现服务版本,与服务提供者的版本一致1.0.0以上版本
groupgroupstring可选服务发现服务分组,当一个接口有多个实现,可以用分组区分,必需和服务提供方一致1.0.7以上版本
timeouttimeoutlong可选缺省使用<dubbo:consumer>的timeout性能调优服务方法调用超时时间(毫秒)1.0.5以上版本
retriesretriesint可选缺省使用<dubbo:consumer>的retries性能调优远程服务调用重试次数,不包括第一次调用,不需要重试请设为02.0.0以上版本
connectionsconnectionsint可选缺省使用<dubbo:consumer>的connections性能调优对每个提供者的最大连接数,rmi、http、hessian等短连接协议表示限制连接数,dubbo等长连接协表示建立的长连接个数2.0.0以上版本
loadbalanceloadbalancestring可选缺省使用<dubbo:consumer>的loadbalance性能调优负载均衡策略,可选值:
* random - 随机;
* roundrobin - 轮询;
* leastactive - 最少活跃调用;
* consistenthash - 哈希一致 (2.1.0以上版本);
* shortestresponse - 最短响应 (2.7.7以上版本);
2.0.0以上版本
asyncasyncboolean可选缺省使用<dubbo:consumer>的async性能调优是否异步执行,不可靠异步,只是忽略返回值,不阻塞执行线程2.0.0以上版本
genericgenericboolean可选缺省使用<dubbo:consumer>的generic服务治理是否缺省泛化接口,如果为泛化接口,将返回GenericService2.0.0以上版本
checkcheckboolean可选缺省使用<dubbo:consumer>的check服务治理启动时检查提供者是否存在,true报错,false忽略2.0.0以上版本
urlurlstring可选服务治理点对点直连服务提供者地址,将绕过注册中心1.0.6以上版本
stubstubclass/boolean可选服务治理服务接口客户端本地代理类名,用于在客户端执行本地逻辑,如本地缓存等,该本地代理类的构造函数必须允许传入远程代理对象,构造函数如:public XxxServiceLocal(XxxService xxxService)2.0.0以上版本
mockmockclass/boolean可选服务治理服务接口调用失败Mock实现类名,该Mock类必须有一个无参构造函数,与Local的区别在于,Local总是被执行,而Mock只在出现非业务异常(比如超时,网络异常等)时执行,Local在远程调用之前执行,Mock在远程调用后执行。Dubbo1.0.13及其以上版本支持
cachecachestring/boolean可选服务治理以调用参数为key,缓存返回结果,可选:lru, threadlocal, jcache等Dubbo2.1.0及其以上版本支持
validationvalidationboolean可选服务治理是否启用JSR303标准注解验证,如果启用,将对方法参数上的注解进行校验Dubbo2.1.0及其以上版本支持
proxyproxyboolean可选javassist性能调优选择动态代理实现策略,可选:javassist, jdk2.0.2以上版本
clientclientstring可选性能调优客户端传输类型设置,如Dubbo协议的netty或mina。Dubbo2.0.0以上版本支持
registrystring可选缺省将从所有注册中心获服务列表后合并结果配置关联从指定注册中心注册获取服务列表,在多个注册中心时使用,值为<dubbo:registry>的id属性,多个注册中心ID用逗号分隔2.0.0以上版本
ownerownerstring可选服务治理调用服务负责人,用于服务治理,请填写负责人公司邮箱前缀2.0.5以上版本
activesactivesint可选0性能调优每服务消费者每服务每方法最大并发调用数2.0.5以上版本
clusterclusterstring可选failover性能调优集群方式,可选:failover/failfast/failsafe/failback/forking/available/mergeable(2.1.0以上版本)/broadcast(2.1.0以上版本)/zone-aware(2.7.5以上版本)2.0.5以上版本
connectionsconnectionsint可选100性能调优对每个提供者的最大连接数,rmi、http、hessian等短连接协议表示限制连接数,dubbo等长连接协表示建立的长连接个数2.0.0以上版本
filterreference.filterstring可选default性能调优服务消费方远程调用过程拦截器名称,多个名称用逗号分隔2.0.5以上版本
listenerinvoker.listenerstring可选default性能调优服务消费方引用服务监听器名称,多个名称用逗号分隔2.0.5以上版本
layerlayerstring可选服务治理服务调用者所在的分层。如:biz、dao、intl:web、china:acton。2.0.7以上版本
initinitboolean可选false性能调优是否在afterPropertiesSet()时饥饿初始化引用,否则等到有人注入或引用该实例时再初始化。2.0.10以上版本
protocolprotocolstring可选服务治理只调用指定协议的服务提供方,其它协议忽略。2.7.0以上版本
clientclientstring可选dubbo协议缺省为netty服务发现协议的客户端实现类型,比如:dubbo协议的mina,netty等2.7.0以上版本
providerPortprovider-portint可选Service Mesh当dubbo.consumer.meshEnable=true,Dubbo默认会将请求转换成K8S标准格式,结合VirtualService和DestinationRule进行流量治理,此时consumer端可以感知到provider。如果不想使用VirtualService和DestinationRule,请设置providerPort,使consumer端感知provider暴露的服务端口3.1.0以上版本
unloadClusterRelatedunloadClusterRelatedboolean可选falseService Mesh当dubbo.consumer.meshEnable=true,在Service Mesh模式下,设置为true,可在当前调用中卸载与Cluster相关的Directory、Router和Load Balance,将重试、负载平衡、超时和其他流量管理功能下放至Sidecar,使用VirtualService和DestinationRule进行流量治理3.1.0以上版本
parametersMap<string, string>可选服务治理扩展预留,可扩展定义任意参数,所有扩展参数都将原样反映在 URL 配置上2.0.0以上版本
providedByprovided-bystring可选Service Mesh当dubbo.consumer.meshEnable=true,Dubbo默认会将请求转换成K8S标准格式,结合VirtualService和DestinationRule进行流量治理,此时consumer端可以感知到provider。该值应当与声明的k8s service一致3.1.0以上版本
providerNamespaceprovider-namespacestring可选Service Mesh当dubbo.consumer.meshEnable=true,Dubbo默认会将请求转换成K8S标准格式,结合VirtualService和DestinationRule进行流量治理,此时consumer端可以感知到provider。请设置providerNamespace,使consumer端按照此配置寻址provider dns,默认default3.1.2以上版本

registry

注册中心配置。对应的配置类: org.apache.dubbo.config.RegistryConfig。同时如果有多个不同的注册中心,可以声明多个 <dubbo:registry> 标签,并在 <dubbo:service><dubbo:reference>registry 属性指定使用的注册中心。

属性对应URL参数类型是否必填缺省值作用描述兼容性
idstring可选配置关联注册中心引用BeanId,可以在<dubbo:service registry="">或<dubbo:reference registry="">中引用此ID1.0.16以上版本
address<host:port>string必填服务发现注册中心服务器地址,如果地址没有端口缺省为9090,同一集群内的多个地址用逗号分隔,如:ip:port,ip:port,不同集群的注册中心,请配置多个<dubbo:registry>标签1.0.16以上版本
protocol<protocol>string可选dubbo服务发现注册中心地址协议,支持dubbo, multicast, zookeeper, redis, consul(2.7.1), sofa(2.7.2), etcd(2.7.2), nacos(2.7.2)等协议2.0.0以上版本
port<port>int可选9090服务发现注册中心缺省端口,当address没有带端口时使用此端口做为缺省值2.0.0以上版本
username<username>string可选服务治理登录注册中心用户名,如果注册中心不需要验证可不填2.0.0以上版本
password<password>string可选服务治理登录注册中心密码,如果注册中心不需要验证可不填2.0.0以上版本
transportregistry.transporterstring可选netty性能调优网络传输方式,可选mina,netty2.0.0以上版本
timeoutregistry.timeoutint可选5000性能调优注册中心请求超时时间(毫秒)2.0.0以上版本
sessionregistry.sessionint可选60000性能调优注册中心会话超时时间(毫秒),用于检测提供者非正常断线后的脏数据,比如用心跳检测的实现,此时间就是心跳间隔,不同注册中心实现不一样。2.1.0以上版本
zonezonestring可选服务治理注册表所属区域,通常用于流量隔离2.7.5以上版本
fileregistry.filestring可选服务治理使用文件缓存注册中心地址列表及服务提供者列表,应用重启时将基于此文件恢复,注意:两个注册中心不能使用同一文件存储2.0.0以上版本
waitregistry.waitint可选0性能调优停止时等待通知完成时间(毫秒)2.0.0以上版本
checkcheckboolean可选true服务治理注册中心不存在时,是否报错2.0.0以上版本
registerregisterboolean可选true服务治理是否向此注册中心注册服务,如果设为false,将只订阅,不注册2.0.5以上版本
subscribesubscribeboolean可选true服务治理是否向此注册中心订阅服务,如果设为false,将只注册,不订阅2.0.5以上版本
dynamicdynamicboolean可选true服务治理服务是否动态注册,如果设为false,注册后将显示为disable状态,需人工启用,并且服务提供者停止时,也不会自动取消注册,需人工禁用。2.0.5以上版本
groupgroupstring可选dubbo服务治理服务注册分组,跨组的服务不会相互影响,也无法相互调用,适用于环境隔离。2.0.5以上版本
versionversionstring可选服务发现服务版本1.0.0以上版本
simplifiedsimplifiedboolean可选false服务治理注册到注册中心的URL是否采用精简模式的(与低版本兼容)2.7.0以上版本
extra-keysextraKeysstring可选服务治理在simplified=true时,extraKeys允许你在默认参数外将额外的key放到URL中,格式:“interface,key1,key2”。2.7.0以上版本
useAsConfigCenterboolean可选服务治理该注册中心是否作为配置中心使用2.7.5以上版本
useAsMetadataCenterboolean可选服务治理该注册中心是否作为元数据中心使用2.7.5以上版本
acceptsacceptsstring可选服务治理该注册中心接收rpc协议列表,多协议用逗号隔开,例如dubbo,rest2.7.5以上版本
preferredpreferredboolean可选服务治理是否作为首选注册中心。当订阅多注册中心时,如果设为true,该注册中心作为首选2.7.5以上版本
weightweightint可选性能调优注册流量权重。使用多注册中心时,可通过该值调整注册流量的分布,当设置首选注册中心时该值不生效2.7.5以上版本
registerModeregister-modestring可选all服务治理控制地址注册行为,应用级服务发现迁移用。
* instance 只注册应用级地址;
* interface 只注册接口级地址;
* all(默认) 同时注册应用级和接口级地址;
3.0.0以上版本
enableEmptyProtectionenable-empty-protectionboolean可选true服务治理是否全局启用消费端的空地址列表保护,开启后注册中心的空地址推送将被忽略,默认 true3.0.0以上版本
parametersMap<string, string>可选服务治理扩展预留,可扩展定义任意参数,所有扩展参数都将原样反映在 URL 配置上2.0.0以上版本

config-center

配置中心。对应的配置类:org.apache.dubbo.config.ConfigCenterConfig

属性对应URL参数类型是否必填缺省值描述兼容性
protocolprotocolstring可选zookeeper使用哪个配置中心:apollo、zookeeper、nacos等。
以zookeeper为例
1. 指定protocol,则address可以简化为127.0.0.1:2181
2. 不指定protocol,则address取值为zookeeper://127.0.0.1:2181
2.7.0以上版本
addressaddressstring必填配置中心地址。
取值参见protocol说明
2.7.0以上版本
highestPriorityhighest-priorityboolean可选true来自配置中心的配置项具有最高优先级,即会覆盖本地配置项。2.7.0以上版本
namespacenamespacestring可选dubbo通常用于多租户隔离,实际含义视具体配置中心而不同。
如:
zookeeper - 环境隔离,默认值dubbo
apollo - 区分不同领域的配置集合,默认使用dubboapplication
2.7.0以上版本
clusterclusterstring可选含义视所选定的配置中心而不同。
如Apollo中用来区分不同的配置集群
2.7.0以上版本
groupgroupstring可选dubbo含义视所选定的配置中心而不同。
nacos - 隔离不同配置集
zookeeper - 隔离不同配置集
2.7.0以上版本
checkcheckboolean可选true当配置中心连接失败时,是否终止应用启动。2.7.0以上版本
configFileconfig-filestring可选dubbo.properties全局级配置文件所映射到的key
zookeeper - 默认路径/dubbo/config/dubbo/dubbo.properties
apollo - dubbo namespace中的dubbo.properties键
2.7.0以上版本
appConfigFileapp-config-filestring可选“configFile”是全局级共享的。此项仅限于此应用程序配置的属性2.7.0以上版本
timeouttimeoutint可选3000ms获取配置的超时时间2.7.0以上版本
usernameusernamestring可选如果配置中心需要做校验,用户名
Apollo暂未启用
2.7.0以上版本
passwordpasswordstring可选如果配置中心需要做校验,密码
Apollo暂未启用
2.7.0以上版本
parametersparametersMap<string, string>可选扩展参数,用来支持不同配置中心的定制化配置参数2.7.0以上版本
includeSpringEnvinclude-spring-envboolean可选false使用Spring框架时支持,为true时,会自动从Spring Environment中读取配置。
默认依次读取
key为dubbo.properties的配置
key为dubbo.properties的PropertySource
2.7.0以上版本

metadata-report-config

元数据中心。对应的配置类:org.apache.dubbo.config.MetadataReportConfig

属性对应URL参数类型是否必填缺省值描述兼容性
addressaddressstring必填元数据中心地址。2.7.0以上版本
protocolprotocolstring可选zookeeper元数据中心协议:zookeeper、nacos、redis等。
以zookeeper为例
1. 指定protocol,则address可以简化为127.0.0.1:2181
2. 不指定protocol,则address取值为zookeeper://127.0.0.1:2181
2.7.13以上版本
portportint可选元数据中心端口号。指定port,则address可简化,不用配置端口号2.7.13以上版本
usernameusernamestring可选元数据中心需要做校验,用户名
Apollo暂未启用
2.7.0以上版本
passwordpasswordstring可选元数据中心需要做校验,密码
Apollo暂未启用
2.7.0以上版本
timeouttimeoutint可选获取元数据超时时间(ms)2.7.0以上版本
groupgroupstring可选dubbo元数据分组,适用于环境隔离。与注册中心group意义相同2.7.0以上版本
retryTimesretry-timesint可选100重试次数2.7.0以上版本
retryPeriodretry-periodint可选3000ms重试间隔时间(ms)2.7.0以上版本
cycleReportcycle-reportboolean可选true是否每天更新完整元数据2.7.0以上版本
syncReportsync-reportboolean可选false是否同步更新元数据,默认为异步2.7.0以上版本
clusterclusterstring可选含义视所选定的元数据中心而不同。
如Apollo中用来区分不同的配置集群
2.7.0以上版本
filefilestring可选使用文件缓存元数据中心列表,应用重启时将基于此文件恢复,注意:两个元数据中心不能使用同一文件存储2.7.0以上版本
checkcheckboolean可选true当元数据中心连接失败时,是否终止应用启动。3.0.0以上版本
reportMetadatareport-metadataboolean可选false是否上地址发现中的接口配置报元数据,dubbo.application.metadata-type=remote 该配置不起作用即一定会上报,dubbo.application.metadata-type=local 时是否上报由该配置值决定3.0.0以上版本
reportDefinitionreport-definitionboolean可选true是否上报服务运维用元数据3.0.0以上版本
reportConsumerDefinitionreport-consumer-definitionboolean可选true是否在消费端上报服务运维用元数据3.0.0以上版本
parametersparametersMap<string, string>可选扩展参数,用来支持不同元数据中心的定制化配置参数2.7.0以上版本

protocol

服务提供者协议配置。对应的配置类: org.apache.dubbo.config.ProtocolConfig。同时,如果需要支持多协议,可以声明多个 <dubbo:protocol> 标签,并在 <dubbo:service> 中通过 protocol 属性指定使用的协议。

属性对应URL参数类型是否必填缺省值作用描述兼容性
idstring可选dubbo配置关联协议BeanId,可以在<dubbo:service protocol="">中引用此ID,如果ID不填,缺省和name属性值一样,重复则在name后加序号。2.0.5以上版本
name<protocol>string必填dubbo性能调优协议名称2.0.5以上版本
port<port>int可选dubbo协议缺省端口为20880,rmi协议缺省端口为1099,http和hessian协议缺省端口为80;如果没有配置port,则自动采用默认端口,如果配置为-1,则会分配一个没有被占用的端口。Dubbo 2.4.0+,分配的端口在协议缺省端口的基础上增长,确保端口段可控。服务发现服务端口2.0.5以上版本
host<host>string可选自动查找本机IP服务发现-服务主机名,多网卡选择或指定VIP及域名时使用,为空则自动查找本机IP,-建议不要配置,让Dubbo自动获取本机IP2.0.5以上版本
threadpoolthreadpoolstring可选fixed性能调优线程池类型,可选:fixed/cached/limit(2.5.3以上)/eager(2.6.x以上)2.0.5以上版本
threadnamethreadnamestring可选性能调优线程池名称2.7.6以上版本
threadsthreadsint可选200性能调优服务线程池大小(固定大小)2.0.5以上版本
corethreadscorethreadsint可选200性能调优线程池核心线程大小2.0.5以上版本
iothreadsthreadsint可选cpu个数+1性能调优io线程池大小(固定大小)2.0.5以上版本
acceptsacceptsint可选0性能调优服务提供方最大可接受连接数2.0.5以上版本
payloadpayloadint可选8388608(=8M)性能调优请求及响应数据包大小限制,单位:字节2.0.5以上版本
codeccodecstring可选dubbo性能调优协议编码方式2.0.5以上版本
serializationserializationstring可选dubbo协议缺省为hessian2,rmi协议缺省为java,http协议缺省为json性能调优协议序列化方式,当协议支持多种序列化方式时使用,比如:dubbo协议的dubbo,hessian2,java,compactedjava,以及http协议的json等2.0.5以上版本
accesslogaccesslogstring/boolean可选服务治理设为true,将向logger中输出访问日志,也可填写访问日志文件路径,直接把访问日志输出到指定文件2.0.5以上版本
path<path>string可选服务发现提供者上下文路径,为服务path的前缀2.0.5以上版本
transportertransporterstring可选dubbo协议缺省为netty性能调优协议的服务端和客户端实现类型,比如:dubbo协议的mina,netty等,可以分拆为server和client配置2.0.5以上版本
serverserverstring可选dubbo协议缺省为netty,http协议缺省为servlet性能调优协议的服务器端实现类型,比如:dubbo协议的mina,netty等,http协议的jetty,servlet等2.0.5以上版本
clientclientstring可选dubbo协议缺省为netty性能调优协议的客户端实现类型,比如:dubbo协议的mina,netty等2.0.5以上版本
dispatcherdispatcherstring可选dubbo协议缺省为all性能调优协议的消息派发方式,用于指定线程模型,比如:dubbo协议的all, direct, message, execution, connection等2.1.0以上版本
queuesqueuesint可选0性能调优线程池队列大小,当线程池满时,排队等待执行的队列大小,建议不要设置,当线程池满时应立即失败,重试其它服务提供机器,而不是排队,除非有特殊需求。2.0.5以上版本
charsetcharsetstring可选UTF-8性能调优序列化编码2.0.5以上版本
bufferbufferint可选8192性能调优网络读写缓冲区大小2.0.5以上版本
heartbeatheartbeatint可选0性能调优心跳间隔,对于长连接,当物理层断开时,比如拔网线,TCP的FIN消息来不及发送,对方收不到断开事件,此时需要心跳来帮助检查连接是否已断开2.0.10以上版本
telnettelnetstring可选服务治理所支持的telnet命令,多个命令用逗号分隔2.0.5以上版本
registerregisterboolean可选true服务治理该协议的服务是否注册到注册中心2.0.8以上版本
contextpathcontextpathString可选缺省为空串服务治理上下文路径2.0.6以上版本
sslEnabledssl-enabledboolean可选false服务治理是否启用ssl2.7.5以上版本
parametersparametersMap<string, string>可选扩展参数2.0.0以上版本

provider

服务提供者缺省值配置。对应的配置类: org.apache.dubbo.config.ProviderConfig。同时该标签为 <dubbo:service><dubbo:protocol> 标签的缺省值设置。

属性对应URL参数类型是否必填缺省值作用描述兼容性
idstring可选dubbo配置关联协议BeanId,可以在<dubbo:service proivder="">中引用此ID1.0.16以上版本
protocol<protocol>string可选dubbo性能调优协议名称1.0.16以上版本
host<host>string可选自动查找本机IP服务发现服务主机名,多网卡选择或指定VIP及域名时使用,为空则自动查找本机IP,建议不要配置,让Dubbo自动获取本机IP1.0.16以上版本
threadsthreadsint可选200性能调优服务线程池大小(固定大小)1.0.16以上版本
payloadpayloadint可选8388608(=8M)性能调优请求及响应数据包大小限制,单位:字节2.0.0以上版本
path<path>string可选服务发现提供者上下文路径,为服务path的前缀2.0.0以上版本
transportertransporterstring可选dubbo协议缺省为netty性能调优协议的服务端和客户端实现类型,比如:dubbo协议的mina,netty等,可以分拆为server和client配置2.0.5以上版本
serverserverstring可选dubbo协议缺省为netty,http协议缺省为servlet性能调优协议的服务器端实现类型,比如:dubbo协议的mina,netty等,http协议的jetty,servlet等2.0.0以上版本
clientclientstring可选dubbo协议缺省为netty性能调优协议的客户端实现类型,比如:dubbo协议的mina,netty等2.0.0以上版本
dispatcherdispatcherstring可选dubbo协议缺省为all性能调优协议的消息派发方式,用于指定线程模型,比如:dubbo协议的all, direct, message, execution, connection等2.1.0以上版本
codeccodecstring可选dubbo性能调优协议编码方式2.0.0以上版本
serializationserializationstring可选dubbo协议缺省为hessian2,rmi协议缺省为java,http协议缺省为json性能调优协议序列化方式,当协议支持多种序列化方式时使用,比如:dubbo协议的dubbo,hessian2,java,compactedjava,以及http协议的json,xml等2.0.5以上版本
defaultboolean可选false配置关联是否为缺省协议,用于多协议1.0.16以上版本
filterservice.filterstring可选性能调优服务提供方远程调用过程拦截器名称,多个名称用逗号分隔2.0.5以上版本
listenerexporter.listenerstring可选性能调优服务提供方导出服务监听器名称,多个名称用逗号分隔2.0.5以上版本
threadpoolthreadpoolstring可选fixed性能调优线程池类型,可选:fixed/cached/limit(2.5.3以上)/eager(2.6.x以上)2.0.5以上版本
threadnamethreadnamestring可选性能调优线程池名称2.7.6以上版本
acceptsacceptsint可选0性能调优服务提供者最大可接受连接数2.0.5以上版本
versionversionstring可选0.0.0服务发现服务版本,建议使用两位数字版本,如:1.0,通常在接口不兼容时版本号才需要升级2.0.5以上版本
groupgroupstring可选服务发现服务分组,当一个接口有多个实现,可以用分组区分2.0.5以上版本
delaydelayint可选0性能调优延迟注册服务时间(毫秒)- ,设为-1时,表示延迟到Spring容器初始化完成时暴露服务2.0.5以上版本
timeoutdefault.timeoutint可选1000性能调优远程服务调用超时时间(毫秒)2.0.5以上版本
retriesdefault.retriesint可选2性能调优远程服务调用重试次数,不包括第一次调用,不需要重试请设为02.0.5以上版本
connectionsdefault.connectionsint可选0性能调优对每个提供者的最大连接数,rmi、http、hessian等短连接协议表示限制连接数,dubbo等长连接协表示建立的长连接个数2.0.5以上版本
loadbalancedefault.loadbalancestring可选random性能调优负载均衡策略,可选值:
* random - 随机;
* roundrobin - 轮询;
* leastactive - 最少活跃调用;
* consistenthash - 哈希一致 (2.1.0以上版本);
* shortestresponse - 最短响应 (2.7.7以上版本);
2.0.5以上版本
asyncdefault.asyncboolean可选false性能调优是否缺省异步执行,不可靠异步,只是忽略返回值,不阻塞执行线程2.0.5以上版本
stubstubboolean可选false服务治理设为true,表示使用缺省代理类名,即:接口名 + Local后缀。2.0.5以上版本
mockmockboolean可选false服务治理设为true,表示使用缺省Mock类名,即:接口名 + Mock后缀。2.0.5以上版本
tokentokenboolean可选false服务治理令牌验证,为空表示不开启,如果为true,表示随机生成动态令牌2.0.5以上版本
registryregistrystring可选缺省向所有registry注册配置关联向指定注册中心注册,在多个注册中心时使用,值为<dubbo:registry>的id属性,多个注册中心ID用逗号分隔,如果不想将该服务注册到任何registry,可将值设为N/A2.0.5以上版本
dynamicdynamicboolean可选true服务治理服务是否动态注册,如果设为false,注册后将显示后disable状态,需人工启用,并且服务提供者停止时,也不会自动取消册,需人工禁用。2.0.5以上版本
accesslogaccesslogstring/boolean可选false服务治理设为true,将向logger中输出访问日志,也可填写访问日志文件路径,直接把访问日志输出到指定文件2.0.5以上版本
ownerownerstring可选服务治理服务负责人,用于服务治理,请填写负责人公司邮箱前缀2.0.5以上版本
documentdocumentstring可选服务治理服务文档URL2.0.5以上版本
weightweightint可选性能调优服务权重2.0.5以上版本
executesexecutesint可选0性能调优服务提供者每服务每方法最大可并行执行请求数2.0.5以上版本
activesdefault.activesint可选0性能调优每服务消费者每服务每方法最大并发调用数2.0.5以上版本
proxyproxystring可选javassist性能调优生成动态代理方式,可选:jdk/javassist2.0.5以上版本
clusterdefault.clusterstring可选failover性能调优集群方式,可选:failover/failfast/failsafe/failback/forking2.0.5以上版本
deprecateddeprecatedboolean可选false服务治理服务是否过时,如果设为true,消费方引用时将打印服务过时警告error日志2.0.5以上版本
queuesqueuesint可选0性能调优线程池队列大小,当线程池满时,排队等待执行的队列大小,建议不要设置,当线程池满时应立即失败,重试其它服务提供机器,而不是排队,除非有特殊需求。2.0.5以上版本
charsetcharsetstring可选UTF-8性能调优序列化编码2.0.5以上版本
bufferbufferint可选8192性能调优网络读写缓冲区大小2.0.5以上版本
iothreadsiothreadsint可选CPU + 1性能调优IO线程池,接收网络读写中断,以及序列化和反序列化,不处理业务,业务线程池参见threads配置,此线程池和CPU相关,不建议配置。2.0.5以上版本
alivealiveint可选服务治理线程池keepAliveTime,默认单位为ms2.0.5以上版本
telnettelnetstring可选服务治理所支持的telnet命令,多个命令用逗号分隔2.0.5以上版本
waitwaitint可选服务治理停服务时等待时间2.0.5以上版本
contextpathcontextpathString可选缺省为空串服务治理上下文路径2.0.6以上版本
layerlayerstring可选服务治理服务提供者所在的分层。如:biz、dao、intl:web、china:acton。2.0.7以上版本
parametersparametersMap<string, string>可选服务治理扩展参数2.0.0以上版本

consumer

服务消费者缺省值配置。配置类: org.apache.dubbo.config.ConsumerConfig 。同时该标签为 <dubbo:reference> 标签的缺省值设置。

属性对应URL参数类型是否必填缺省值作用描述兼容性
timeoutdefault.timeoutint可选1000性能调优远程服务调用超时时间(毫秒)1.0.16以上版本
retriesdefault.retriesint可选2性能调优远程服务调用重试次数,不包括第一次调用,不需要重试请设为0,仅在cluster为failback/failover时有效1.0.16以上版本
loadbalancedefault.loadbalancestring可选random性能调优负载均衡策略,可选值:
* random - 随机;
* roundrobin - 轮询;
* leastactive - 最少活跃调用;
* consistenthash - 哈希一致 (2.1.0以上版本);
* shortestresponse - 最短响应 (2.7.7以上版本);
1.0.16以上版本
asyncdefault.asyncboolean可选false性能调优是否缺省异步执行,不可靠异步,只是忽略返回值,不阻塞执行线程2.0.0以上版本
sentdefault.sentboolean可选true服务治理异步调用时,标记sent=true时,表示网络已发出数据2.0.6以上版本
connectionsdefault.connectionsint可选100性能调优每个服务对每个提供者的最大连接数,rmi、http、hessian等短连接协议支持此配置,dubbo协议长连接不支持此配置1.0.16以上版本
genericgenericboolean可选false服务治理是否缺省泛化接口,如果为泛化接口,将返回GenericService2.0.0以上版本
checkcheckboolean可选true服务治理启动时检查提供者是否存在,true报错,false忽略1.0.16以上版本
proxyproxystring可选javassist性能调优生成动态代理方式,可选:jdk/javassist2.0.5以上版本
ownerownerstring可选服务治理调用服务负责人,用于服务治理,请填写负责人公司邮箱前缀2.0.5以上版本
activesdefault.activesint可选0性能调优每服务消费者每服务每方法最大并发调用数2.0.5以上版本
clusterdefault.clusterstring可选failover性能调优集群方式,可选:failover/failfast/failsafe/failback/forking/available/mergeable(2.1.0以上版本)/broadcast(2.1.0以上版本)/zone-aware(2.7.5以上版本)2.0.5以上版本
filterreference.filterstring可选性能调优服务消费方远程调用过程拦截器名称,多个名称用逗号分隔2.0.5以上版本
listenerinvoker.listenerstring可选性能调优服务消费方引用服务监听器名称,多个名称用逗号分隔2.0.5以上版本
registrystring可选缺省向所有registry注册配置关联向指定注册中心注册,在多个注册中心时使用,值为<dubbo:registry>的id属性,多个注册中心ID用逗号分隔,如果不想将该服务注册到任何registry,可将值设为N/A2.0.5以上版本
layerlayerstring可选服务治理服务调用者所在的分层。如:biz、dao、intl:web、china:acton。2.0.7以上版本
initinitboolean可选false性能调优是否在afterPropertiesSet()时饥饿初始化引用,否则等到有人注入或引用该实例时再初始化。2.0.10以上版本
cachecachestring/boolean可选服务治理以调用参数为key,缓存返回结果,可选:lru, threadlocal, jcache等2.1.0及其以上版本支持
validationvalidationboolean可选服务治理是否启用JSR303标准注解验证,如果启用,将对方法参数上的注解进行校验2.1.0及其以上版本支持
versionversionstring可选服务治理在 Dubbo 中为同一个服务配置多个版本2.2.0及其以上版本支持
clientclientstring可选dubbo协议缺省为netty性能调优协议的客户端实现类型,比如:dubbo协议的mina,netty等2.0.0以上版本
threadpoolthreadpoolstring可选fixed性能调优线程池类型,可选:fixed/cached/limit(2.5.3以上)/eager(2.6.x以上)2.0.5以上版本
corethreadscorethreadsint可选200性能调优线程池核心线程大小2.0.5以上版本
threadsthreadsint可选200性能调优服务线程池大小(固定大小)2.0.5以上版本
queuesqueuesint可选0性能调优线程池队列大小,当线程池满时,排队等待执行的队列大小,建议不要设置,当线程池满时应立即失败,重试其它服务提供机器,而不是排队,除非有特殊需求。2.0.5以上版本
shareconnectionsshareconnectionsint可选1性能调优共享连接数。当connection参数设置为0时,会启用共享方式连接,默认只有一个连接。仅支持dubbo协议2.7.0以上版本
referThreadNumint可选性能优化异步调用线程池大小3.0.0以上版本
meshEnablemesh-enableboolean可选falseService MeshDubbo Mesh模式的开关。开启后,可适配SideCar模式,将Dubbo服务调用转换为K8S标准调用。仅支持Triple协议,兼容GRPC。设置为true后,原生对接K8S,无需第三方注册中心,设置dubbo.registry.address=N/A即可3.1.0以上版本
parametersparametersMap<string, string>可选服务治理扩展参数2.0.0以上版本

metrics

指标配置。配置类: org.apache.dubbo.config.MetricsConfig

属性对应URL参数类型是否必填缺省值作用描述兼容性
protocolprotocolstring可选prometheus性能调优协议名称,默认使用prometheus3.0.0以上版本
prometheusPrometheusConfig可选配置关联prometheus相关配置3.0.0以上版本
aggregationAggregationConfig可选配置关联指标聚合相关配置3.0.0以上版本
  • PrometheusConfig 对应类:org.apache.dubbo.config.nested.PrometheusConfig
属性类型是否必填缺省值描述
exporter.enabledboolean可选是否启用prometheus exporter
exporter.enableHttpServiceDiscoveryboolean可选是否启用http服务发现
exporter.httpServiceDiscoveryUrlstring可选http服务发现地址
exporter.metricsPortint可选当使用pull方法时,暴露的端口号
exporter.metricsPathstring可选当使用pull方法时,暴露指标的路径
pushgateway.enabledboolean可选是否可以通过prometheus的Pushgateway发布指标
pushgateway.baseUrlstring可选Pushgateway地址
pushgateway.usernamestring可选Pushgateway用户名
pushgateway.passwordstring可选Pushgateway密码
pushgateway.pushIntervalint可选推送指标间隔时间
  • AggregationConfig 对应类:org.apache.dubbo.config.nested.AggregationConfig
属性类型是否必填缺省值描述
enabledboolean可选是否开启本地指标聚合功能
bucketNumint可选时间窗口存储桶个数
timeWindowSecondsint可选时间窗口时长(s)

ssl

TLS认证配置。配置类: org.apache.dubbo.config.SslConfig

属性对应URL参数类型是否必填缺省值作用描述兼容性
serverKeyCertChainPathserver-key-cert-chain-pathstring可选安全配置服务端签名证书路径2.7.5以上版本
serverPrivateKeyPathserver-private-key-pathstring可选安全配置服务端私钥路径2.7.5以上版本
serverKeyPasswordserver-key-passwordstring可选安全配置服务端密钥密码2.7.5以上版本
serverTrustCertCollectionPathserver-trust-cert-collection-pathstring可选安全配置服务端信任证书路径2.7.5以上版本
clientKeyCertChainPathclient-key-cert-chain-pathstring可选安全配置客户端签名证书路径2.7.5以上版本
clientPrivateKeyPathclient-private-key-pathstring可选安全配置客户端私钥路径2.7.5以上版本
clientKeyPasswordclient-key-passwordstring可选安全配置客户端密钥密码2.7.5以上版本
clientTrustCertCollectionPathclient-trust-cert-collection-pathstring可选安全配置客户端信任证书路径2.7.5以上版本

module

模块信息配置。对应的配置类 org.apache.dubbo.config.ModuleConfig

属性对应URL参数类型是否必填缺省值作用描述兼容性
namemodulestring必填服务治理当前模块名称,用于注册中心计算模块间依赖关系2.2.0以上版本
versionmodule.versionstring可选服务治理当前模块的版本2.2.0以上版本
ownermodule.ownerstring可选服务治理模块负责人,用于服务治理,请填写负责人公司邮箱前缀2.2.0以上版本
organizationmodule.organizationstring可选服务治理组织名称(BU或部门),用于注册中心区分服务来源,此配置项建议不要使用autoconfig,直接写死在配置中,比如china,intl,itu,crm,asc,dw,aliexpress等2.2.0以上版本
backgroundbackgroundboolean可选性能调优是否开启后台启动模式。如果开启,无需等待spring ContextRefreshedEvent事件完成3.0.0以上版本
referAsyncreferAsyncboolean可选性能调优消费端是否开启异步调用3.0.0以上版本
referThreadNumreferThreadNumint可选性能调优异步调用线程池大小3.0.0以上版本
exportAsyncexportAsyncboolean可选性能调优服务端是否开启导出3.0.0以上版本
exportThreadNumexportThreadNumint可选异步导出线程池大小3.0.0以上版本

monitor

监控中心配置。对应的配置类: org.apache.dubbo.config.MonitorConfig

属性对应URL参数类型是否必填缺省值作用描述兼容性
protocolprotocolstring可选dubbo服务治理监控中心协议,如果为protocol=“registry”,表示从注册中心发现监控中心地址,否则直连监控中心。2.0.9以上版本
address<url>string可选服务治理直连监控中心服务器地址,address=“10.20.130.230:12080”1.0.16以上版本
usernameusernamestring可选服务治理监控中心用户名2.0.9以上版本
passwordpasswordstring可选服务治理监控中心密码2.0.9以上版本
groupgroupstring可选服务治理分组2.0.9以上版本
versionversionstring可选服务治理版本号2.0.9以上版本
intervalintervalstring可选服务治理间隔时间2.0.9以上版本
parametersparametersMap<string, string>可选自定义参数2.0.0以上版本

method

方法级配置。对应的配置类: org.apache.dubbo.config.MethodConfig。同时该标签为 servicereference 的子标签,用于控制到方法级。

比如:

<dubbo:reference interface="com.xxx.XxxService">
   <dubbo:method name="findXxx" timeout="3000" retries="2" />
</dubbo:reference>
属性对应URL参数类型是否必填缺省值作用描述兼容性
namestring必填标识方法名1.0.8以上版本
timeout<methodName>.timeoutint可选缺省为的timeout性能调优方法调用超时时间(毫秒)1.0.8以上版本
retries<methodName>.retriesint可选缺省为<dubbo:reference>的retries性能调优远程服务调用重试次数,不包括第一次调用,不需要重试请设为02.0.0以上版本
loadbalance<methodName>.loadbalancestring可选缺省为的loadbalance性能调优负载均衡策略,可选值:
* random - 随机;
* roundrobin - 轮询;
* leastactive - 最少活跃调用;
* consistenthash - 哈希一致 (2.1.0以上版本);
* shortestresponse - 最短响应 (2.7.7以上版本);
2.0.0以上版本
async<methodName>.asyncboolean可选缺省为<dubbo:reference>的async性能调优是否异步执行,不可靠异步,只是忽略返回值,不阻塞执行线程1.0.9以上版本
sent<methodName>.sentboolean可选true性能调优异步调用时,标记sent=true时,表示网络已发出数据2.0.6以上版本
actives<methodName>.activesint可选0性能调优每服务消费者最大并发调用限制2.0.5以上版本
executes<methodName>.executesint可选0性能调优每服务每方法最大使用线程数限制- -,此属性只在<dubbo:method>作为<dubbo:service>子标签时有效2.0.5以上版本
deprecated<methodName>.deprecatedboolean可选false服务治理服务方法是否过时,此属性只在<dubbo:method>作为<dubbo:service>子标签时有效2.0.5以上版本
sticky<methodName>.stickyboolean可选false服务治理设置true 该接口上的所有方法使用同一个provider.如果需要更复杂的规则,请使用路由2.0.6以上版本
return<methodName>.returnboolean可选true性能调优方法调用是否需要返回值,async设置为true时才生效,如果设置为true,则返回future,或回调onreturn等方法,如果设置为false,则请求发送成功后直接返回Null2.0.6以上版本
oninvokeattribute属性,不在URL中体现String可选性能调优实例执行前拦截2.0.6以上版本
onreturnattribute属性,不在URL中体现String可选性能调优实例执行返回后拦截2.0.6以上版本
onthrowattribute属性,不在URL中体现String可选性能调优实例执行有异常拦截2.0.6以上版本
oninvokeMethodattribute属性,不在URL中体现String可选性能调优方法执行前拦截2.0.6以上版本
onreturnMethodattribute属性,不在URL中体现String可选性能调优方法执行返回后拦截2.0.6以上版本
onthrowMethodattribute属性,不在URL中体现String可选性能调优方法执行有异常拦截2.0.6以上版本
cache<methodName>.cachestring/boolean可选服务治理以调用参数为key,缓存返回结果,可选:lru, threadlocal, jcache等2.1.0以上版本
validation<methodName>.validationboolean可选服务治理是否启用JSR303标准注解验证,如果启用,将对方法参数上的注解进行校验2.1.0以上版本

argument

方法参数配置。对应的配置类: org.apache.dubbo.config.ArgumentConfig。该标签为 method 的子标签,用于方法参数的特征描述,比如 XML 格式:

<dubbo:method name="findXxx" timeout="3000" retries="2">
   <dubbo:argument index="0" callback="true" />
</dubbo:method>
属性对应URL参数类型是否必填缺省值作用描述兼容性
indexint必填标识参数索引2.0.6以上版本
typeString与index二选一标识通过参数类型查找参数的index2.0.6以上版本
callback<metodName><index>.callbackboolean可选服务治理参数是否为callback接口,如果为callback,服务提供方将生成反向代理,可以从服务提供方反向调用消费方,通常用于事件推送.2.0.6以上版本

parameter

选项参数配置。对应的配置类:java.util.Map。同时该标签为 protocolserviceproviderreferenceconsumermonitorregistrymetadata-configconfig-center 的子标签,用于配置自定义参数,该配置项将作为扩展点设置自定义参数使用。

比如:

<dubbo:protocol name="napoli">
   <dubbo:parameter key="http://10.20.160.198/wiki/display/dubbo/napoli.queue.name" value="xxx" />
</dubbo:protocol>

也可以:

<dubbo:protocol name="jms" p:queue="xxx" />
属性对应URL参数类型是否必填缺省值作用描述兼容性
keykeystring必填服务治理路由参数键2.0.0以上版本
valuevaluestring必填服务治理路由参数值2.0.0以上版本

环境变量

支持的 key 有以下两个:

  1. dubbo.labels,指定一些列配置到 URL 中的键值对,通常通过 JVM -D 或系统环境变量指定。

    增加以下配置:

    # JVM
    -Ddubbo.labels = "tag1=value1; tag2=value2"
    # 环境变量
    DUBBO_LABELS = "tag1=value1; tag2=value2"
    

    最终生成的 URL 会包含 tag1、tag2 两个 key: dubbo://xxx?tag1=value1&tag2=value2

  2. dubbo.env.keys,指定环境变量 key 值,Dubbo 会尝试从环境变量加载每个 key

    # JVM
    -Ddubbo.env.keys = "DUBBO_TAG1, DUBBO_TAG2"
    # 环境变量
    DUBBO_ENV_KEYS = "DUBBO_TAG1, DUBBO_TAG2"
    

    最终生成的 URL 会包含 DUBBO_TAG1、DUBBO_TAG2 两个 key: dubbo://xxx?DUBBO_TAG1=value1&DUBBO_TAG2=value2

其他配置

config-mode

背景

在每个dubbo应用中某些种类的配置类实例只能出现一次(比如ApplicationConfigMonitorConfigMetricsConfigSslConfigModuleConfig),有些能出现多次(比如RegistryConfigProtocolConfig等)。

如果应用程序意外的扫描到了多个唯一配置类实例(比如用户在一个dubbo应用中错误了配置了两个ApplicationConfig),应该以哪种策略来处理这种情况呢?是直接抛异常?是保留前者忽略后者?是忽略前者保留后者?还是允许某一种形式的并存(比如后者的属性覆盖到前者上)?

目前dubbo中的唯一配置类类型和以及某唯一配置类型找到多个实例允许的配置模式/策略如下。

唯一配置类类型

ApplicationConfigMonitorConfigMetricsConfigSslConfigModuleConfig

前四个属于应用级别的,最后一个属于模块级别的。

配置模式

  • strict:严格模式。直接抛异常。
  • override:覆盖模式。忽略前者保留后者。
  • ignore:忽略模式。忽略后者保留前者。
  • override_all:属性覆盖模式。不管前者的属性值是否为空,都将后者的属性覆盖/设置到前者上。
  • override_if_absent:若不存在则属性覆盖模式。只有前者对应属性值为空,才将后者的属性覆盖/设置到前者上。

注:后两种还影响配置实例的属性覆盖。因为dubbo有多种配置方式,即存在多个配置源,配置源也有优先级。比如通过xml方式配置了一个ServiceConfig且指定属性version=1.0.0,同时我们又在外部配置(配置中心)中配置了dubbo.service.{interface}.version=2.0.0,在没有引入config-mode配置项之前,按照原有的配置源优先级,最终实例的version=2.0.0。但是引入了config-mode配置项之后,配置优先级规则也不再那么严格,即如果指定config-mode为override_all则为version=2.0.0,如果config-mode为override_if_absent则为version=1.0.0config-mode为其他值则遵循原有配置优先级进行属性设值/覆盖。

配置方式

配置的key为dubbo.config.mode,配置的值为如上描述的几种,默认的策略值为strict。下面展示了配置示例

# JVM -D
-Ddubbo.config.mode=strict

# 环境变量
DUBBO_CONFIG_MODE=strict

# 外部配置(配置中心)、Spring应用的Environment、dubbo.properties
dubbo.config.mode=strict

最后修改 November 28, 2022: Fix release link (#1618) (0199a11)