建议采用同一个父工程的多个模块module.
服务提供者包括api和provider.
api:存放服务接口(interface)和服务模型(pojo),服务异常(Exception),一般是jar工程。
provider:存放服务接口的实现以及暴露服务的配置,依赖api模块,一般是war工程。
服务消费者
consumer:存放引用远程服务的配置和调用远程服务实现,依赖api模块,议案是war工程。
Dubbo采用全Spring配置方式,透明化接入应用,对应用没有任何API侵入,只需用Spring加载Dubbo的配置即可,Dubbo基于Spring的Schema扩展进行加载。
下面简单说明一下Dubbo的用法,
服务接口
定义服务接口
public interface DemoService {
String sayHello(String name);
}
该接口需要单独打包,以便在服务提供方和消费方之间共享。
服务提供者
在服务提供者处实现接口(对服务消费者隐藏接口实现细节)
package com.winner.dubbo.demo.provider.service;
import com.alibaba.dubbo.rpc.RpcContext;
import com.winner.dubbo.demo.api.service.DemoService;
import java.text.SimpleDateFormat;
import java.util.Date;
/**
* @author winner_0715
* @date 2017/12/17
*/
public class DemoServiceImpl implements DemoService {
@Override
public String sayHello(String name) {
System.out.println("[" + new SimpleDateFormat("HH:mm:ss").format(new Date()) + "] Hello "
+ name + ", request from consumer: " + RpcContext.getContext().getRemoteAddress());
return "Hello " + name + ", response form provider: " + RpcContext.getContext().getLocalAddress();
}
}
在classpath下用spring配置声明暴露服务:spring-dubbo-provider.xml
<beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:dubbo="http://code.alibabatech.com/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-2.5.xsd
http://code.alibabatech.com/schema/dubbo http://code.alibabatech.com/schema/dubbo/dubbo.xsd">
<!-- 提供方应用信息,用于计算依赖关系 -->
<dubbo:application name="demo-provider" owner="winner_0715" organization="wireless"/>
<!-- 使用zookeeper注册中心暴露服务地址 -->
<dubbo:registry protocol="zookeeper" address="zk地址" group="/demo/group/default"/>
<!-- 用dubbo协议在20880端口暴露服务 -->
<dubbo:protocol name="dubbo" port="20880"/>
<!-- 和本地bean一样实现服务 -->
<bean id="demoService" class="com.winner.dubbo.demo.provider.service.DemoServiceImpl"/>
<!-- 声明需要暴露的服务接口 -->
<dubbo:service interface="com.winner.dubbo.demo.api.service.DemoService" ref="demoService" version="1.0" timeout="3000"/>
</beans>
(1)在根节点beans添加xml命名空间dubbo,xmlns:dubbo="http://code.alibabatech.com/schema/dubbo"和dubbo标签遵循的规则地址。xsi:schemaLocation=".... http://code.alibabatech.com/schema/dubbo http://code.alibabatech.com/schema/dubbo/dubbo.xsd">
(2)dubbo:application应用信息配置,@name应用的名称,用于注册中心计算应用之间的依赖关系,消费者和提供者应用名不要一样。@owner应用负责人,出问题的时候可以找到对应的人来解决。@organization组织名称,用于注册中心区分服务来源。
(3)dubbo:registry注册中心配置,@protocol 注册中心地址协议,一般都写zookeeper。@address 注册中心服务器地址,同一个集群内的多个地址使用逗号进行分隔,如ip:port,ip:port,不同集群的注册中心,配置多个<dubbo:registry>,@group 注册服务根节点。
(4)dubbo:protocol 服务提供者协议配置 @name 协议名称,缺省是dubbo,@port 服务端口,dubbo协议缺省端都是20880,如果配置是-1或者没有配置port,则会分配一个没有被占用的端口。
(5)dubbo:service 服务提供者暴露服务配置
@interface 服务接口名 @ref 服务对象实现引用 @version 服务版本,建议使用两位数字的版本@timeout服务超时时间
服务消费者
通过spring配置引用远程服务
<beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:dubbo="http://code.alibabatech.com/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-2.5.xsd
http://code.alibabatech.com/schema/dubbo http://code.alibabatech.com/schema/dubbo/dubbo.xsd">
<!-- 消费方应用名,用于计算依赖关系,不是匹配条件,不要与提供方一样 -->
<dubbo:application name="demo-consumer" owner="winner_0715" organization="wireless"/>
<!-- 使用zookeeper注册中心暴露服务地址 -->
<dubbo:registry protocol="zookeeper" address="zk地址" group="/demo/group/default"/>
<!-- 生成远程服务代理,可以和本地bean一样使用demoService -->
<dubbo:reference id="demoService"interface="com.winner.dubbo.demo.api.service.DemoService" check="false" version="1.0"/>
</beans>
dubbo:reference 服务消费者引用服务配置
@id 服务引用bean id @interface 服务接口名 @version服务版本,与服务提供者的版本一致 @check 启动时检查提供者是否存在,true的话报错,false忽略。
服务消费者处只要通过Spring拿到demoService,即可像使用本地接口一样使用DemoService这个接口里面的方法:
import org.springframework.context.support.ClassPathXmlApplicationContext;
import com.winner.dubbo.demo.api,service.DemoService;
public class Consumer {
public static void main(String[] args) throws Exception {
ClassPathXmlApplicationContext context =
new ClassPathXmlApplicationContext(new String[] {"consumer.xml"});
context.start();
DemoService demoService = (DemoService)context.getBean("demoService"); // 获取远程服务代理
String hello = demoService.sayHello("world"); // 执行远程方法
System.out.println(hello); // 显示调用结果
}
}
看到整个过程中:
1、没有任何Dubbo的代码,使用Dubbo的时候全部都是Spring配置,这就是前面提到的Dubbo对应用没有任何API侵入
2、不需要考虑底层线程模型、序列化、反序列化、url解析等问题,这些都是Dubbo底层做好的
Dubbo常用标签
1、<dubbo:service /> 用于服务生产者暴露服务配置
属 性 | 类 型 | 是否必填 | 缺省值 | 描 述 |
interface | class | 必填 | 无 | 服务接口全路径 |
ref | object | 必填 | 无 | 服务对象实现引用 |
version | string | 可选 | 0.0.0 | 服务版本,建议使用两位数字版本如1.0,通常在接口不兼容时版本号才需要升级 |
timeout | int | 可选 | 1000 | 远程服务调用超时时间(毫秒) |
retries | int | 可选 | 2 | 远程服务调用重试次数,不包括第一次调用,不需要重试请设为0 |
connections | int | 可选 | 100 | 每个生产者的最大连接数,短连接协议如rmi,表示限制连接数;长连接协议如dubbo表示建立的长连接个数 |
loadbalance | string | 可选 | random | 负载均衡策略,可选值为:random(随机)、roundrobin(轮询)、leastactive(最少活跃调用) |
async | boolean | 可选 | false | 是否缺省异步执行,不可靠的异步,只是忽略返回值,不阻塞执行线程 |
register | boolean | 可选 | true | 该协议的服务是否注册到注册中心 |
2、<dubbo:reference /> 用于服务消费者引用服务配置
属 性 | 类 型 | 是否必填 | 缺省值 | 描 述 |
id | string | 必填 | 无 | 服务引用beanId |
interface | class | 必填 | 无 | 服务接口全路径 |
version | string | 可选 | 无 | 服务版本,与服务生产者的版本一致 |
timeout | long | 可选 | 使用<dubbo:consumer>的timeout | 服务方法调用超时时间(毫秒) |
retries | int | 可选 | 使用<dubbo:consumer>的retries | 远程服务调用重试次数,不包括第一次调用,不需要重试请设为0 |
connections | int | 可选 | 使用<dubbo:consumer>的connections | 每个生产者的最大连接数,短连接协议如rmi,表示限制连接数;长连接协议如dubbo表示建立的长连接个数 |
loadbalance | string | 可选 | 使用<dubbo:consumer>的loadbalance | 负载均衡策略,可选值为:random(随机)、roundrobin(轮询)、leastactive(最少活跃调用) |
async | boolean | 可选 | 使用<dubbo:consumer>的async | 是否缺省异步执行,不可靠的异步,只是忽略返回值,不阻塞执行线程 |
check | boolean | 可选 | 使用<dubbo:consumer>的check | 启动时检查服务生产者是否存在,true则报错,false则忽略 |
url | string | 可选 | 无 | 点对点直连服务提供者地址,将绕过注册中心,比如"dubbo://localhost:20890",这个比较多的使用在测试中 |
protocol | string | 可选 | 无 | 只调用指定协议的服务生产者,其他协议忽略 |
3、<dubbo:protocol /> 用于服务生产者协议配置(如果需要支持多协议,可以声明多个此标签,并在<dubbo:service />通过protocol属性指定使用的协议)
属 性 | 类 型 | 是否必填 | 缺省值 | 描 述 |
id | string | 可选 | dubbo | 协议beanId,<dubbo service />中的protocol引用此ID,如果不填缺省和name属性值一样 |
name | sring | 必填 | dubbo | 协议名称 |
port | int | 可选 |
dubbo->20800,rmi->1099,http->80,hessian->80 如果配置为-1或未配置,则会分配一个没有被占用的端口 |
服务端口 |
host | string | 可选 | 自动查找本机ip |
为空则自动查找本机ip,建议不配置让Dubbo自动获取本机ip |
threadpool | string | 可选 | fixed | 线程池类型,可选fixed/cached |
threads | int | 可选 | 100 | 服务线程池大小(固定大小) |
serialization | string | 可选 | dubbo->hession2,rmi->java,http->json | 协议序列化方式,当协议支持多种序列化方式时使用 |
register | boolean | 可选 | true | 该协议的服务是否注册到注册中心 |
4、<dubbo:registry /> 用于注册中心配置(如果有多个不同的注册中心可以声明多个标签并且<dubbo:service />或<dubbo:reference />中使用registry属性指定)
属 性 | 类 型 | 是否必填 | 缺省值 | 描 述 |
id | string | 可选 | 无 | 注册中心引用beanId,可在<dubbo:service />或<dubbo:reference />中引用此ID |
address | string | 必填 | 无 |
注册中心服务地址,如果地址没有端口缺省为9090,同一个集群内的多个地址用逗号分隔,如:ip:port,ip:port,不同的 集群注册中心请配置多个<dubbo:registry />标签 |
protocol | string | 可选 | dubbo | 注册中心地址协议,支持dubbo、http、local三种协议,分别表示dubbo地址、http地址和本地注册中心 |
port | int | 可选 | 9090 | 注册中心缺省端口,当address没有带端口时使用此端口作为缺省值 |
username | string | 可选 | 无 | 登陆注册中心用户名,如果注册中心不需要验证可不填 |
password | string | 可选 | 无 | 登陆注册中心密码,如果注册中心不需要验证可不填 |
transport | string | 可选 | netty | 网络传输方式,可选mina、netty |
timeout | int | 可选 | 5000 | 注册中心请求超时时间(毫秒) |
file | string | 可选 | 无 | 使用文件缓存注册中心地址列表以及服务提供者列表,应用重启时将基于此文件恢复,注意两个注册中心不能使用同一文件存储 |
check | boolean | 可选 | true | 注册中心不存在时,是否报错 |
register | boolean | 可选 | true | 是否向此注册中心注册服务,如果设为false,将只订阅,不注册 |
subscribe | boolean | 可选 | true | 是否向此注册中心订阅服务,如果设为false,将只注册,不订阅 |
5、<dubbo:method />用于方法级配置(该标签为<dubbo:service/>或<dubbo:reference/>的子标签,用于控制到方法级)
属 性 | 类 型 | 是否必填 | 缺省值 | 描 述 |
method | string | 必填 | 无 | 方法名 |
timeout | int | 可选 | 缺省为<dubbo:reference/>的timeout | 方法调用超时时间(毫秒) |
retires | int | 可选 | 缺省为<dubbo:reference/>的retries | 远程服务调用重试次数,不包括第一次调用,不需要重试请设为0 |
loadbalance | string | 可选 | 缺省为<dubbo:reference/>的loadbalance | 负载均衡策略,可选值为:random(随机)、roundrobin(轮询)、leastactive(最少活跃调用) |
async | boolean | 可选 | 缺省为<dubbo:reference/>的async | 是否异步执行,不可靠异步,只是忽略返回值,不阻塞执行线程 |
actives | int | 可选 | 0 | 每服务消费者最大并发调用限制 |
executes | int | 可选 | 0 | 每服务每方法最大使用线程数限制,此属性只在<dubbo:method/>作为<dubbo:service/>子标签时有效 |
另外,还有<dubbo:provider/>和<dubbo:consumer/>分别表示服务提供者(生产者)和服务消费者的缺省值配置,就不列举了。
Dubbo协议dubbo://
前面有说到一个Dubbo协议,下面来看一下Dubbo协议。
Dubbo协议Dubbo的缺省协议,使用基于mina1.1.7+hessian3.2.1的tbremoting交互。
- 连接个数:单连接
- 连接方式:长连接
- 传输协议:TCP
- 传输方式:NIO异步传输
- 序列化:Hessian二进制序列化
- 适用范围:传入传出参数数据包较小(建议小于100K),消费者比提供者个数多,单一消费者无法压满提供者,尽量不要使用dubbo协议传输大文件或超大字符串
- 使用场景:常规远程服务方法调用
从上面的适用范围总结,dubbo适合小数据量大并发的服务调用,以及消费者机器远大于生产者机器数的情况,不适合传输大数据量的服务比如文件、视频等,除非请求量很低。
另外,Dubbo手册还给开发者列出了Dubbo协议使用的约束:
- 参数及返回值需要实现Serializable接口
- 参数及返回值自定义实现List、Map、Number、Date、Calendar等接口,只能用JDK自带的实现,因为hessian会做特殊处理,自定义实现类中的属性值都会丢失