Dubbo参数配置解析

转载

Dongguabai 2022-12-22 00:22:03

文章标签 性能调优服务治理服务发现 文章分类 运维

Dubbo参数配置解析

注意

在dubbo中，group,version,interface是服务的匹配条件，也只有这三个参数来决定是不是同一个服务，其他的配置均为调优和治理参数。

所有的配置项分为三大类：(参见下表中的“作用”一列)

服务发现:表示该配置项用于服务的注册与发现，目的是让消费方找到提供方；
服务治理:表示该配置项用于治理服务间的关系，或为开发测试提供便利条件；
性能调优:表示该配置项用于性能调优，不同的选项对性能会产生影响；

所有的配置最终都将转换为URL表示，并由服务提供方生成，经注册中心传递给消费方,URL格式为：(各属性对应URL的参数，参见配置项一览表中的“对应URL参数”列)，

protocol://username:password@host:port/path?key=value&key=value

服务提供者暴露服务配置

配置类：com.alibaba.dubbo.config.ServiceConfig

标签	属性	对应URL	类型	是否必填	缺省值	作用	描述	兼容性
`<dubbo:service>`	interface	-	class	必填	-	服务发现	服务接口名	1.0.0以上版本
`<dubbo:service>`	ref	-	object	必填	-	服务发现	服务对象实现引用	1.0.0以上版本
`<dubbo:service>`	version	version	string	可选	0.0.0	服务发现	服务版本，建议使用两位数字版本，如：1.0，通常在接口不兼容是版本号才需要升级	1.0.0以上版本
`<dubbo:service>`	group	group	string	可选	-	服务发现	服务分组，当一个借口有多个实现，可以用分组区分	1.0.7以上版本
`<dubbo:service>`	path		string	可选	缺省为接口	服务发现	服务路径	1.0.12以上版本
`<dubbo:service>`	delay	delay	int	可选	0	性能调优	延迟注册服务时间(毫秒)，设为-1时，表示延迟到Spring容器初始化完成时暴露服务	1.0.14以上版本
`<dubbo:service>`	timeout	timeout	int	可选	1000	性能调优	远程服务调用超时时间(毫秒)	2.0.0以上版本
`<dubbo:service>`	retries	retries	int	可选	2	性能调优	远程服务调用重试次数，不包括第一次调用，0为不需要重试	2.0.0以上版本
`<dubbo:service>`	connections	connections	boolean	可选	100	性能调优	对每个提供者的最大连接数，rmi、http、hesslan等多连接协议表示限制连接数，dubbo等长链接协议表示建立的长连接个数	2.0.0以上版本
`<dubbo:service>`	loadbalance	loadbalance	string	可选	random	性能调优	负载均衡策略，可选值：random，roundrobin，leastactice，分别表示：随机，轮询，最少活跃调用	2.0.0以上版本
`<dubbo:service>`	async	async	boolean	可选	false	性能调优	是否缺省异步执行，不可靠异步，只是忽略返回值，不阻塞执行线程	2.0.0以上版本
`<dubbo:service>`	stub	stub	class/boolean	可选	false	服务治理	设为ture，表示使用缺省代理类名，即：接口名+Local后缀，服务接口客户端本地代理类名，用于在客户端执行本地逻辑，如本地缓存等。该本地代理类的构造函数必须允许传入远程代理对象，构造函数如：`public xxxServiceLocal(XxxService xxxService)`	2.0.0以上版本
`<dubbo:service>`	mock	mock	class/boolean	可选	false	服务治理	设为true，表示使用缺省Mock类名，即：接口名+Mock后缀，服务接口调用失败Mock实现类，该Mock类必须有一个无参构造函数，与Local的区别在于，Local总是被执行，而Mock只在出现非业务异常(比如超时，网络异常等)时执行，Local在远程调用之前执行，Mock在远程调用后执行	2.0.0以上版本
`<dubbo:service>`	token	token	string/bollean	可选	false	服务治理	令牌验证，为空表示不开启。如果为true，表示随机生成动态令牌，否则使用静态令牌。令牌的作用是防止消费者绕过注册中心直接访问，保证注册中心的授权功能有效。如果使用点对点调用，需要关闭令牌功能	2.0.0以上版本
`<dubbo:service>`	registry	-	string	可选	缺省向所有registry注册	配置关联	向指定注册中心注册`<dubbo:registry>的属性为id的value`；在向多个注册中心注册时，多个id使用逗号分隔；如果不想讲该服务注册到任何registry，可将值设置N/A	2.0.0以上版本
`<dubbo:service>`	provider	-	string	可选	缺省使用第一个provider配置	配置关联	指定provider，值为`<dubbo:provider>`的id属性	2.0.0以上版本
`<dubbo:service>`	deprecated	deprecated	boolean	可选	false	服务治理	服务是否过时，如果设置为true，消费方引用时将打印服务过时警告error日志	2.0.5以上版本
`<dubbo:service>`	dynamic	dynamic	boolean	可选	true	服务治理	服务是否动态注册，如果设为false，注册后将显示disable状态，需要人工启用；并且服务提供者停止时，也不会自动取消注册，需要人工禁用	2.0.5以上版本
`<dubbo:service>`	accesslog	accesslog	string/boolean	可选	false	服务治理	设为true，将向logger中输入访问日志，也可以填写访问日志文件路径，直接把访问日志输出到指定文件	2.0.5以上版本
`<dubbo:service>`	owner	owner	string	可选	-	服务治理	服务责任人，用于服务治理，请填写公司负责人邮箱前缀	2.0.5以上版本
`<dubbo:service>`	document	document	string	可选	-	服务治理	服务文档URL	1.0.5以上版本
`<dubbo:service>`	weight	weight	int	可选	-	服务调优	服务权重	2.0.5以上版本
`<dubbo:service>`	executes	executes	int	可选	0	性能调优	服务提供者每个服务方法最大可并行请求数
`<dubbo:service>`	actives	actives	int	可选	0	性能调优	服务消费者每个服务方法最大并发调用数
`<dubbo:service>`	proxy	proxy	string	可选	javassist	性能调优	省城动态代理方法，可选：jdk/javassist	2.0.5以上版本
`<dubbo:service>`	cluster	cluster	stirng	可选	failover	性能调优	集群方式，可选:failover/failfast/failsafe/failback/forking	2.0.5以上版本
`<dubbo:service>`	filter	service.filter	string	可选	default	性能调优	服务提供方远程调用过程拦截器名称，多个名称用逗号分隔	2.0.5以上版本
`<dubbo:service>`	listener	exporter.listener	string	可选	default	性能调优	服务提供方导出服务监听器名称，多个名称用逗号分隔	2.0.5以上版本
`<dubbo:service>`	protocol	-	string	可选	-	配置关联	使用指定的协议暴露服务，在使用多协议时，`<dubbo:protocol>的id属性的value`,使用逗号分隔	2.0.5以上版本
`<dubbo:service>`	layer	layer	string	可选	-	服务治理	服务提供者所在的分层。如：biz,dao,intl:web,china:acton	2.0.7以上版本
`<dubbo:service>`	register	register	boolean	可选	true	服务治理	该协议的服务是否注册到注册中心	2.0.8以上版本

服务消费者引用服务配置

配置类:com.alibaba.dubbo.config.ReferenceConfig

标签	属性	对应URL	类型	是否必填	缺省值	作用	描述	兼容性
`<dubbo:reference>`	id	-	string	必填	-	配置关联	服务应用bean id	1.0.0以上版本
`<dubbo:reference>`	interface	-	class	必填	-	服务发现	服务接口名	1.0.0以上版本
`<dubbo:reference>`	version	version	string	可选	-	服务发现	服务版本，与服务提供者的版本保持一致	1.0.0以上版本
`<dubbo:reference>`	group	group	string	可选	-	服务发现	服务分组，当一个借口有多个实现，可以用分组区分，必须和服务提供方一致	1.0.7版本
`<dubbo:reference>`	timeout	timeout	long	可选	缺省使用`<dubbo:consumer>`的timeout	性能调优	服务方法调用超时时间(毫秒)	1.0.5以上版本
`<dubbo:reference>`	retries	retries	int	可选	缺省使用`<dubbo:consumer>`的retries	性能调优	远程服务调用重试次数，不包括第一次调用，不需要重试请设置为0	2.0.0以上版本
`<dubbo:reference>`	connections	connections	int	可选	缺省使用的connections	性能调优	对每个提供者的最大连接数，rmi、http、hessian等短连接协议表示限制连接数，dubbo等长连接协表示建立的长连接个数	2.0.0以上版本
`<dubbo:reference>`	loadbalance	loadbalance	string	可选	缺省使用的loadbalance	性能调优	负载均衡策略，可选值：random,roundrobin,leastactive，分别表示：随机，轮循，最少活跃调用	2.0.0以上版本
`<dubbo:reference>`	sync	sync	boolean	可选	缺省使用的async	性能调优	是否异步执行，不可靠异步，只是忽略返回值，不阻塞执行线程	2.0.0以上版本
`<dubbo:reference>`	generic	generic	boolean	可选	缺省使用的generic	服务治理	是否缺省泛化接口，如果为泛化接口，将返回GenericService	2.0.0以上版本
`<dubbo:reference>`	check	check	boolean	可选	缺省使用的check	服务治理	启动时检查提供者是否存在，true报错，false忽略	2.0.0以上版本
`<dubbo:reference>`	url	`<url>`	string	可选	-	服务治理	点对点直连服务提供者地址，将绕过注册中心	1.0.6以上版本
`<dubbo:reference>`	stub	stub	class/boolean	可选	-	服务治理	服务接口客户端本地代理类名，用于在客户端执行本地逻辑，如本地缓存等，该本地代理类的构造函数必须允许传入远程代理对象，构造函数如：public XxxServiceLocal(XxxService xxxService)	2.0.0以上版本
`<dubbo:reference>`	mock	mock	class/boolean	可选	-	服务治理	服务接口调用失败Mock实现类名，该Mock类必须有一个无参构造函数，与Local的区别在于，Local总是被执行，而Mock只在出现非业务异常(比如超时，网络异常等)时执行，Local在远程调用之前执行，Mock在远程调用后执行	1.0.13以上版本
`<dubbo:reference>`	cache	cache	string/boolean	可选	-	服务治理	以调用参数为key，缓存返回结果。可选：lru, threadlocal, jcache等	2.1.0以上版本
`<dubbo:reference>`	validation	validation	boolean	可选	-	服务治理	是否启用JSR303标准注解验证，如果启用，将对方法参数上的注解进行校验	2.1.0以上版本
`<dubbo:reference>`	proxy	proxy	boolean	可选	javassist	性能调优	选择动态代理实现策略，可选：javassist, jdk	2.0.2以上版本
`<dubbo:reference>`	client	client	string	可选	-	性能调优	客户端传输类型设置，如Dubbo协议的netty或mina	2.0.0以上版本
`<dubbo:reference>`	registry	-	string	可选	缺省将从所有注册中心获服务列表后合并结果	配置关联	从指定注册中心注册获取服务列表，在多个注册中心时使用，值为的id属性，多个注册中心ID用逗号分隔	2.0.0以上版本
`<dubbo:reference>`	owner	owner	string	可选	-	服务治理	调用服务负责人，用于服务治理，请填写负责人公司邮箱前缀	2.0.5以上版本
`<dubbo:reference>`	actives	actives	int	可选	0	性能调优	服务消费者每个服务方法最大并发调用数	2.0.5以上版本
`<dubbo:reference>`	cluster	cluster	string	可选	failover	性能优化	集群方式，可选：failover/failfast/failsafe/failback/forking	2.0.5以上版本
`<dubbo:reference>`	filter	reference.filter	string	可选	default	性能调优	服务消费方远程调用过程拦截器名称，多个名称用逗号分隔	2.0.5以上版本
`<dubbo:reference>`	listener	invoker.listener	string	可选	default	性能调优	服务消费方引用服务监听器名称，多个名称用逗号分隔	2.0.5以上版本
`<dubbo:reference>`	layer	layer	string	可选	-	服务治理	服务调用者所在的分层。如：biz、dao、intl:web、china:acton	2.0.7以上版本
`<dubbo:reference>`	init	init	boolean	可选	false	性能调优	是否在afterPropertiesSet()时饥饿初始化引用，否则等到有人注入或引用该实例时再初始化	2.0.10以上版本
`<dubbo:reference>`	protocol	protocol	string	可选	-	服务治理	只调用指定协议的服务提供方，其他协议忽略	2.2.0以上版本