[dubbo] Dubbo API 笔记——配置参考

2022-11-12 09:50:11

schema 配置参考

所有配置项分为三大类

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

所有配置最终都将转换为 URL 表示，并由服务提供方生成，经注册中心传递给消费方

    URL 格式： protocol://username:password@host:port/path?key=value&key=value

只有 group，interface，version 是服务的匹配条件，三者决定是不是同一个服务，其它配置项均为调优和治理参数

dubbo:service

服务提供者暴露服务配置


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

dubbo:reference

服务消费者引用服务配置


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

dubbo:protocol

服务提供者协议配置，如果需要支持多协议，可以声明多个 <dubbo:protocol> 标签，并在 <dubbo:service> 中通过 protocol 属性指定使用的协议


属性	对应URL参数	类型	是否必填	缺省值	作用
id		string	可选	dubbo	配置关联	协议BeanId，可以在<dubbo:service protocol=”“>中引用此ID，如果ID不填，缺省和name属性值一样，重复则在name后加序号
name	<protocol>	string	必填	dubbo	性能调优	协议名称
port	<port>	int	可选	dubbo协议缺省端口为20880， rmi协议缺省端口为1099，http 和hessian协议缺省端口为80；如果配置为-1 或者没有配置port，则会分配一个没有被占用的端口。Dubbo 2.4.0+，分配的端口在协议缺省端口的基础上增长，确保端口段可控	服务发现	服务端口
host	<host>	string	可选	自动查找本机IP	服务发现	-服务主机名，多网卡选择或指定VIP及域名时使用，为空则自动查找本机IP，-建议不要配置，让Dubbo自动获取本机IP
threadpool	threadpool	string	可选	fixed	性能调优	线程池类型，可选：fixed/cached
threads	threads	int	可选	100	性能调优	服务线程池大小(固定大小)
iothreads	threads	int	可选	cpu个数+1	性能调优	io线程池大小(固定大小)
accepts	accepts	int	可选	0	性能调优	服务提供方最大可接受连接数
payload	payload	int	可选	88388608(=8M)	性能调优	请求及响应数据包大小限制，单位：字节
codec	codec	string	可选	dubbo	性能调优	协议编码方式
serialization	serialization	string	可选	dubbo协议缺省为hessian2，rmi协议缺省为java，http协议缺省为json	性能调优	协议序列化方式，当协议支持多种序列化方式时使用，比如：dubbo协议的dubbo,hessian2,java,compactedjava，以及http协议的json等
accesslog	accesslog	string/boolean	可选		服务治理	设为true，将向logger中输出访问日志，也可填写访问日志文件路径，直接把访问日志输出到指定文件
path	<path>	string	可选		服务发现	提供者上下文路径，为服务path的前缀
transporter	transporter	string	可选	dubbo协议缺省为netty	性能调优	协议的服务端和客户端实现类型，比如：dubbo协议的mina,netty等，可以分拆为server和client配置
server	server	string	可选	dubbo协议缺省为netty，http协议缺省为servlet	性能调优	协议的服务器端实现类型，比如：dubbo协议的mina,netty等，http协议的jetty,servlet等
client	client	string	可选	dubbo	协议缺省为netty	性能调优
dispatcher	dispatcher	string	可选	dubbo协议缺省为all	性能	协议的消息派发方式，用于指定线程模型，比如：dubbo协议的all,direct,message,execution,connection等
queues	queues	int	可选	0	性能调优	线程池队列大小，当线程池满时，排队等待执行的队列大小，建议不要设置，当线程程池时应立即失败，重试其它服务提供机器，而不是排队，除非有特殊需求
charset	charset	string	可选	UTF-8	性能调优	序列化编码
buffer	buffer	int	可选	8192	性能调优	网络读写缓冲区大小
heartbeat	heartbeat	int	可选	0	性能调优	心跳间隔，对于长连接，当物理层断开时，比如拔网线，TCP的FIN消息来不及发送，对方收不到断开事件，此时需要心跳来帮助检查连接是否已断开
telnet	telnet	string	可选		服务治理	所支持的telnet命令，多个命令用逗号分隔
register	register	boolean	可	选	true服务治理	该协议的服务是否注册到注册中心
contextpath	contextpath	string	可选	缺省为空串	服务治理

dubbo:registry

注册中心配置，如果有多个不同的注册中心，可以声明多个 <dubbo:registry> 标签，并在 <dubbo:service> 或 <dubbo:reference> 的 registry 属性指定使用的注册中心


属性	对应URL参数	类型	是否必填	缺省值	作用
id		string	可选		配置关联	注册中心引用BeanId，可以在 <dubbo:service registry=”“>或 <dubbo:reference registry=”“>中引用此ID
address	<host:port>	string	必填		服务发现	注册中心服务器地址，如果地址没有端口缺省为9090，同一集群内的多个地址用逗号分隔，如：ip:port,ip:port，不同集群的注册中心，请配置多个 <dubbo:registry> 标签
protocol	<protocol>	string	可选	dubbo	服务发现	注同中心地址协议，支持dubbo, http, local三种协议，分别表示， dubbo地址，http 地址，本地注册中心
port	<port>	int	可选	9090	服务发现	注册中心缺省端口，当address没有带端口时使用此端口做为缺省值
username	<username>	string	可选		服务治理	登录注册中心用户名，如果注册中心不需要验证可不填
password	<password>	string	可选		服务治理	登录注册中心密码，如果注册中心不需要验证可不填
transport	registry.transporter	string	可选	netty	性能调优	网络传输方式，可选mina,netty
timeout	registry.timeout	int	可选	5000	性能调优	注册中心请求超时时间(毫秒)
session	registry.session	int	可选	60000	性能调优	注册中心会话超时时间(毫秒)，用于检测提供者非正常断线后的脏数据，比如用心跳检测的实现，此时间就是心跳间隔，不同注册中心实现不一样
file	registry.file	string	可选		服务治理	使用文件缓存注册中心地址列表及服务提供者列表，应用重启时将基于此文件恢复，注意：两个注册中心不能使用同一文件存储
wait	registry.wait	int	可选	0	性能调优	停止时等待通知完成时间(毫秒)
check	check	boolean	可选	true服务治理	注册中心不存在时，是否报错
register	register	boolean	可选	true	服务治理	是否向此注册中心注册服务，如果设为false，将只订阅，不注册
subscribe	subscribe	boolean	可选	true	服务治理	是否向此注册中心订阅服务，如果设为false，将只注册，不订阅
dynamic	dynamic	boolean	可选	true	服务治理	服务是否动态注册，如果设为 false，注册后将显示后disable状态，需人工启用，并且服务提供者停止时，也不会自动取消册，需人工禁用

dubbo:monitor

监控中心配置


属性	对应URL参数	类型	是否必填	缺省值	作用
protocol	protocol	string	可选	dubbo	服务治理	监控中心协议，如果为protocol=”registry”，表示从注册中心发现监控中心地址，否则直连监控中心
address	<url>	string	可选	N/A	服务治理	直连监控中心服务器地址，address=”10.20.130.230:12080”

dubbo:application

应用信息配置


属性	对应URL参数	类型	是否必填	缺省值	作用
name	application	string	必填		服务治理	当前应用名称，用于注册中心计算应用间依赖关系，注意：消费者和提供者应用名不要一样，此参数不是匹配条件，你当前项目叫什么名字就填什么，和提供者消费者角色无关，比如：kylin应用调用了morgan应用的服务，则kylin项目配成kylin，morgan项目配成morgan，可能kylin也提供其它服务给别人使用，但kylin项目永远配成kylin，这样注册中心将显示kylin依赖于morgan
version	application.version	string	可选		服务治理	当前应用的版本
owner	owner	string	可选		服务治理	应用负责人，用于服务治理，请填写负责人公司邮箱前缀
organization	organization	string	可选		服务治理	组织名称(BU或部门)，用于注册中心区分服务来源，此配置项建议不要使用autoconfig，直接写死在配置中，比如 china,intl,itu,crm,asc,dw,aliexpress 等
architecture	architecture	string	可选		服务治理	用于服务分层对应的架构。如，intl、china。不同的架构使用不同的分层
environment	environment	string	可选		服务治理	应用环境，如： develop/test/product，不同环境使用不同的缺省值，以及作为只用于开发测试功能的限制条件
compiler	compiler	string	可选	javassist	性能优化	Java字节码编译器，用于动态类的生成，可选：jdk或javassist
logger	logger	string	可选	slf4j	性能优化	日志输出方式，可选： slf4j,jcl,log4j,jdk

dubbo:module

模块信息配置


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

dubbo:provider

服务提供者缺省值配置，同时该标签为 <dubbo:service> 和 <dubbo:protocol> 标签的缺省值设置


属性	对应URL参数	类型	是否必填	缺省值
id		string	可选	dubbo
protocol	<protocol>	string	可选	dubbo
host	<host>	string	可选	自动查找本机IP
threads	threads	int	可选	100
payload	payload	int	可选	88388608(=8M)
path	<path>	string	可选
server	server	string	可选	dubbo协议缺省为netty，http协议缺省为servlet
client	client	string	可选	dubbo协议缺省为netty
codec	codec	string	可选	dubbo
serialization	serialization	string	可选	dubbo协议缺省为hessian2， rmi协议缺省为java，http协议缺省为json
default		boolean	可选	false
filter	service.filter	string	可选
listener	exporter.listener	string	可选
threadpool	threadpool	string	可选	fixed
accepts	accepts	int	可选	0
version	version	string	可选	0.0.0
group	group	string	可选
delay	delay	int	可选	0
timeout	default.timeout	int	可选	1000
retries	default.retries	int	可选	2
connections	default.connections	int	可选	0
loadbalance	default.loadbalance	string	可选	random
async	default.async	boolean	可选	false
stub	stub	boolean	可选	false
mock	mock	boolean	可选	false
token	token	boolean	可选	false
registry	registry	string	可选	缺省向所有registry注册
dynamic	dynamic	boolean	可选	true
accesslog	accesslog	string/boolean	可选	false
owner	owner	string	可选
document	document	string	可选
weight	weight	int	可选
executes	executes	int	可选	0
actives	default.actives	int	可选	0
proxy	proxy	string	可选	javassist
cluster	default.cluster	string	可选	failover
deprecated	deprecated	boolean	可选	false
queues	queues	int	可选	0
charset	charset	string	可选	UTF-8
buffer	buffer	int	可选	8192
iothreads	iothreads	int	可选	CPU+1
telnet	telnet	string	可选
<dubbo:service>	contextpath	contextpath	String	可选
layer	layer	string	可选

dubbo:consumer

服务消费者缺省值配置，同时该标签为 <dubbo:reference> 标签的缺省值设置


属性	对应URL参数	类型	是否必填	缺省值	作用
timeout	default.timeout	int	可选	1000	性能调优	远程服务调用超时时间(毫秒)
retries	default.retries	int	可选	2	性能调优	远程服务调用重试次数，不包括第一次调用，不需要重试请设为0
loadbalance	default.loadbalance	string	可选	random	性能调优	负载均衡策略，可选值：random,roundrobin,leastactive，分别表示：随机，轮循，最少活跃调用
async	default.async	boolean	可选	false	性能调优	是否缺省异步执行，不可靠异步，只是忽略返回值，不阻塞执行线程
connections	default.connections	int	可选	100	性能调优	每个服务对每个提供者的最大连接数，rmi、http、hessian等短连接协议支持此配置，dubbo协议长连接不支持此配置
generic	generic	boolean	可选	false	服务治理	是否缺省泛化接口，如果为泛化接口，将返回GenericService
check	check	boolean	可选	true	服务治理	启动时检查提供者是否存在，true报错，false忽略
proxy	proxy	string	可选	javassist	性能调优	生成动态代理方式，可选： jdk/javassist
owner	owner	string	可选		服务治理	调用服务负责人，用于服务治理，请填写负责人公司邮箱前缀
actives	default.actives	int	可选	0	性能调优	每服务消费者每服务每方法最大并发调用数
cluster	default.cluster	string	可选	failover	性能调优	集群方式，可选：failover/failfast/failsafe/failback/forking
filter	reference.filter	string	可选		性能调优	服务消费方远程调用过程拦截器名称，多个名称用逗号分隔
listener	invoker.listener	string	可选		性能调优	服务消费方引用服务监听器名称，多个名称用逗号分隔
registry		string	可选	缺省向所有 registry 注册	配置关联	向指定注册中心注册，在多个注册中心时使用，值为<dubbo:registry>的id属性，多个注册中心ID用逗号分隔，如果不想将该服务注册到任何registry，可将值设为N/A
layer	layer	string	可选		服务治理	服务调用者所在的分层。如：biz、dao、intl:web、china:acton
init	init	boolean	可选	false	性能调优	是否在afterPropertiesSet()时饥饿初始化引用，否则等到有人注入或引用该实例时再初始化
cache	cache	string/boolean	可选		服务治理	以调用参数为key，缓存返回结果，可选：lru, threadlocal, jcache等
validation	validation	boolean	可选		服务治理	是否启用JSR303标准注解验证，如果启用，将对方法参数上的注解进行校验

dubbo:method

方法级配置，同时该标签为 <dubbo:service> 或 <dubbo:reference> 的子标签，用于控制到方法级

<dubbo:reference interface="com.xxx.XxxService">

    <dubbo:method name="findXxx" timeout="3000" retries="2" />

</dubbo:reference>


属性	对应URL参数	类型	是否必填	缺省值
name		string	必填
timeout	<metodName>.timeout	int	可选	缺省为的timeout
retries	<metodName>.retries	int	可选	缺省为 <dubbo:reference> 的retries
loadbalance	<metodName>.loadbalance	string	可选	缺省为的 loadbalance
async	<metodName>.async	boolean	可选	缺省为 <dubbo:reference> 的async
sent	<methodName>.sent	boolean	可选	true
actives	<metodName>.actives	int	可选	0
executes	<metodName>.executes	int	可选	0
deprecated	<methodName>.deprecated	boolean	可选	false
sticky	<methodName>.sticky	boolean	可选	false
return	<methodName>.return	boolean	可选	true
oninvoke	attribute属性，不在URL中体现	String	可选
onreturn	attribute属性，不在URL中体现	String	可选
onthrow	attribute属性，不在URL中体现	String	可选
cache	<methodName>.cache	string/boolean	可选
validation	<methodName>.validation	boolean	可选

dubbo:argument

方法参数配置，该标签为 <dubbo:method> 的子标签，用于方法参数的特征描述

<dubbo:method name="findXxx" timeout="3000" retries="2">

    <dubbo:argument index="0" callback="true" />

</dubbo:method>


属性	对应URL参数	类型	是否必填	缺省值	作用	描述	兼容性
index		int	必填		标识	方法名	2.0.6 以上版本
type		String	与 index 二选一		标识	通过参数类型查找参数的 index	2.0.6 以上版本
callback	<metodName><index>.retries	boolean	可选		服务治理	参数是否为callback接口，如果为callback，服务提供方将生成反向代理，可以从服务提供方反向调用消费方，通常用于事件推送	2.0.6以上版本

dubbo:parameter

选项参数配置，该标签为 <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>


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

码农公寓