精通Dubbo——Dubbo配置文件详解

依赖的jar

理论上Dubbo可以只依赖JDK，不依赖于任何三方库运行，只需配置使用JDK相关实现策略。

缺省依赖（系统默认）

通过mvn dependency:tree > dep.log命令（Eclipse或Linux命令行）分析，Dubbo缺省依赖以下三方库：

[INFO] +- com.alibaba:dubbo:jar:2.1.2:compile
[INFO] |  +- log4j:log4j:jar:1.2.16:compile
[INFO] |  +- org.javassist:javassist:jar:3.15.0-GA:compile
[INFO] |  +- org.springframework:spring:jar:2.5.6.SEC03:compile
[INFO] |  +- commons-logging:commons-logging:jar:1.1.1:compile
[INFO] |  \- org.jboss.netty:netty:jar:3.2.5.Final:compile

这里所有依赖都是换照Dubbo缺省配置选的，这些缺省值是基于稳定性和性能考虑的。

log4j.jar和commons-logging.jar日志输出包：

可以直接去掉，dubbo本身的日志会自动切换为JDK的java.util.logging输出。但如果其它三方库比如spring.jar间接依赖commons-logging，则不能去掉。

javassist.jar 字节码生成：

如果或，以及，则不需要。

spring.jar 配置解析：

如果用ServiceConfig和ReferenceConfig的API调用，则不需要。

netty.jar 网络传输：

如果或，则换成mina.jar或grizzly.jar。如果，则不需要。

Dubbo配置说明

xml配置

所有配置项分为三大类，如下：

服务发现：表示该配置项用于服务的注册与发现，目的是让消费方找到提供方。

服务治理：表示该配置项用于治理服务间的关系，或为开发测试提供便利条件。

性能调优：表示该配置项用于调优性能，不同的选项对性能会产生影响。

所有配置最终都将转换为URL表示，并由服务提供方生成，经注册中心传递给消费方，各属性对应URL的参数，URL格式如下：

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

服务提供方

<dubbo:service />

服务发现类

1、interface

dubbo服务暴露的接口全路径，例如：

<dubbo:service interface="com.dubbo.service.UserService" />

2、ref

dubbo服务暴露的接口的实现类例如：

<bean id="userService" class="com.dubbo.service.impl.UserServiceImpl" />
<dubbo:service interface="com.dubbo.service.UserService" ref="userServie" />

3、version

服务版本号，服务提供方和服务消费方的version务必保持一致

4、group

服务分组，当一个接口有多个实现，可以用分组区分配置类：com.alibaba.dubbo.config.ServiceConfig

服务治理类

1、stub

设为true，表示使用缺省代理类名，即：接口名 + Local后缀，服务接口客户端本地代理类名，用于在客户端执行本地逻辑，如本地缓存等，该本地代理类的构造函数必须允许传入远程代理对象，构造函数如：public XxxServiceLocal(XxxService xxxService)

2、mock

设为true，表示使用缺省Mock类名，即：接口名 + Mock后缀，服务接口调用失败Mock实现类，该Mock类必须有一个无参构造函数，与Local的区别在于，Local总是被执行，而Mock只在出现非业务异常(比如超时，网络异常等)时执行，Local在远程调用之前执行，Mock在远程调用后执行。

3、token

令牌验证，为空表示不开启，如果为true，表示随机生成动态令牌，否则使用静态令牌，令牌的作用是防止消费者绕过注册中心直接访问，保证注册中心的授权功能有效，如果使用点对点调用，需关闭令牌功能

4、registry

向指定注册中心注册，在多个注册中心时使用，值为

<dubbo:registry>

的id属性，多个注册中心ID用逗号分隔，如果不想将该服务注册到任何registry，可将值设为N/A

5、provider

指定provider，值为

<dubbo:provider>

的id属性

6、deprecate

服务是否过时，如果设为true，消费方引用时将打印服务过时警告error日志

7、dynamic

服务是否动态注册，如果设为false，注册后将显示后disable状态，需人工启用，并且服务提供者停止时，也不会自动取消册，需人工禁用。

8、accesslog

设为true，将向logger中输出访问日志，也可填写访问日志文件路径，直接把访问日志输出到指定文件

9、owner

服务负责人，用于服务治理，请填写公司邮箱前缀

10、protocol

使用指定的协议暴露服务，在多协议时使用，值为

<dubbo:protocol>

的id属性，多个协议ID用逗号分隔，可以有dubbo/hessian/rmi/thrift/redis等，后面会详细介绍每种协议

11、register

该协议的服务是否注册到注册中心

服务调优类

1、delay

延迟注册服务时间(毫秒) ，设为-1时，表示延迟到Spring容器初始化完成时暴露服务

2、timeout

远程调用服务超时时间，如果客户端服务端都配置了以客户端为准，客户端没配以服务端为准，单位毫秒默认1000

3、retries

远程服务调用重试次数，不包括第一次调用，不需要重试请设为0，默认2

4、connections

对每个提供者的最大连接数，rmi、http、hessian等短连接协议表示限制连接数，dubbo等长连接协表示建立的长连接个数，默认100

5、loadbalance

负载均衡策略，random,roundrobin,leastactive，分别表示：随机，轮循，最少活跃调用

6、async

是否缺省异步执行，不可靠异步，只是忽略返回值，不阻塞执行线程

7、weigth

服务权重，结合负载均衡策略使用

8、executes

服务提供者每服务每方法最大可并行执行请求数

9、actives

每服务消费者每服务每方法最大并发调用数

10、proxy

生成动态代理方式，可选：jdk/javassist

11、cluster

集群方式，可选：

【failover】

失败自动切换，当出现失败，重试其他服务器（缺省），通常用于读操作，但重试会带来更长的延时，可通过retries=“2”来设置重试次数（不含第一次）

<dubbo:service retries="2">

或者

<dubbo:reference retries="2">

或者

<dubbo:reference>
<dubbo:method name="findFoo" retries=2>
<dubbo:reference/>

【failfast】

快速失效，只发起一次调用，失败立即报错。通常用于非幂等性写操作，比如说新增记录

<dubbo:service cluster="failfast">

或者

<dubbo:reference cluster="failfast"

【failsafe】

失败安全，出现异常时，直接忽略，通常用于写入审计日志等操作

<dubbo:service cluster="failsafe">

或者

<dubbo:reference cluster="failsafe">

【failback】

失败自动恢复，后台记录失败请求，定时重发，通常用于消息通知操作

<dubbo:service cluster="failback">

或者

<dubbo:reference cluster="failback">

【forking】

并行调用多个服务器，只要一个成功即返回。通常用于实时性要求较高的读操作，但需要浪费更多的服务器资源。可通过forks=“2”来设置最大并行数。

<dubbo:service cluster="forking">

或者

<dubbo:reference cluster="forking">

12、filter

服务提供方远程调用过程拦截器名称，多个名称用逗号分隔，Spring拦截器可以拦截Web接口，无法拦截dubbo接口，但是dubbo提供了Filter扩展

13、listener

服务提供方导出服务监听器名称，多个名称用逗号分隔

服务消费方

<dubbo:reference />

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

服务发现类

1、id

服务引用Bean的id，例如

<dubbo:reference id=“xxxService” interface=“com.xxx.XxxService” /> <!-- 增加引用远程服务配置 -->
<bean id=“xxxAction” class=“com.xxx.XxxAction”> <!-- 和本地服务一样使用远程服务 -->
<property name=“xxxService” ref=“xxxService” />
</bean>

2、interface

服务接口全路径，例子同上

3、version

版本号，与服务提供者保持一致

4、group

服务分组，当一个接口有多个实现，可以用分组区分，必需和服务提供方一致

5、registry

从指定注册中心注册获取服务列表，在多个注册中心时使用，值为

<dubbo:registry>

的id属性，多个注册中心ID用逗号分隔

服务治理类

1、generic

是否缺省泛化接口，如果为泛化接口，将返回GenericService

2、check

启动时检查提供者是否存在，true报错，false忽略

3、url

点对点直连服务提供者地址，将绕过注册中心

4、stub

服务接口客户端本地代理类名，用于在客户端执行本地逻辑，如本地缓存等，该本地代理类的构造函数必须允许传入远程代理对象，构造函数如：public XxxServiceLocal(XxxService xxxService)

5、mock

服务接口调用失败Mock实现类名，该Mock类必须有一个无参构造函数，与Local的区别在于，Local总是被执行，而Mock只在出现非业务异常(比如超时，网络异常等)时执行，Local在远程调用之前执行，Mock在远程调用后执行

6、cache

以调用参数为key，缓存返回结果，可选：lru, threadlocal, jcache等

7、validation

是否启用JSR303标准注解验证，如果启用，将对方法参数上的注解进行校验

8、layer

layer服务调用者所在的分层。如：biz、dao、intl:web、china:acton

9、protocol

只调用指定协议的服务提供方，其它协议忽略

服务调优类

1、timeout

服务调用超时时间，如果客户端配置以客户端为准

2、retries

远程服务调用重试次数，不包括第一次调用，不需要重试请设为0

3、connections

对每个提供者的最大连接数，rmi、http、hessian等短连接协议表示限制连接数，dubbo等长连接协表示建立的长连接个数

4、loadbalance

负载均衡策略，可选值：random,roundrobin,leastactive，分别表示：随机，轮循，最少活跃调用

5、async

是否异步执行，不可靠异步，只是忽略返回值，不阻塞执行线程

6、proxy

选择动态代理实现策略，可选：javassist, jdk

7、client

客户端传输类型设置，如Dubbo协议的netty或mina

8、actives

每服务消费者每服务每方法最大并发调用数

9、cluster

集群方式，可选：

【failover】

失败自动切换，当出现失败，重试其他服务器（缺省），通常用于读操作，但重试会带来更长的延时，可通过retries=“2”来设置重试次数（不含第一次）

<dubbo:service retries="2">

或者

<dubbo:reference retries="2">

或者

<dubbo:reference>
<dubbo:method name="findFoo" retries=2>
<dubbo:reference/>

【failfast】

快速失效，只发起一次调用，失败立即报错。通常用于非幂等性写操作，比如说新增记录

<dubbo:service cluster="failfast">

或者

<dubbo:reference cluster="failfast"

【failsafe】

失败安全，出现异常时，直接忽略，通常用于写入审计日志等操作

<dubbo:service cluster="failsafe">

或者

<dubbo:reference cluster="failsafe">
【failback】

失败自动恢复，后台记录失败请求，定时重发，通常用于消息通知操作

<dubbo:service cluster="failback">

或者

<dubbo:reference cluster="failback">

【forking】

并行调用多个服务器，只要一个成功即返回。通常用于实时性要求较高的读操作，但需要浪费更多的服务器资源。可通过forks=“2”来设置最大并行数。

<dubbo:service cluster="forking">

或者

<dubbo:reference cluster="forking">

10、filter

服务消费方远程调用过程拦截器名称，多个名称用逗号分隔

11、listener

服务消费方引用服务监听器名称，多个名称用逗号分隔

12、init

是否在afterPropertiesSet()时饥饿初始化引用，否则等到有人注入或引用该实例时再初始化。

服务提供方

<dubbo:protocol/>

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

说明：如果需要支持多协议，可以声明多个

<dubbo:protocol>

标签，并在

<dubbo:service>

中通过protocol属性指定使用的协议。

服务发现类

1、id

协议BeanId，可以在

<dubbo:service protocol="">

中引用此ID，如果ID不填，缺省和name属性值一样，重复则在name后加序号

2、port

dubbo协议缺省端口为20880，rmi协议缺省端口为1099，http和hessian协议缺省端口为80 如果配置为-1 或者 没有配置port，则会分配一个没有被占用的端口。Dubbo 2.4.0+，分配的端口在协议缺省端口的基础上增长，确保端口段可控；

3、host

默认查找本机IP，服务主机名，多网卡选择或指定VIP及域名时使用，为空则自动查找本机IP，-建议不要配置，让Dubbo自动获取本机IP

4、path

提供者上下文路径，为服务path的前缀

服务治理类

1、accesslog

设为true，将向logger中输出访问日志，也可填写访问日志文件路径，直接把访问日志输出到指定文件

2、telnet

所支持的telnet命令，多个命令用逗号分隔

3、register

该协议的服务是否注册到注册中心服务调优类

1、name

协议名称,支持常见的传输协议：RMI、Dubbo、Hessain、WebService、Http等

2、threadpool

默认fixed,线程池类型，可选：fixed/cached

3、threads

服务线程池大小(固定大小)

4、iothreads

io线程池大小(固定大小)

5、accepts

服务提供方最大可接受连接数

6、payload

请求及响应数据包大小限制，单位：字节，默认值88388608(=8M)

7、codec

协议编码方式

8、serialization

dubbo协议缺省为hessian2，rmi协议缺省为java，http协议缺省为json；协议序列化方式，当协议支持多种序列化方式时使用，比如：dubbo协议的dubbo,hessian2,java,compactedjava，以及http协议的json等

9、transporter

协议的服务端和客户端实现类型，比如：dubbo协议的mina,netty等，可以分拆为server和client配置

10、server

协议的服务器端实现类型，比如：dubbo协议的mina,netty等，http协议的jetty,servlet等

11、client

协议的客户端实现类型，比如：dubbo协议的mina,netty等

1**2、dispather**

协议的消息派发方式，用于指定线程模型，比如：dubbo协议的all, direct, message, execution, connection等

13、queues

线程池队列大小，当线程池满时，排队等待执行的队列大小，建议不要设置，当线程程池时应立即失败，重试其它服务提供机器，而不是排队，除非有特殊需求。

14、charset

序列化编码

15、buffer

网络缓冲区大小

16、heartbeat

心跳间隔，对于长连接，当物理层断开时，比如拔网线，TCP的FIN消息来不及发送，对方收不到断开事件，此时需要心跳来帮助检查连接是否已断开

注册中心配置

<dubbo:registry/>

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

说明：如果有多个不同的注册中心，可以声明多个

<dubbo:registry>

标签，并在

<dubbo:service>

或

<dubbo:reference>

的registry属性指定使用的注册中心

服务发现类

1、id

注册中心引用BeanId，可以在

<dubbo:service registry="">

或

<dubbo:reference registry="">

中引用此ID 1.0.16以上版本

2、address

注册中心服务器地址，如果地址没有端口缺省为9090，同一集群内的多个地址用逗号分隔，如：ip:port,ip:port，不同集群的注册中心，请配置多个

3、protocol

注同中心地址协议，支持dubbo, http, local三种协议，分别表示，dubbo地址，http地址，本地注册中心

4、port

注册中心缺省端口，当address没有带端口时使用此端口做为缺省值

服务治理类

1、username

登录注册中心用户名，如果注册中心不需要验证可不填

2、password

登录注册中心密码，如果注册中心不需要验证可不填

3、file

使用文件缓存注册中心地址列表及服务提供者列表，应用重启时将基于此文件恢复，注意：两个注册中心不能使用同一文件存储

4、check

注册中心不存在时，是否报错

5、 register

是否向此注册中心注册服务，如果设为false，将只订阅，不注册

6、subscribe

是否向此注册中心订阅服务，如果设为false，将只注册，不订阅

7、dynamic

服务是否动态注册，如果设为false，注册后将显示后disable状态，需人工启用，并且服务提供者停止时，也不会自动取消册，需人工禁用。

服务调优类

1、transport

网络传输方式，可选mina,netty

2、timeout

注册中心请求超时时间(毫秒)

3、session

注册中心会话超时时间(毫秒)，用于检测提供者非正常断线后的脏数据，比如用心跳检测的实现，此时间就是心跳间隔，不同注册中心实现不一样

4、wait

停止时等待通知完成时间(毫秒)

监控中心配置

<dubbo:monitor/>

服务治理类

1、protocol

监控中心协议，如果为protocol=”registry”，表示从注册中心发现监控中心地址，否则直连监控中心

2、address

直连监控中心服务器地址，address=”10.20.130.230:12080”

服务提供者缺省值配置

<dubbo:provider/>

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

说明：该标签为

<dubbo:service>

和

<dubbo:protocol>

标签的缺省值设置。具体配置可以参考

<dubbo:service>

和

<dubbo:protocol>

配置

服务消费缺省值配置

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

说明：该标签为

<dubbo:reference>

标签的缺省值设置。具体配置可以参考

<dubbo:reference>

配置

方法级配置

<dubbo:method/>

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

说明：该标签为

<dubbo:service>

或

<dubbo:reference>

的子标签，用于控制到方法级，

服务发现类

1、name

方法名

服务治理类

1.deprecated

服务方法是否过时，此属性只在

<dubbo:method>

作为

<dubbo:service>

子标签时有效

2、sticky

该接口上的所有方法使用同一个provider.如果需要更复杂的规则，请使用用路由

3、cache

以调用参数为key，缓存返回结果，可选：lru, threadlocal, jcache等

4、validation

是否启用JSR303标准注解验证，如果启用，将对方法参数上的注解

服务调优类

1、timeout

方法调用超时时间(毫秒)

2、retries

缺省为

<dubbo:reference>

的retries，远程服务调用重试次数，不包括第一次调用，不需要重试请设为0

3、loadbalance

负载均衡策略，可选值：random,roundrobin,leastactive，分别表示：随机，轮循，最少活跃调用

4、async

是否异步执行，不可靠异步，只是忽略返回值，不阻塞执行线程

5、sent

异步调用时，标记sent=true时，表示网络已发出数据

6、actives

每服务消费者最大并发调用限制

7、executes

每服务每方法最大使用线程数限制- -，此属性只在

<dubbo:method>作为<dubbo:service>

子标签时有效

8、return

方法调用是否需要返回值,async设置为true时才生效，如果设置为true，则返回future，或回调onreturn等方法，如果设置为false，则请求发送成功后直接返回Null

9、oninvoke

方法执行前拦截

10、onreturn

方法执行返回后拦截

11、onthrow

方法执行有异常拦截

例如

<dubbo:reference interface="com.xxx.XxxService">
<dubbo:method name="findXxx" timeout="3000" retries="2" />
</dubbo:reference>

方法参数配置

<dubbo:argument/>

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

说明：该标签为

<dubbo:method>

的子标签，用于方法参数的特征描述，比如：

<dubbo:method name="findXxx" timeout="3000" retries="2">
<dubbo:argument index="0" callback="true" />
<dubbo:method>

1、index

方法名

2、type

通过参数类型查找参数的index

3、callback

参数是否为callback接口，如果为callback，服务提供方将生成反向代理，可以从服务提供方反向调用消费方，通常用于事件推送

选项参数配置

<dubbo:parameter/>

配置类：java.util.Map

说明：该标签为

<dubbo:protocol>或<dubbo:service>或<dubbo:provider>或<dubbo:reference>

或

<dubbo:consumer>

的子标签，用于配置自定义参数，该配置项将作为扩展点设置自定义参数使用。

1、key

路由参数键

2、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" />