当前位置:   article > 正文

Dubbo配置及属性详解_

1. Dubbo配置文件详解

标签用途说明用例
<dubbo:application />应用配置用于配置当前应用信息,不管该应用是提供者还是消费者<dubbo:application name="dubbo-server"/>
<dubbo:service />服务配置用于暴露一个服务,定义服务的元信息,一个服务可以用多个协议暴露,一个服务也可以注册到多个注册中心<dubbo:service ref="userService" interface="com.lizq.dubbo.server.service.UserService"/>
<dubbo:reference />引用配置用于创建一个远程服务代理,一个引用可以指向多个注册中心。引用缺省是延迟初始化的,只有引用被注入到其它 Bean,或被 getBean() 获取,才会初始化。如果需要饥饿加载,即没有人引用也立即生成动态代理,可以配置:<dubbo:reference ... init="true" /><dubbo:reference id="userService" interface="com.lizq.dubbo.server.service.UserService"/>
<dubbo:protocol />协议配置用于配置提供服务的协议信息,协议由提供方指定,消费方被动接受<dubbo:protocol name="dubbo" port="20880"/>
<dubbo:registry />注册中心配置用于配置连接注册中心相关信息<dubbo:registry address="zookeeper://127.0.0.1:2181" timeout="10000"/>
<dubbo:module />模块配置用于配置当前模块信息,可选
<dubbo:monitor />监控中心配置用于配置连接监控中心相关信息,可选
<dubbo:provider />提供方配置当 ProtocolConfig 和 ServiceConfig 某属性没有配置时,采用此缺省值,可选
<dubbo:consumer />消费方配置当 ReferenceConfig 某属性没有配置时,采用此缺省值,可选
<dubbo:config-center />配置中心配置中心
<dubbo:parameter />选项参数配置选项参数配置。对应的配置类:java.util.Map。同时该标签为<dubbo:protocol><dubbo:service><dubbo:provider><dubbo:reference><dubbo:consumer>的子标签,用于配置自定义参数,该配置项将作为扩展点设置自定义参数使用。<dubbo:protocol name="napoli"><dubbo:parameter key="http://10.20.160.198/wiki/display/dubbo/napoli.queue.name" value="xxx" /></dubbo:protocol>
<dubbo:method />方法配置用于 ServiceConfig 和 ReferenceConfig 指定方法级的配置信息
<dubbo:argument />参数配置用于指定方法参数配置

< dubbo:application />

应用信息配置。对应的配置类:org.apache.dubbo.config.ApplicationConfig

属性对应URL参数类型是否必填缺省值作用描述兼容性
nameapplicationstring必填服务治理当前应用名称,用于注册中心计算应用间依赖关系,注意:消费者和提供者应用名不要一样,此参数不是匹配条件,你当前项目叫什么名字就填什么,和提供者消费者角色无关1.0.16以上版本
versionapplication.versionstring-服务治理当前应用的版本2.2.0以上版本
ownerownerstring-服务治理应用负责人,用于服务治理,请填写负责人公司邮箱前缀2.0.5以上版本
organizationorganizationstring-服务治理组织名称(BU或部门),用于注册中心区分服务来源,此配置项建议不要使用autoconfig,直接写死在配置中,比如china,intl,itu,crm,asc,dw,aliexpress等2.0.0以上版本
architecturearchitecturestring-服务治理用于服务分层对应的架构。如,intl、china。不同的架构使用不同的分层。2.0.7以上版本
environmentenvironmentstring-服务治理应用环境,如:develop/test/product,不同环境使用不同的缺省值,以及作为只用于开发测试功能的限制条件2.0.0以上版本
compilercompilerstring-javassist性能优化Java字节码编译器,用于动态类的生成,可选:jdk或javassist2.1.0以上版本
loggerloggerstring-slf4j性能优化日志输出方式,可选:slf4j,jcl,log4j,log4j2,jdk2.2.0以上版本

< dubbo: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 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,分别表示:随机,轮询,最少活跃调用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以上版本
proxyproxystring-javassist性能调优生成动态代理方式,可选:jdk/javassist2.0.5以上版本
clusterclusterstring-failover性能调优集群方式,可选:failover/failfast/failsafe/failback/forking2.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以上版本

< dubbo: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,分别表示:随机,轮询,最少活跃调用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/forking2.0.5以上版本
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-服务治理只调用指定协议的服务提供方,其它协议忽略。

< dubbo: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以上版本
namestring必填dubbo性能调优协议名称2.0.5以上版本
portint-dubbo协议缺省端口为20880,rmi协议缺省端口为1099,http和hessian协议缺省端口为80;如果没有配置port,则自动采用默认端口,如果配置为**-1**,则会分配一个没有被占用的端口。Dubbo 2.4.0+,分配的端口在协议缺省端口的基础上增长,确保端口段可控。服务发现服务端口2.0.5以上版本
hoststring-自动查找本机IP服务发现-服务主机名,多网卡选择或指定VIP及域名时使用,为空则自动查找本机IP,-建议不要配置,让Dubbo自动获取本机IP2.0.5以上版本
threadpoolthreadpoolstring-fixed性能调优线程池类型,可选:fixed/cached2.0.5以上版本
threadsthreadsint-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 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(1024 * 8)性能调优网络读写缓冲区大小2.0.5以上版本
heartbeatheartbeatint-0性能调优心跳间隔,对于长连接,当物理层断开时,比如拔网线,TCP的FIN消息来不及发送,对方收不到断开事件,此时需要心跳来帮助检查连接是否已断开2.0.10以上版本
telnettelnetstring-服务治理所支持的telnet命令,多个命令用逗号分隔2.0.5以上版本
registerregisterboolean-true服务治理该协议的服务是否注册到注册中心2.0.8以上版本
contextpathcontextpathstring-缺省为空串服务治理2.0.6以上版本

< dubbo: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以上版本
protocolstring-dubbo服务发现注册中心地址协议,支持dubbo, multicast, zookeeper, redis, consul(2.7.1), sofa(2.7.2), etcd(2.7.2), nacos(2.7.2)等协议2.0.0以上版本
portint-9090服务发现注册中心缺省端口,当address没有带端口时使用此端口做为缺省值2.0.0以上版本
usernamestring-服务治理登录注册中心用户名,如果注册中心不需要验证可不填2.0.0以上版本
passwordstring-服务治理登录注册中心密码,如果注册中心不需要验证可不填2.0.0以上版本
transportregistry.transporterstring-netty性能调优网络传输方式,可选mina,netty2.0.0以上版本
timeoutregistry.timeoutint-5000性能调优注册中心请求超时时间(毫秒)2.0.0以上版本
sessionregistry.sessionint-60000性能调优注册中心会话超时时间(毫秒),用于检测提供者非正常断线后的脏数据,比如用心跳检测的实现,此时间就是心跳间隔,不同注册中心实现不一样。2.1.0以上版本
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以上版本
simplifiedsimplifiedboolean-false服务治理注册到注册中心的URL是否采用精简模式的(与低版本兼容)2.7.0以上版本
extra-keysextraKeysstring-服务治理在simplified=true时,extraKeys允许你在默认参数外将额外的key放到URL中,格式:“interface,key1,key2”。2.7.0以上版本

< dubbo:module />

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

属性对应URL参数类型是否必填缺省值作用描述兼容性
namemodulestring必填服务治理当前模块名称,用于注册中心计算模块间依赖关系2.2.0以上版本
versionmodule.versionstring-服务治理当前模块的版本2.2.0以上版本
ownerownerstring-服务治理模块负责人,用于服务治理,请填写负责人公司邮箱前缀2.2.0以上版本
organizationorganizationstring-服务治理组织名称(BU或部门),用于注册中心区分服务来源,此配置项建议不要使用autoconfig,直接写死在配置中,比如china,intl,itu,crm,asc,dw,aliexpress等2.2.0以上版本

< dubbo:monitor />

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

属性对应URL参数类型是否必填缺省值作用描述兼容性
protocolprotocolstring-dubbo服务治理监控中心协议,如果为protocol=“registry”,表示从注册中心发现监控中心地址,否则直连监控中心。2.0.9以上版本
addressstring-N/A服务治理直连监控中心服务器地址,address=“10.20.130.230:12080”1.0.16以上版本

< dubbo:provider />

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

属性对应URL参数类型是否必填缺省值作用描述兼容性
idstring-dubbo配置关联协议BeanId,可以在<dubbo:service proivder="">中引用此ID1.0.16以上版本
protocolstring-dubbo性能调优协议名称1.0.16以上版本
hoststring-自动查找本机IP服务发现服务主机名,多网卡选择或指定VIP及域名时使用,为空则自动查找本机IP,建议不要配置,让Dubbo自动获取本机IP1.0.16以上版本
threadsthreadsint-200性能调优服务线程池大小(固定大小)1.0.16以上版本
payloadpayloadint-8388608(=8M)性能调优请求及响应数据包大小限制,单位:字节2.0.0以上版本
path string-服务发现提供者上下文路径,为服务path的前缀2.0.0以上版本
serverserverstring-dubbo协议缺省为netty,http协议缺省为servlet性能调优协议的服务器端实现类型,比如:dubbo协议的mina,netty等,http协议的jetty,servlet等2.0.0以上版本
clientclientstring-dubbo协议缺省为netty性能调优协议的客户端实现类型,比如:dubbo协议的mina,netty等2.0.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以上版本
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,分别表示:随机,轮询,最少活跃调用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(1024 * 8)性能调优网络读写缓冲区大小2.0.5以上版本
iothreadsiothreadsint-CPU + 1性能调优IO线程池,接收网络读写中断,以及序列化和反序列化,不处理业务,业务线程池参见threads配置,此线程池和CPU相关,不建议配置。2.0.5以上版本
telnettelnetstring-服务治理所支持的telnet命令,多个命令用逗号分隔2.0.5以上版本
< dubbo:service >contextpathstring-服务治理缺省为空串
layerlayerstring服务治理服务提供者所在的分层。如:biz、dao、intl:web、china:acton。2.0.7以上版本

< dubbo: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,分别表示:随机,轮询,最少活跃调用1.0.16以上版本
asyncdefault.asyncboolean-false性能调优是否缺省异步执行,不可靠异步,只是忽略返回值,不阻塞执行线程2.0.0以上版本
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/forking2.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等Dubbo2.1.0及其以上版本支持
validationvalidationboolean-服务治理是否启用JSR303标准注解验证,如果启用,将对方法参数上的注解进行校验Dubbo2.1.0及其以上版本支持

< dubbo:config-center />

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

属性对应URL参数类型是否必填缺省值描述兼容性
protocolconfig.protocolstring-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+
addressconfig.addressstring必填配置中心地址。
取值参见protocol说明
2.7.0+
highest-priorityconfig.highestPriorityboolean-true来自配置中心的配置项具有最高优先级,即会覆盖本地配置项。2.7.0+
namespaceconfig.namespacestring-dubbo通常用于多租户隔离,实际含义视具体配置中心而不同。
如:
zookeeper - 环境隔离,默认值dubbo
apollo - 区分不同领域的配置集合,默认使用dubboapplication
2.7.0+
clusterconfig.clusterstring-含义视所选定的配置中心而不同。
如Apollo中用来区分不同的配置集群
2.7.0+
groupconfig.groupstring-dubbo含义视所选定的配置中心而不同。
nacos - 隔离不同配置集
zookeeper - 隔离不同配置集
2.7.0+
checkconfig.checkboolean-true当配置中心连接失败时,是否终止应用启动。2.7.0+
config-fileconfig.configFilestring-dubbo.properties全局级配置文件所映射到的key
zookeeper - 默认路径/dubbo/config/dubbo/dubbo.properties
apollo - dubbo namespace中的dubbo.properties键
2.7.0+
timeoutconfig.timeoutinteger-3000ms获取配置的超时时间2.7.0+
usernamestring如果配置中心需要做校验,用户名
Apollo暂未启用
2.7.0+
passwordstring如果配置中心需要做校验,密码
Apollo暂未启用
2.7.0+
parametersMap<string, string>扩展参数,用来支持不同配置中心的定制化配置参数2.7.0+
include-spring-envboolean-false使用Spring框架时支持,为true时,会自动从Spring Environment中读取配置。
默认依次读取
key为dubbo.properties的配置
key为dubbo.properties的PropertySource
2.7.0+

< dubbo:parameter />

选项参数配置。对应的配置类:java.util.Map。同时该标签为<dubbo:protocol><dubbo:service><dubbo:provider><dubbo:reference><dubbo:consumer>的子标签,用于配置自定义参数,该配置项将作为扩展点设置自定义参数使用。

属性对应URL参数类型是否必填缺省值作用描述兼容性
keykeystring必填服务治理路由参数键2.0.0以上版本
valuevaluestring必填服务治理路由参数值2.0.0以上版本

比如:

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

也可以:

<dubbo:protocol name="jms" p:queue="xxx" />
  • 1

< dubbo:method />

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

属性对应URL参数类型是否必填缺省值作用描述兼容性
namestring必填标识方法名1.0.8以上版本
timeout.timeoutint-缺省为的timeout性能调优方法调用超时时间(毫秒)1.0.8以上版本
retries.retriesint缺省为< dubbo:reference >的retries性能调优远程服务调用重试次数,不包括第一次调用,不需要重试请设为02.0.0以上版本
loadbalance.loadbalancestring缺省为的loadbalance性能调优负载均衡策略,可选值:random,roundrobin,leastactive,分别表示:随机,轮询,最少活跃调用2.0.0以上版本
async.asyncboolean缺省为< dubbo:reference >的async性能调优是否异步执行,不可靠异步,只是忽略返回值,不阻塞执行线程1.0.9以上版本
sent.sentbooleantrue性能调优异步调用时,标记sent=true时,表示网络已发出数据2.0.6以上版本
actives.activesint0性能调优每服务消费者最大并发调用限制2.0.5以上版本
executes.executesint0性能调优每服务每方法最大使用线程数限制- -,此属性只在< dubbo:method >作为< dubbo:service >子标签时有效2.0.5以上版本
deprecated.deprecatedbooleanfalse服务治理服务方法是否过时,此属性只在< dubbo:method >作为< dubbo:service >子标签时有效2.0.5以上版本
sticky.stickybooleanfalse服务治理设置true 该接口上的所有方法使用同一个provider.如果需要更复杂的规则,请使用用路由2.0.6以上版本
return.returnbooleantrue性能调优方法调用是否需要返回值,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以上版本
cache.cachestring/boolean服务治理以调用参数为key,缓存返回结果,可选:lru, threadlocal, jcache等Dubbo2.1.0及其以上版本支持
validation.validationboolean服务治理是否启用JSR303标准注解验证,如果启用,将对方法参数上的注解进行校验Dubbo2.1.0及其以上版本支持

< dubbo:argument />

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

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

2. 不同粒度配置的覆盖关系

timeout 为例,下图显示了配置的查找顺序,其它 retries, loadbalance, actives 等类似:

  • 方法级优先,接口级次之,全局配置再次之。
  • 如果级别一样,则消费方优先,提供方次之。

其中,服务提供方配置,通过 URL 经由注册中心传递给消费方。
在这里插入图片描述

(建议由服务提供方设置超时,因为一个方法需要执行多长时间,服务提供方更清楚,如果一个消费方同时引用多个服务,就不需要关心每个服务的超时设置)。

理论上 ReferenceConfig 中除了interface这一项,其他所有配置项都可以缺省不配置,框架会自动使用ConsumerConfig,ServiceConfig, ProviderConfig等提供的缺省配置。



3. 参考文档

https://dubbo.apache.org/zh/docs/

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/盐析白兔/article/detail/165884
推荐阅读
相关标签