Dubbo源码初学
一、XML文件配置
和spring一样,了解dubbo的第一步就是了解配置文件(以xml文件为例)
服务提供者provider.xml
<beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:dubbo="http://dubbo.apache.org/schema/dubbo"
xmlns="http://www.springframework.org/schema/beans"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd">
<dubbo:application name="demo-provider"/>
<dubbo:registry address="zookeeper://127.0.0.1:2181"/>
<dubbo:protocol name="dubbo" port="20890"/>
<bean id="demoService" class="org.apache.dubbo.samples.basic.impl.DemoServiceImpl"/>
<dubbo:service interface="org.apache.dubbo.samples.basic.api.DemoService" ref="demoService"/>
</beans>
服务消费者consumer.xml
<beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:dubbo="http://dubbo.apache.org/schema/dubbo"
xmlns="http://www.springframework.org/schema/beans"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd">
<dubbo:application name="demo-consumer"/>
<dubbo:registry group="aaa" address="zookeeper://127.0.0.1:2181"/>
<dubbo:reference id="demoService" check="false" interface="org.apache.dubbo.samples.basic.api.DemoService"/>
</beans>
对于dubbo中的每个标签都可以自定义(了解即可)
<dubbo:protocol name="jms">
<dubbo:parameter key="queue" value="your_queue" />
</dubbo:protocol>
或者
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:dubbo="http://dubbo.apache.org/schema/dubbo"
xmlns:p="http://www.springframework.org/schema/p"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd">
<dubbo:protocol name="jms" p:queue="your_queue" />
</beans>
每个标签的作用:(必须了解)
标签 | 用途 | 解释 |
---|---|---|
<dubbo:service/> | 服务配置 | 用于暴露一个服务,定义服务的元信息,一个服务可以用多个协议暴露,一个服务也可以注册到多个注册中心 |
<dubbo:reference/> 2 | 引用配置 | 用于创建一个远程服务代理,一个引用可以指向多个注册中心 |
<dubbo:protocol/> | 协议配置 | 用于配置提供服务的协议信息,协议由提供方指定,消费方被动接受 |
<dubbo:application/> | 应用配置 | 用于配置当前应用信息,不管该应用是提供者还是消费者 |
<dubbo:module/> | 模块配置 | 用于配置当前模块信息,可选 |
<dubbo:registry/> | 注册中心配置 | 用于配置连接注册中心相关信息 |
<dubbo:monitor/> | 监控中心配置 | 用于配置连接监控中心相关信息,可选 |
<dubbo:provider/> | 提供方配置 | 当 ProtocolConfig 和 ServiceConfig 某属性没有配置时,采用此缺省值,可选 |
<dubbo:consumer/> | 消费方配置 | 当 ReferenceConfig 某属性没有配置时,采用此缺省值,可选 |
<dubbo:method/> | 方法配置 | 用于 ServiceConfig 和 ReferenceConfig 指定方法级的配置信息 |
<dubbo:argument/> | 参数配置 | 用于指定方法参数配置 |
另外还有API配置等配置方式,了解即可
对xml配置,进行相关重点解析,便于后面源码的阅读,配置主要分为三类
服务发现:表示该配置项用于服务的注册与发现,目的是让消费方找到提供方。
服务治理:表示该配置项用于治理服务间的关系,或为开发测试提供便利条件。
性能调优:表示该配置项用于调优性能,不同的选项对性能会产生影响。
所有的配置最终都会转换成dubbo中的URL类,并由服务提供方生成,经注册中心传递给消费方,各属性对应 URL 的参数,URL 格式:protocol://username:password@host:port/path?key=value&key=value
。此URL需要稍微区别浏览器的URL,这是一个类,是dubbo中传输信息的重要纽带
此处重点说明!!!!!!URL特别重要,彻底明白URL类对阅读dubbo源码有事半功倍的效果
URL类所有属性
class URL implements Serializable {
private static final long serialVersionUID = -1985165475234910535L;
// 下面几个参数,共同组成了dubbo中约定的URL。protocol://username:password@host:port/path?key=value&key=value
private final String protocol;//协议头,如dubbo
private final String username;//用户名
private final String password;//密码
// by default, host to registry
private final String host;//IP
// by default, port to registry
private final int port;//端口
private final String path;//路径
private final Map<String, String> parameters;//参数
// ==== cache ====下面都是缓存,不会序列化
private volatile transient Map<String, Number> numbers;
private volatile transient Map<String, URL> urls;
private volatile transient String ip;
private volatile transient String full;
private volatile transient String identity;
private volatile transient String parameter;
private volatile transient String string;
//=======相关方法省略==========
}
下面针对XML中的13个配置标签进行学习
1、dubbo:application
应用信息配置,对应配置类org.apache.dubbo.config.ApplicationConfig
属性 | 对应URL参数 | 描述 |
---|---|---|
name(必填) | application | 当前应用名称,用于注册中心计算应用间依赖关系,注意:消费者和提供者应用名不要一样,此参数不是匹配条件,你当前项目叫什么名字就填什么,和提供者消费者角色无关,比如:kylin应用调用了morgan应用的服务,则kylin项目配成kylin,morgan项目配成morgan,可能kylin也提供其它服务给别人使用,但kylin项目永远配成kylin,这样注册中心将显示kylin依赖于morgan |
owner | owner | 应用负责人,用于服务治理,请填写负责人公司邮箱前缀 |
organization | organization | 组织名称(BU或部门),用于注册中心区分服务来源,此配置项建议不要使用autoconfig,直接写死在配置中,比如china,intl,itu,crm,asc,dw,aliexpress等 |
architecture | architecture | 用于服务分层对应的架构。如,intl、china。不同的架构使用不同的分层。 |
version | application.version | 当前应用的版本 |
environment | environment | 应用环境,如:develop/test/product,不同环境使用不同的缺省值,以及作为只用于开发测试功能的限制条件 |
compiler | compiler | Java字节码编译器,用于动态类的生成,可选:jdk或javassist |
logger | logger | 日志输出方式,可选:slf4j,jcl,log4j,log4j2,jdk |
2、dubbo:protocol
服务提供者协议配置,对应的配置类:org.apache.dubbo.config.ProtocolConfig。同时,如果需要支持多协议,可以声明多个 <dubbo:protocol>
标签,并在 <dubbo:service>
中通过 protocol
属性指定使用的协议。
属性 | 对应URL参数 | 描述 |
---|---|---|
id | 协议BeanId,可以在<dubbo:service protocol="">中引用此ID,如果ID不填,缺省和name属性值一样,重复则在name后加序号。 | |
name(必填) | 协议名称 | |
port | 服务端口 | |
host | -服务主机名,多网卡选择或指定VIP及域名时使用,为空则自动查找本机IP,-建议不要配置,让Dubbo自动获取本机IP | |
threadpool | threadpool | 线程池类型,可选:fixed/cached |
threads | threads | 服务线程池大小(固定大小) |
iothreads | threads | io线程池大小(固定大小) |
accepts | accepts | 服务提供方最大可接受连接数 |
payload | payload | 请求及响应数据包大小限制,单位:字节 |
codec | codec | 协议编码方式 |
serialization | serialization | 协议序列化方式,当协议支持多种序列化方式时使用,比如:dubbo协议的dubbo,hessian2,java,compactedjava,以及http协议的json等 |
accesslog | accesslog | 设为true,将向logger中输出访问日志,也可填写访问日志文件路径,直接把访问日志输出到指定文件 |
path |
| 提供者上下文路径,为服务path的前缀 |
transporter | transporter | 协议的服务端和客户端实现类型,比如:dubbo协议的mina,netty等,可以分拆为server和client配置 |
server | server | 协议的服务器端实现类型,比如:dubbo协议的mina,netty等,http协议的jetty,servlet等 |
client | client | 协议的客户端实现类型,比如:dubbo协议的mina,netty等 |
dispatcher | dispatcher | 协议的消息派发方式,用于指定线程模型,比如:dubbo协议的all, direct, message, execution, connection等 |
queues | queues | 线程池队列大小,当线程池满时,排队等待执行的队列大小,建议不要设置,当线程池满时应立即失败,重试其它服务提供机器,而不是排队,除非有特殊需求。 |
charset | charset | 序列化编码 |
buffer | buffer | 网络读写缓冲区大小 |
heartbeat | heartbeat | 心跳间隔,对于长连接,当物理层断开时,比如拔网线,TCP的FIN消息来不及发送,对方收不到断开事件,此时需要心跳来帮助检查连接是否已断开 |
telnet | telnet | 所支持的telnet命令,多个命令用逗号分隔 |
register | register | 该协议的服务是否注册到注册中心 |
contextpath | contextpath |
3、dubbo:registry
注册中心配置。对应的配置类: org.apache.dubbo.config.RegistryConfig
。同时如果有多个不同的注册中心,可以声明多个 <dubbo:registry>
标签,并在 <dubbo:service>
或 <dubbo:reference>
的 registry
属性指定使用的注册中心。
属性 | 对应URL参数 | 描述 |
---|---|---|
id | 注册中心引用BeanId,可以在<dubbo:service registry="">或<dubbo:reference registry="">中引用此ID | |
address(必填) | host:port | 注册中心服务器地址,如果地址没有端口缺省为9090,同一集群内的多个地址用逗号分隔,如:ip:port,ip:port,不同集群的注册中心,请配置多个dubbo:registry标签 |
protocol | 注册中心地址协议,支持dubbo , multicast , zookeeper , redis , consul(2.7.1) , sofa(2.7.2) , etcd(2.7.2) , nacos(2.7.2) 等协议 | |
port | 注册中心缺省端口,当address没有带端口时使用此端口做为缺省值 | |
username | 登录注册中心用户名,如果注册中心不需要验证可不填 | |
password | 登录注册中心密码,如果注册中心不需要验证可不填 | |
transport | registry.transporter | 网络传输方式,可选mina,netty |
timeout | registry.timeout | 注册中心请求超时时间(毫秒) |
session | registry.session | 注册中心会话超时时间(毫秒),用于检测提供者非正常断线后的脏数据,比如用心跳检测的实现,此时间就是心跳间隔,不同注册中心实现不一样。 |
file | registry.file | 使用文件缓存注册中心地址列表及服务提供者列表,应用重启时将基于此文件恢复,注意:两个注册中心不能使用同一文件存储 |
wait | registry.wait | 停止时等待通知完成时间(毫秒) |
check | check | 注册中心不存在时,是否报错 |
register | register | 是否向此注册中心注册服务,如果设为false,将只订阅,不注册 |
subscribe | subscribe | 是否向此注册中心订阅服务,如果设为false,将只注册,不订阅 |
dynamic | dynamic | 服务是否动态注册,如果设为false,注册后将显示为disable状态,需人工启用,并且服务提供者停止时,也不会自动取消注册,需人工禁用。 |
group | group | 服务注册分组,跨组的服务不会相互影响,也无法相互调用,适用于环境隔离。 |
simplified | simplified | 注册到注册中心的URL是否采用精简模式的(与低版本兼容) |
extra-keys | extraKeys | 在simplified=true时,extraKeys允许你在默认参数外将额外的key放到URL中,格式:“interface,key1,key2”。 |
4、dubbo:monitor
监控中心配置。对应的配置类: org.apache.dubbo.config.MonitorConfig
属性 | 对应URL参数 | 描述 |
---|---|---|
protocol | protocol | 监控中心协议,如果为protocol=“registry”,表示从注册中心发现监控中心地址,否则直连监控中心。 |
address | 直连监控中心服务器地址,address=“10.20.130.230:12080” |
5、dubbo:module
模块信息配置。对应的配置类 org.apache.dubbo.config.ModuleConfig
属性 | 对应URL参数 | 描述 |
---|---|---|
name(必填) | module | 当前模块名称,用于注册中心计算模块间依赖关系 |
version | module.version | 当前模块的版本 |
owner | owner | 模块负责人,用于服务治理,请填写负责人公司邮箱前缀 |
organization | organization | 组织名称(BU或部门),用于注册中心区分服务来源,此配置项建议不要使用autoconfig,直接写死在配置中,比如china,intl,itu,crm,asc,dw,aliexpress等 |
6、dubbo:service
服务提供者暴露服务配置。对应的配置类:org.apache.dubbo.config.ServiceConfig
属性 | 对应URL参数 | 描述 |
---|---|---|
interface(必填) | 服务接口名 | |
ref(必填) | 服务对象实现引用 | |
version | version | 服务版本,建议使用两位数字版本,如:1.0,通常在接口不兼容时版本号才需要升级 |
group | group | 服务分组,当一个接口有多个实现,可以用分组区分 |
path |
| 服务路径 (注意:1.0不支持自定义路径,总是使用接口名,如果有1.0调2.0,配置服务路径可能不兼容) |
delay | delay | 延迟注册服务时间(毫秒) ,设为-1时,表示延迟到Spring容器初始化完成时暴露服务 |
timeout | timeout | 远程服务调用超时时间(毫秒) |
retries | retries | 远程服务调用重试次数,不包括第一次调用,不需要重试请设为0 |
connections | connections | 对每个提供者的最大连接数,rmi、http、hessian等短连接协议表示限制连接数,dubbo等长连接协表示建立的长连接个数 |
loadbalance | loadbalance | 负载均衡策略,可选值:random,roundrobin,leastactive,分别表示:随机,轮询,最少活跃调用 |
async | async | 是否缺省异步执行,不可靠异步,只是忽略返回值,不阻塞执行线程 |
local | local | 设为true,表示使用缺省代理类名,即:接口名 + Local后缀,已废弃,请使用stub |
stub | stub | 设为true,表示使用缺省代理类名,即:接口名 + Stub后缀,服务接口客户端本地代理类名,用于在客户端执行本地逻辑,如本地缓存等,该本地代理类的构造函数必须允许传入远程代理对象,构造函数如:public XxxServiceStub(XxxService xxxService) |
mock | mock | 设为true,表示使用缺省Mock类名,即:接口名 + Mock后缀,服务接口调用失败Mock实现类,该Mock类必须有一个无参构造函数,与Local的区别在于,Local总是被执行,而Mock只在出现非业务异常(比如超时,网络异常等)时执行,Local在远程调用之前执行,Mock在远程调用后执行。 |
token | token | 令牌验证,为空表示不开启,如果为true,表示随机生成动态令牌,否则使用静态令牌,令牌的作用是防止消费者绕过注册中心直接访问,保证注册中心的授权功能有效,如果使用点对点调用,需关闭令牌功能 |
registry | 向指定注册中心注册,在多个注册中心时使用,值为dubbo:registry的id属性,多个注册中心ID用逗号分隔,如果不想将该服务注册到任何registry,可将值设为N/A | |
provider | 指定provider,值为dubbo:provider的id属性 | |
deprecated | deprecated | 服务是否过时,如果设为true,消费方引用时将打印服务过时警告error日志 |
dynamic | dynamic | 服务是否动态注册,如果设为false,注册后将显示后disable状态,需人工启用,并且服务提供者停止时,也不会自动取消册,需人工禁用。 |
accesslog | accesslog | 设为true,将向logger中输出访问日志,也可填写访问日志文件路径,直接把访问日志输出到指定文件 |
owner | owner | 服务负责人,用于服务治理,请填写负责人公司邮箱前缀 |
document | document | 服务文档URL |
weight | weight | 服务权重 |
executes | executes | 服务提供者每服务每方法最大可并行执行请求数 |
proxy | proxy | 生成动态代理方式,可选:jdk/javassist |
cluster | cluster | 集群方式,可选:failover/failfast/failsafe/failback/forking |
filter | service.filter | 服务提供方远程调用过程拦截器名称,多个名称用逗号分隔 |
listener | exporter.listener | 服务提供方导出服务监听器名称,多个名称用逗号分隔 |
protocol | 使用指定的协议暴露服务,在多协议时使用,值为dubbo:protocol的id属性,多个协议ID用逗号分隔 | |
layer | layer | 服务提供者所在的分层。如:biz、dao、intl:web、china:acton。 |
register | register | 该协议的服务是否注册到注册中心 |
7、dubbo:reference
服务消费者引用服务配置。对应的配置类: org.apache.dubbo.config.ReferenceConfig
属性 | 对应URL参数 | 描述 |
---|---|---|
id(必填) | 服务引用BeanId | |
interface(必填) | 服务接口名 | |
version | version | 服务版本,与服务提供者的版本一致 |
group | group | 服务分组,当一个接口有多个实现,可以用分组区分,必需和服务提供方一致 |
timeout | timeout | 服务方法调用超时时间(毫秒) |
retries | retries | 远程服务调用重试次数,不包括第一次调用,不需要重试请设为0 |
connections | connections | 对每个提供者的最大连接数,rmi、http、hessian等短连接协议表示限制连接数,dubbo等长连接协表示建立的长连接个数 |
loadbalance | loadbalance | 负载均衡策略,可选值:random,roundrobin,leastactive,分别表示:随机,轮询,最少活跃调用 |
async | async | 是否异步执行,不可靠异步,只是忽略返回值,不阻塞执行线程 |
generic | generic | 是否缺省泛化接口,如果为泛化接口,将返回GenericService |
check | check | 启动时检查提供者是否存在,true报错,false忽略 |
url | url | 点对点直连服务提供者地址,将绕过注册中心 |
stub | stub | 服务接口客户端本地代理类名,用于在客户端执行本地逻辑,如本地缓存等,该本地代理类的构造函数必须允许传入远程代理对象,构造函数如:public XxxServiceLocal(XxxService xxxService) |
mock | mock | 服务接口调用失败Mock实现类名,该Mock类必须有一个无参构造函数,与Local的区别在于,Local总是被执行,而Mock只在出现非业务异常(比如超时,网络异常等)时执行,Local在远程调用之前执行,Mock在远程调用后执行。 |
cache | cache | 以调用参数为key,缓存返回结果,可选:lru, threadlocal, jcache等 |
validation | validation | 是否启用JSR303标准注解验证,如果启用,将对方法参数上的注解进行校验 |
proxy | proxy | 选择动态代理实现策略,可选:javassist, jdk |
client | client | 客户端传输类型设置,如Dubbo协议的netty或mina。 |
registry | 从指定注册中心注册获取服务列表,在多个注册中心时使用,值为dubbo:registry的id属性,多个注册中心ID用逗号分隔 | |
owner | owner | 调用服务负责人,用于服务治理,请填写负责人公司邮箱前缀 |
actives | actives | 每服务消费者每服务每方法最大并发调用数 |
cluster | cluster | 集群方式,可选:failover/failfast/failsafe/failback/forking |
filter | reference.filter | 服务消费方远程调用过程拦截器名称,多个名称用逗号分隔 |
listener | invoker.listener | 服务消费方引用服务监听器名称,多个名称用逗号分隔 |
layer | layer | 服务调用者所在的分层。如:biz、dao、intl:web、china:acton。 |
init | init | 是否在afterPropertiesSet()时饥饿初始化引用,否则等到有人注入或引用该实例时再初始化。 |
protocol | protocol | 只调用指定协议的服务提供方,其它协议忽略。 |
8、dubbo:provider
服务提供者缺省值配置。对应的配置类: org.apache.dubbo.config.ProviderConfig
。同时该标签为 <dubbo:service>
和 <dubbo:protocol>
标签的缺省值设置。
属性 | 对应URL参数 | 描述 |
---|---|---|
id | 协议BeanId,可以在<dubbo:service proivder="">中引用此ID | |
protocol | 协议名称 | |
host | 服务主机名,多网卡选择或指定VIP及域名时使用,为空则自动查找本机IP,建议不要配置,让Dubbo自动获取本机IP | |
threads | threads | 服务线程池大小(固定大小) |
payload | payload | 请求及响应数据包大小限制,单位:字节 |
path |
| 提供者上下文路径,为服务path的前缀 |
server | server | 协议的服务器端实现类型,比如:dubbo协议的mina,netty等,http协议的jetty,servlet等 |
client | client | 协议的客户端实现类型,比如:dubbo协议的mina,netty等 |
codec | codec | 协议编码方式 |
serialization | serialization | 协议序列化方式,当协议支持多种序列化方式时使用,比如:dubbo协议的dubbo,hessian2,java,compactedjava,以及http协议的json,xml等 |
default | 是否为缺省协议,用于多协议 | |
filter | service.filter | 服务提供方远程调用过程拦截器名称,多个名称用逗号分隔 |
listener | exporter.listener | 服务提供方导出服务监听器名称,多个名称用逗号分隔 |
threadpool | threadpool | 线程池类型,可选:fixed/cached/limit(2.5.3以上)/eager(2.6.x以上) |
accepts | accepts | 服务提供者最大可接受连接数 |
version | version | 服务版本,建议使用两位数字版本,如:1.0,通常在接口不兼容时版本号才需要升级 |
group | group | 服务分组,当一个接口有多个实现,可以用分组区分 |
delay | delay | 延迟注册服务时间(毫秒)- ,设为-1时,表示延迟到Spring容器初始化完成时暴露服务 |
timeout | default.timeout | 远程服务调用超时时间(毫秒) |
retries | default.retries | 远程服务调用重试次数,不包括第一次调用,不需要重试请设为0 |
connections | default.connections | 对每个提供者的最大连接数,rmi、http、hessian等短连接协议表示限制连接数,dubbo等长连接协表示建立的长连接个数 |
loadbalance | default.loadbalance | 负载均衡策略,可选值:random,roundrobin,leastactive,分别表示:随机,轮询,最少活跃调用 |
async | default.async | 是否缺省异步执行,不可靠异步,只是忽略返回值,不阻塞执行线程 |
stub | stub | 设为true,表示使用缺省代理类名,即:接口名 + Local后缀。 |
mock | mock | 设为true,表示使用缺省Mock类名,即:接口名 + Mock后缀。 |
token | token | 令牌验证,为空表示不开启,如果为true,表示随机生成动态令牌 |
registry | registry | 向指定注册中心注册,在多个注册中心时使用,值为dubbo:registry的id属性,多个注册中心ID用逗号分隔,如果不想将该服务注册到任何registry,可将值设为N/A |
dynamic | dynamic | 服务是否动态注册,如果设为false,注册后将显示后disable状态,需人工启用,并且服务提供者停止时,也不会自动取消册,需人工禁用。 |
accesslog | accesslog | 设为true,将向logger中输出访问日志,也可填写访问日志文件路径,直接把访问日志输出到指定文件 |
owner | owner | 服务负责人,用于服务治理,请填写负责人公司邮箱前缀 |
document | document | 服务文档URL |
weight | weight | 服务权重 |
executes | executes | 服务提供者每服务每方法最大可并行执行请求数 |
actives | default.actives | 每服务消费者每服务每方法最大并发调用数 |
proxy | proxy | 生成动态代理方式,可选:jdk/javassist |
cluster | default.cluster | 集群方式,可选:failover/failfast/failsafe/failback/forking |
deprecated | deprecated | 服务是否过时,如果设为true,消费方引用时将打印服务过时警告error日志 |
queues | queues | 线程池队列大小,当线程池满时,排队等待执行的队列大小,建议不要设置,当线程池满时应立即失败,重试其它服务提供机器,而不是排队,除非有特殊需求。 |
charset | charset | 序列化编码 |
buffer | buffer | 网络读写缓冲区大小 |
iothreads | iothreads | IO线程池,接收网络读写中断,以及序列化和反序列化,不处理业务,业务线程池参见threads配置,此线程池和CPU相关,不建议配置。 |
telnet | telnet | 所支持的telnet命令,多个命令用逗号分隔 |
dubbo:service | contextpath | 服务治理 |
layer | layer | 服务提供者所在的分层。如:biz、dao、intl:web、china:acton |
9、dubbo:consumer
服务消费者缺省值配置。配置类: org.apache.dubbo.config.ConsumerConfig
。同时该标签为 <dubbo:reference>
标签的缺省值设置。
属性 | 对应URL参数 | 描述 |
---|---|---|
timeout | default.timeout | 远程服务调用超时时间(毫秒) |
retries | default.retries | 远程服务调用重试次数,不包括第一次调用,不需要重试请设为0,仅在cluster为failback/failover时有效 |
loadbalance | default.loadbalance | 负载均衡策略,可选值:random,roundrobin,leastactive,分别表示:随机,轮询,最少活跃调用 |
async | default.async | 是否缺省异步执行,不可靠异步,只是忽略返回值,不阻塞执行线程 |
connections | default.connections | 每个服务对每个提供者的最大连接数,rmi、http、hessian等短连接协议支持此配置,dubbo协议长连接不支持此配置 |
generic | generic | 是否缺省泛化接口,如果为泛化接口,将返回GenericService |
check | check | 启动时检查提供者是否存在,true报错,false忽略 |
proxy | proxy | 生成动态代理方式,可选:jdk/javassist |
owner | owner | 调用服务负责人,用于服务治理,请填写负责人公司邮箱前缀 |
actives | default.actives | 每服务消费者每服务每方法最大并发调用数 |
cluster | default.cluster | 集群方式,可选:failover/failfast/failsafe/failback/forking |
filter | reference.filter | 服务消费方远程调用过程拦截器名称,多个名称用逗号分隔 |
listener | invoker.listener | 服务消费方引用服务监听器名称,多个名称用逗号分隔 |
registry | 向指定注册中心注册,在多个注册中心时使用,值为dubbo:registry的id属性,多个注册中心ID用逗号分隔,如果不想将该服务注册到任何registry,可将值设为N/A | |
layer | layer | 服务调用者所在的分层。如:biz、dao、intl:web、china:acton。 |
init | init | 是否在afterPropertiesSet()时饥饿初始化引用,否则等到有人注入或引用该实例时再初始化。 |
cache | cache | 以调用参数为key,缓存返回结果,可选:lru, threadlocal, jcache等 |
validation | validation | 是否启用JSR303标准注解验证,如果启用,将对方法参数上的注解进行校验 |
10、dubbo:config-center
配置中心。对应的配置类:org.apache.dubbo.config.ConfigCenterConfig
属性 | 对应URL参数 | 描述 |
---|---|---|
protocol | config.protocol | 使用哪个配置中心:apollo、zookeeper、nacos等。 以zookeeper为例 1. 指定protocol,则address可以简化为127.0.0.1:2181 ; 2. 不指定protocol,则address取值为zookeeper://127.0.0.1:2181 |
address(必填) | config.address | 配置中心地址。 取值参见protocol说明 |
highest-priority | config.highestPriority | 来自配置中心的配置项具有最高优先级,即会覆盖本地配置项。 |
namespace | config.namespace | 通常用于多租户隔离,实际含义视具体配置中心而不同。 如: zookeeper - 环境隔离,默认值dubbo ; apollo - 区分不同领域的配置集合,默认使用dubbo 和application |
cluster | config.cluster | 含义视所选定的配置中心而不同。 如Apollo中用来区分不同的配置集群 |
group | config.group | 含义视所选定的配置中心而不同。 nacos - 隔离不同配置集 zookeeper - 隔离不同配置集 |
check | config.check | 当配置中心连接失败时,是否终止应用启动。 |
config-file | config.configFile | 全局级配置文件所映射到的key zookeeper - 默认路径/dubbo/config/dubbo/dubbo.properties apollo - dubbo namespace中的dubbo.properties键 |
timeout | config.timeout | 获取配置的超时时间 |
username | 如果配置中心需要做校验,用户名 Apollo暂未启用 | |
password | 如果配置中心需要做校验,密码 Apollo暂未启用 | |
parameters | 扩展参数,用来支持不同配置中心的定制化配置参数 | |
include-spring-env | 使用Spring框架时支持,为true时,会自动从Spring Environment中读取配置。 默认依次读取 key为dubbo.properties的配置 key为dubbo.properties的PropertySource |
11、dubbo:method
方法级配置。对应的配置类: org.apache.dubbo.config.MethodConfig
。同时该标签为 <dubbo:service>
或 <dubbo:reference>
的子标签,用于控制到方法级。
属性 | 对应URL参数 | 描述 |
---|---|---|
name(必填) | 方法名 | |
timeout | .timeout | 方法调用超时时间(毫秒) |
retries | .retries | 远程服务调用重试次数,不包括第一次调用,不需要重试请设为0 |
loadbalance | .loadbalance | 负载均衡策略,可选值:random,roundrobin,leastactive,分别表示:随机,轮询,最少活跃调用 |
async | .async | 是否异步执行,不可靠异步,只是忽略返回值,不阻塞执行线程 |
sent | .sent | 异步调用时,标记sent=true时,表示网络已发出数据 |
actives | .actives | 每服务消费者最大并发调用限制 |
executes | .executes | 每服务每方法最大使用线程数限制- -,此属性只在dubbo:method作为dubbo:service子标签时有效 |
deprecated | .deprecated | 服务方法是否过时,此属性只在dubbo:method作为dubbo:service子标签时有效 |
sticky | .sticky | 设置true 该接口上的所有方法使用同一个provider.如果需要更复杂的规则,请使用用路由 |
return | .return | 方法调用是否需要返回值,async设置为true时才生效,如果设置为true,则返回future,或回调onreturn等方法,如果设置为false,则请求发送成功后直接返回Null |
oninvoke | attribute属性,不在URL中体现 | 方法执行前拦截 |
onreturn | attribute属性,不在URL中体现 | 方法执行返回后拦截 |
onthrow | attribute属性,不在URL中体现 | 方法执行有异常拦截 |
cache | .cache | 以调用参数为key,缓存返回结果,可选:lru, threadlocal, jcache等 |
validation | .validation | 是否启用JSR303标准注解验证,如果启用,将对方法参数上的注解进行校验 |
12、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>
属性 | 对应URL参数 | 描述 |
---|---|---|
index(必填) | 参数索引 | |
type(可以替代index) | 通过参数类型查找参数的index | |
callback | .retries | 参数是否为callback接口,如果为callback,服务提供方将生成反向代理,可以从服务提供方反向调用消费方,通常用于事件推送. |
13、dubbo:parameter
选项参数配置。对应的配置类:java.util.Map
。同时该标签为<dubbo:protocol>
或<dubbo:service>
或<dubbo:provider>
或<dubbo:reference>
或<dubbo:consumer>
的子标签,用于配置自定义参数,该配置项将作为扩展点设置自定义参数使用。
属性 | 对应URL参数 | 描述 |
---|---|---|
key(必填) | key | 路由参数键 |
value(必填) | value | 路由参数值 |
如:
<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” />
二、注解配置
除了xml文件配置以外,另外比较重要的就是注解配置,注解通常用于反射
2.1、Service注解
该注解用于暴露服务
2.2、Reference注解
该注解用于引用服务
三、配置加载
讲了相关配置,最后熟悉下配置加载的过程。
有了配置,那么配置就得被应用获取到,如何加载的呢?
1、配置来源
有四种配置来源,优先级依此降低
① JVM参数 ② 外部配置(知道即可,如zk的外部配置中心)③ xml等采集到ServiceConfig、ReferenceConfig中的配置 ④配置文件dubbo.properties
2、对于③,具体几种配置如下
2.1、xml配置
<!-- dubbo-provier.xml -->
<dubbo:application name="demo-provider"/>
<dubbo:config-center address="zookeeper://127.0.0.1:2181"/>
<dubbo:registry address="zookeeper://127.0.0.1:2181" simplified="true"/>
<dubbo:metadata-report address="redis://127.0.0.1:6379"/>
<dubbo:protocol name="dubbo" port="20880"/>
<bean id="demoService" class="org.apache.dubbo.samples.basic.impl.DemoServiceImpl"/>
<dubbo:service interface="org.apache.dubbo.samples.basic.api.DemoService" ref="demoService"/>
2.2、注解
// AnnotationService服务实现
@Service
public class AnnotationServiceImpl implements AnnotationService {
@Override
public String sayHello(String name) {
System.out.println("async provider received: " + name);
return "annotation: hello, " + name;
}
}
额外加上dubbo相关配置
## dubbo.properties
dubbo.application.name=annotation-provider
dubbo.registry.address=zookeeper://127.0.0.1:2181
dubbo.protocol.name=dubbo
dubbo.protocol.port=20880
2.3、springboot
## application.properties
# Spring boot application
spring.application.name=dubbo-externalized-configuration-provider-sample
# Base packages to scan Dubbo Component: @com.alibaba.dubbo.config.annotation.Service
dubbo.scan.base-packages=com.alibaba.boot.dubbo.demo.provider.service
# Dubbo Application
## The default value of dubbo.application.name is ${spring.application.name}
## dubbo.application.name=${spring.application.name}
# Dubbo Protocol
dubbo.protocol.name=dubbo
dubbo.protocol.port=12345
## Dubbo Registry
dubbo.registry.address=N/A
## DemoService version
demo.service.version=1.0.0
2.4、API
public static void main(String[] args) throws IOException {
ServiceConfig<GreetingsService> service = new ServiceConfig<>();
service.setApplication(new ApplicationConfig("first-dubbo-provider"));
service.setRegistry(new RegistryConfig("multicast://224.5.6.7:1234"));
service.setInterface(GreetingsService.class);
service.setRef(new GreetingsServiceImpl());
service.export();
System.out.println("first-dubbo-provider is running.");
System.in.read();
}