Dubbo -- 系统学习 笔记 -- 配置参考手册

  • 配置参考手册
    • <dubbo:service/>
    • <dubbo:reference/>
    • <dubbo:protocol/>
    • <dubbo:registry/>
    • <dubbo:monitor/>
    • <dubbo:application/>
    • <dubbo:module/>
    • <dubbo:provider/>
    • <dubbo:consumer/>
    • <dubbo:method/>
    • <dubbo:argument/>
    • <dubbo:parameter/>

配置参考手册

　　这里以Xml配置为准，列举所有配置项，其它配置方式，请参见相应转换关系：属性配置，注解配置，API配置

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

所有配置项分为三大类，参见下表中的"作用"一列。

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

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

protocol://username:[email protected]:port/path?key=value&key=value

<dubbo:service/>

服务提供者暴露服务配置：
配置类：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 <path> string 可选 缺省为接口名 服务发现 服务路径 (注意：1.0不支持自定义路径，总是使用接口名，如果有1.0调2.0，配置服务路径可能不兼容) 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 int 可选 100 性能调优 对每个提供者的最大连接数，rmi、http、hessian等短连接协议表示限制连接数，dubbo等长连接协表示建立的长连接个数 2.0.0以上版本
<dubbo:service> loadbalance loadbalance string 可选 random 性能调优 负载均衡策略，可选值：random,roundrobin,leastactive，分别表示：随机，轮循，最少活跃调用 2.0.0以上版本
<dubbo:service> async async boolean 可选 false 性能调优 是否缺省异步执行，不可靠异步，只是忽略返回值，不阻塞执行线程 2.0.0以上版本
<dubbo:service> stub stub class/boolean 可选 false 服务治理 设为true，表示使用缺省代理类名，即：接口名 + 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/boolean 可选 false 服务治理 令牌验证，为空表示不开启，如果为true，表示随机生成动态令牌，否则使用静态令牌，令牌的作用是防止消费者绕过注册中心直接访问，保证注册中心的授权功能有效，如果使用点对点调用，需关闭令牌功能 2.0.0以上版本
<dubbo:service> registry   string 可选 缺省向所有registry注册 配置关联 向指定注册中心注册，在多个注册中心时使用，值为<dubbo:registry>的id属性，多个注册中心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 2.0.5以上版本
<dubbo:service> weight weight int 可选   性能调优 服务权重 2.0.5以上版本
<dubbo:service> executes executes int 可选 0 性能调优 服务提供者每服务每方法最大可并行执行请求数 2.0.5以上版本
<dubbo:service> actives actives int 可选 0 性能调优 每服务消费者每服务每方法最大并发调用数 2.0.5以上版本
<dubbo:service> proxy proxy string 可选 javassist 性能调优 生成动态代理方式，可选：jdk/javassist 2.0.5以上版本
<dubbo:service> cluster cluster string 可选 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 性能调优 服务提供方导出服务监听器名称，多个名称用逗号分隔  
<dubbo:service> protocol   string 可选   配置关联 使用指定的协议暴露服务，在多协议时使用，值为<dubbo:protocol>的id属性，多个协议ID用逗号分隔 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以上版本

<dubbo:reference/>

服务消费者引用服务配置：
配置类：com.alibaba.dubbo.config.ReferenceConfig

标签 属性 对应URL参数 类型 是否必填 缺省值 作用 描述 兼容性
<dubbo:reference> id   string 必填   配置关联 服务引用BeanId 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 可选 缺省使用<dubbo:consumer>的connections 性能调优 对每个提供者的最大连接数，rmi、http、hessian等短连接协议表示限制连接数，dubbo等长连接协表示建立的长连接个数 2.0.0以上版本
<dubbo:reference> loadbalance loadbalance string 可选 缺省使用<dubbo:consumer>的loadbalance 性能调优 负载均衡策略，可选值：random,roundrobin,leastactive，分别表示：随机，轮循，最少活跃调用 2.0.0以上版本
<dubbo:reference> async async boolean 可选 缺省使用<dubbo:consumer>的async 性能调优 是否异步执行，不可靠异步，只是忽略返回值，不阻塞执行线程 2.0.0以上版本
<dubbo:reference> generic generic boolean 可选 缺省使用<dubbo:consumer>的generic 服务治理 是否缺省泛化接口，如果为泛化接口，将返回GenericService 2.0.0以上版本
<dubbo:reference> check check boolean 可选 缺省使用<dubbo:consumer>的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在远程调用后执行。 Dubbo1.0.13及其以上版本支持
<dubbo:reference> cache cache string/boolean 可选   服务治理 以调用参数为key，缓存返回结果，可选：lru, threadlocal, jcache等 Dubbo2.1.0及其以上版本支持
<dubbo:reference> validation validation boolean 可选   服务治理 是否启用JSR303标准注解验证，如果启用，将对方法参数上的注解进行校验 Dubbo2.1.0及其以上版本支持
<dubbo:reference> proxy proxy boolean 可选 javassist 性能调优 选择动态代理实现策略，可选：javassist, jdk 2.0.2以上版本
<dubbo:reference> client client string 可选   性能调优 客户端传输类型设置，如Dubbo协议的netty或mina。 Dubbo2.0.0以上版本支持
<dubbo:reference> registry   string 可选 缺省将从所有注册中心获服务列表后合并结果 配置关联 从指定注册中心注册获取服务列表，在多个注册中心时使用，值为<dubbo:registry>的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以上版本

<dubbo:protocol/>

服务提供者协议配置：

配置类：com.alibaba.dubbo.config.ProtocolConfig
说明：如果需要支持多协议，可以声明多个<dubbo:protocol>标签，并在<dubbo:service>中通过protocol属性指定使用的协议。

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

<dubbo:registry/>

注册中心配置：

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

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

<dubbo:monitor/>

监控中心配置：

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

标签 属性 对应URL参数 类型 是否必填 缺省值 作用 描述 兼容性
<dubbo:monitor> protocol protocol string 可选 dubbo 服务治理 监控中心协议，如果为protocol="registry"，表示从注册中心发现监控中心地址，否则直连监控中心。 2.0.9以上版本
<dubbo:monitor> address <url> string 可选 N/A 服务治理 直连监控中心服务器地址，address="10.20.130.230:12080" 1.0.16以上版本

<dubbo:application/>

应用信息配置：

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

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

<dubbo:module/>

模块信息配置：

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

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

<dubbo:provider/>

服务提供者缺省值配置：

配置类：com.alibaba.dubbo.config.ProviderConfig
说明：该标签为<dubbo:service>和<dubbo:protocol>标签的缺省值设置。

标签 属性 对应URL参数 类型 是否必填 缺省值 作用 描述 兼容性
<dubbo:provider> id   string 可选 dubbo 配置关联 协议BeanId，可以在<dubbo:service proivder="">中引用此ID 1.0.16以上版本
<dubbo:provider> protocol <protocol> string 可选 dubbo 性能调优 协议名称 1.0.16以上版本
<dubbo:provider> host <host> string 可选 自动查找本机IP 服务发现 服务主机名，多网卡选择或指定VIP及域名时使用，为空则自动查找本机IP，建议不要配置，让Dubbo自动获取本机IP 1.0.16以上版本
<dubbo:provider> threads threads int 可选 100 性能调优 服务线程池大小(固定大小) 1.0.16以上版本
<dubbo:provider> payload payload int 可选 88388608(=8M) 性能调优 请求及响应数据包大小限制，单位：字节 2.0.0以上版本
<dubbo:provider> path <path> string 可选   服务发现 提供者上下文路径，为服务path的前缀 2.0.0以上版本
<dubbo:provider> server server string 可选 dubbo协议缺省为netty，http协议缺省为servlet 性能调优 协议的服务器端实现类型，比如：dubbo协议的mina,netty等，http协议的jetty,servlet等 2.0.0以上版本
<dubbo:provider> client client string 可选 dubbo协议缺省为netty 性能调优 协议的客户端实现类型，比如：dubbo协议的mina,netty等 2.0.0以上版本
<dubbo:provider> codec codec string 可选 dubbo 性能调优 协议编码方式 2.0.0以上版本
<dubbo:provider> serialization serialization string 可选 dubbo协议缺省为hessian2，rmi协议缺省为java，http协议缺省为json 性能调优 协议序列化方式，当协议支持多种序列化方式时使用，比如：dubbo协议的dubbo,hessian2,java,compactedjava，以及http协议的json,xml等 2.0.5以上版本
<dubbo:provider> default   boolean 可选 false 配置关联 是否为缺省协议，用于多协议 1.0.16以上版本
<dubbo:provider> filter service.filter string 可选   性能调优 服务提供方远程调用过程拦截器名称，多个名称用逗号分隔 2.0.5以上版本
<dubbo:provider> listener exporter.listener string 可选   性能调优 服务提供方导出服务监听器名称，多个名称用逗号分隔 2.0.5以上版本
<dubbo:provider> threadpool threadpool string 可选 fixed 性能调优 线程池类型，可选：fixed/cached 2.0.5以上版本
<dubbo:provider> accepts accepts int 可选 0 性能调优 服务提供者最大可接受连接数 2.0.5以上版本
<dubbo:provider> version version string 可选 0.0.0 服务发现 服务版本，建议使用两位数字版本，如：1.0，通常在接口不兼容时版本号才需要升级 2.0.5以上版本
<dubbo:provider> group group string 可选   服务发现 服务分组，当一个接口有多个实现，可以用分组区分 2.0.5以上版本
<dubbo:provider> delay delay int 可选 0 性能调优 延迟注册服务时间(毫秒)- ，设为-1时，表示延迟到Spring容器初始化完成时暴露服务 2.0.5以上版本
<dubbo:provider> timeout default.timeout int 可选 1000 性能调优 远程服务调用超时时间(毫秒) 2.0.5以上版本
<dubbo:provider> retries default.retries int 可选 2 性能调优 远程服务调用重试次数，不包括第一次调用，不需要重试请设为0 2.0.5以上版本
<dubbo:provider> connections default.connections int 可选 0 性能调优 对每个提供者的最大连接数，rmi、http、hessian等短连接协议表示限制连接数，dubbo等长连接协表示建立的长连接个数 2.0.5以上版本
<dubbo:provider> loadbalance default.loadbalance string 可选 random 性能调优 负载均衡策略，可选值：random,roundrobin,leastactive，分别表示：随机，轮循，最少活跃调用 2.0.5以上版本
<dubbo:provider> async default.async boolean 可选 false 性能调优 是否缺省异步执行，不可靠异步，只是忽略返回值，不阻塞执行线程 2.0.5以上版本
<dubbo:provider> stub stub boolean 可选 false 服务治理 设为true，表示使用缺省代理类名，即：接口名 + Local后缀。 2.0.5以上版本
<dubbo:provider> mock mock boolean 可选 false 服务治理 设为true，表示使用缺省Mock类名，即：接口名 + Mock后缀。 2.0.5以上版本
<dubbo:provider> token token boolean 可选 false 服务治理 令牌验证，为空表示不开启，如果为true，表示随机生成动态令牌 2.0.5以上版本
<dubbo:provider> registry registry string 可选 缺省向所有registry注册 配置关联 向指定注册中心注册，在多个注册中心时使用，值为<dubbo:registry>的id属性，多个注册中心ID用逗号分隔，如果不想将该服务注册到任何registry，可将值设为N/A 2.0.5以上版本
<dubbo:provider> dynamic dynamic boolean 可选 true 服务治理 服务是否动态注册，如果设为false，注册后将显示后disable状态，需人工启用，并且服务提供者停止时，也不会自动取消册，需人工禁用。 2.0.5以上版本
<dubbo:provider> accesslog accesslog string/boolean 可选 false 服务治理 设为true，将向logger中输出访问日志，也可填写访问日志文件路径，直接把访问日志输出到指定文件 2.0.5以上版本
<dubbo:provider> owner owner string 可选   服务治理 服务负责人，用于服务治理，请填写负责人公司邮箱前缀 2.0.5以上版本
<dubbo:provider> document document string 可选   服务治理 服务文档URL 2.0.5以上版本
<dubbo:provider> weight weight int 可选   性能调优 服务权重 2.0.5以上版本
<dubbo:provider> executes executes int 可选 0 性能调优 服务提供者每服务每方法最大可并行执行请求数 2.0.5以上版本
<dubbo:provider> actives default.actives int 可选 0 性能调优 每服务消费者每服务每方法最大并发调用数 2.0.5以上版本
<dubbo:provider> proxy proxy string 可选 javassist 性能调优 生成动态代理方式，可选：jdk/javassist 2.0.5以上版本
<dubbo:provider> cluster default.cluster string 可选 failover 性能调优 集群方式，可选：failover/failfast/failsafe/failback/forking 2.0.5以上版本
<dubbo:provider> deprecated deprecated boolean 可选 false 服务治理 服务是否过时，如果设为true，消费方引用时将打印服务过时警告error日志 2.0.5以上版本
<dubbo:provider> queues queues int 可选 0 性能调优 线程池队列大小，当线程池满时，排队等待执行的队列大小，建议不要设置，当线程程池时应立即失败，重试其它服务提供机器，而不是排队，除非有特殊需求。 2.0.5以上版本
<dubbo:provider> charset charset string 可选 UTF-8 性能调优 序列化编码 2.0.5以上版本
<dubbo:provider> buffer buffer int 可选 8192 性能调优 网络读写缓冲区大小 2.0.5以上版本
<dubbo:provider> iothreads iothreads int 可选 CPU + 1 性能调优 IO线程池，接收网络读写中断，以及序列化和反序列化，不处理业务，业务线程池参见threads配置，此线程池和CPU相关，不建议配置。 2.0.5以上版本
<dubbo:provider> telnet telnet string 可选   服务治理 所支持的telnet命令，多个命令用逗号分隔 2.0.5以上版本
<dubbo:service> contextpath contextpath String 可选 缺省为空串 服务治理   2.0.6以上版本
<dubbo:provider> layer layer string 可选   服务治理 服务提供者所在的分层。如：biz、dao、intl:web、china:acton。 2.0.7以上版本

<dubbo:consumer/>

服务消费者缺省值配置：

配置类：com.alibaba.dubbo.config.ConsumerConfig
说明：该标签为<dubbo:reference>标签的缺省值设置。

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

<dubbo:method/>

方法级配置：

配置类：com.alibaba.dubbo.config.MethodConfig
说明：该标签为<dubbo:service>或<dubbo:reference>的子标签，用于控制到方法级，

标签 属性 对应URL参数 类型 是否必填 缺省值 作用 描述 兼容性
<dubbo:method> name   string 必填   标识 方法名 1.0.8以上版本
<dubbo:method> timeout <metodName>.timeout int 可选 缺省为的timeout 性能调优 方法调用超时时间(毫秒) 1.0.8以上版本
<dubbo:method> retries <metodName>.retries int 可选 缺省为<dubbo:reference>的retries 性能调优 远程服务调用重试次数，不包括第一次调用，不需要重试请设为0 2.0.0以上版本
<dubbo:method> loadbalance <metodName>.loadbalance string 可选 缺省为的loadbalance 性能调优 负载均衡策略，可选值：random,roundrobin,leastactive，分别表示：随机，轮循，最少活跃调用 2.0.0以上版本
<dubbo:method> async <metodName>.async boolean 可选 缺省为<dubbo:reference>的async 性能调优 是否异步执行，不可靠异步，只是忽略返回值，不阻塞执行线程 1.0.9以上版本
<dubbo:method> sent <methodName>.sent boolean 可选 true 性能调优 异步调用时，标记sent=true时，表示网络已发出数据 2.0.6以上版本
<dubbo:method> actives <metodName>.actives int 可选 0 性能调优 每服务消费者最大并发调用限制 2.0.5以上版本
<dubbo:method> executes <metodName>.executes int 可选 0 性能调优 每服务每方法最大使用线程数限制- -，此属性只在<dubbo:method>作为<dubbo:service>子标签时有效 2.0.5以上版本
<dubbo:method> deprecated <methodName>.deprecated boolean 可选 false 服务治理 服务方法是否过时，此属性只在<dubbo:method>作为<dubbo:service>子标签时有效 2.0.5以上版本
<dubbo:method> sticky <methodName>.sticky boolean 可选 false 服务治理 设置true 该接口上的所有方法使用同一个provider.如果需要更复杂的规则，请使用用路由 2.0.6以上版本
<dubbo:method> return <methodName>.return boolean 可选 true 性能调优 方法调用是否需要返回值,async设置为true时才生效，如果设置为true，则返回future，或回调onreturn等方法，如果设置为false，则请求发送成功后直接返回Null 2.0.6以上版本
<dubbo:method> oninvoke attribute属性，不在URL中体现 String 可选   性能调优 方法执行前拦截 2.0.6以上版本
<dubbo:method> onreturn attribute属性，不在URL中体现 String 可选   性能调优 方法执行返回后拦截 2.0.6以上版本
<dubbo:method> onthrow attribute属性，不在URL中体现 String 可选   性能调优 方法执行有异常拦截 2.0.6以上版本
<dubbo:method> cache <methodName>.cache string/boolean 可选   服务治理 以调用参数为key，缓存返回结果，可选：lru, threadlocal, jcache等 Dubbo2.1.0及其以上版本支持
<dubbo:method> validation <methodName>.validation boolean 可选   服务治理 是否启用JSR303标准注解验证，如果启用，将对方法参数上的注解进行校验 Dubbo2.1.0及其以上版本支持

比如：

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

<dubbo:parameter/>

选项参数配置：

配置类：java.util.Map
说明：该标签为<dubbo:protocol>或<dubbo:service>或<dubbo:provider>或<dubbo:reference>或<dubbo:consumer>的子标签，用于配置自定义参数，该配置项将作为扩展点设置自定义参数使用。

标签 属性 对应URL参数 类型 是否必填 缺省值 作用 描述 兼容性
<dubbo:parameter> key key string 必填   服务治理 路由参数键 2.0.0以上版本
<dubbo:parameter> value value string 必填   服务治理 路由参数值 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>

也可以：

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

详细参见：自定义参数

啦啦啦

时间： 2024-10-27 03:15:38

Dubbo -- 系统学习 笔记 -- 配置参考手册的相关文章

Dubbo -- 系统学习 笔记 -- API参考手册

API参考手册 配置API 注解API 模型API 上下文API 服务API API参考手册 Dubbo的常规功能,都保持零侵入,但有些功能不得不用API侵入才能实现. API汇总如下: 配置API com.alibaba.dubbo.config.ServiceConfig com.alibaba.dubbo.config.ReferenceConfig com.alibaba.dubbo.config.ProtocolConfig com.alibaba.dubbo.config.Regis

Dubbo -- 系统学习 笔记 -- 配置

配置 Xml配置 属性配置 注解配置 API配置 配置 Xml配置 配置项说明 :详细配置项,请参见:配置参考手册 API使用说明 : 如果不想使用Spring配置,而希望通过API的方式进行调用,请参见:API配置 配置使用说明 : 想知道如何使用配置,请参见:快速启动 示例: XML : provider.xml <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://w

Dubbo -- 系统学习 笔记 -- 示例 -- 分组聚合

Dubbo -- 系统学习 笔记 -- 目录 示例 想完整的运行起来,请参见:快速启动,这里只列出各种场景的配置方式 分组聚合 按组合并返回结果,比如菜单服务,接口一样,但有多种实现,用group区分,现在消费方需从每种group中调用一次返回结果,合并结果返回,这样就可以实现聚合菜单项. 从2.1.0版本开始支持 配置如:(搜索所有分组) <dubbo:reference interface="com.xxx.MenuService" group="*" m

Dubbo -- 系统学习 笔记 -- 示例 -- 只注册

Dubbo -- 系统学习 笔记 -- 目录 示例 想完整的运行起来,请参见:快速启动,这里只列出各种场景的配置方式 只注册 问题 如果有两个镜像环境,两个注册中心,有一个服务只在其中一个注册中心有部署,另一个注册中心还没来得及部署,而两个注册中心的其它应用都需要依赖此服务,所以需要将服务同时注册到两个注册中心,但却不能让此服务同时依赖两个注册中心的其它服务. 解决方案 可以让服务提供者方,只注册服务到另一注册中心,而不从另一注册中心订阅服务. 禁用订阅配置: <dubbo:registry i

Dubbo -- 系统学习 笔记 -- 示例 -- 直连提供者

Dubbo -- 系统学习 笔记 -- 目录 示例 想完整的运行起来,请参见:快速启动,这里只列出各种场景的配置方式 直连提供者 在开发及测试环境下,经常需要绕过注册中心,只测试指定服务提供者,这时候可能需要点对点直连,点对点直联方式,将以服务接口为单位,忽略注册中心的提供者列表,A接口配置点对点,不影响B接口从注册中心获取列表. (1) 如果是线上需求需要点对点,可在<dubbo:reference>中配置url指向提供者,将绕过注册中心,多个地址用分号隔开,配置如下:(1.0.6及以上版本

Dubbo -- 系统学习 笔记 -- 示例 -- 多注册中心

Dubbo -- 系统学习 笔记 -- 目录 示例 想完整的运行起来,请参见:快速启动,这里只列出各种场景的配置方式 多注册中心 可以自行扩展注册中心,参见:注册中心扩展 (1) 多注册中心注册 比如:中文站有些服务来不及在青岛部署,只在杭州部署,而青岛的其它应用需要引用此服务,就可以将服务同时注册到两个注册中心. XML : provider.xml <?xml version="1.0" encoding="UTF-8"?> <beans xm

Dubbo -- 系统学习 笔记 -- 示例 -- 集群容错

Dubbo -- 系统学习 笔记 -- 目录 示例 想完整的运行起来,请参见:快速启动,这里只列出各种场景的配置方式 集群容错 在集群调用失败时,Dubbo提供了多种容错方案,缺省为failover重试. 各节点关系: 这里的Invoker是Provider的一个可调用Service的抽象,Invoker封装了Provider地址及Service接口信息. Directory代表多个Invoker,可以把它看成List<Invoker>,但与List不同的是,它的值可能是动态变化的,比如注册中

Dubbo -- 系统学习 笔记 -- 示例 -- 多协议

Dubbo -- 系统学习 笔记 -- 目录 示例 想完整的运行起来,请参见:快速启动,这里只列出各种场景的配置方式 多协议 可以自行扩展协议,参见:协议扩展 (1) 不同服务不同协议 比如:不同服务在性能上适用不同协议进行传输,比如大数据用短连接协议,小数据大并发用长连接协议. XML : provider.xml <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://w

Dubbo -- 系统学习 笔记 -- 示例 -- 服务分组

Dubbo -- 系统学习 笔记 -- 目录 示例 想完整的运行起来,请参见:快速启动,这里只列出各种场景的配置方式 服务分组 当一个接口有多种实现时,可以用group区分. <dubbo:service group="feedback" interface="com.xxx.IndexService" /> <dubbo:service group="member" interface="com.xxx.IndexS