1. 提出需求
某个电商系统,订单服务需要调用用户服务获取某个用户的所有地址;
这里就相当于你去某宝上面买东西,下单了是不是会出现你的所有收货地址出来,要你选一个,
我们现在需要创建两个服务模块进行测试
模块 | 功能 |
---|---|
订单服务web模块 | 创建订单等 |
用户服务service模块 | 查询用户地址等 |
测试预期结果:
订单服务web模块在A服务器,用户服务模块在B服务器,A可以远程调用B的功能。
2. 工程架构
2.1 分包
建议将服务接口,服务模型,服务异常等均放在API包中,因为服务模型及异常也是API的一部分,同时,这样做也符合分包原则:重用发布等价原则(REP),共同重用原则。
如果需要,也可以考虑在 API 包中放置一份 spring 的引用配置,这样使用方,只需在 spring 加载过程中引用此配置即可,配置建议放在模块的包目录下,以免冲突,如:com/alibaba/china/xxx/dubbo-reference.xml。
2、粒度
服务接口尽可能大粒度,每个服务方法应代表一个功能,而不是某功能的一个步骤,否则将面临分布式事务问题,Dubbo 暂未提供分布式事务支持。
服务接口建议以业务场景为单位划分,并对相近业务做抽象,防止接口数量爆炸。 不建议使用过于抽象的通用接口,如:Map
query(Map),这样的接口没有明确语义,会给后期维护带来不便。
项目结构
先忽略boot前缀的model,这两个项目为springboot版本
3. 创建模块
3.1、gmall-interface:公共接口层(model,service,exception…)
3.1.1 gmall-interface–> UserAddress
@Data
@AllArgsConstructor
@NoArgsConstructor
@Accessors(chain=true)
public class UserAddress implements Serializable {
private Integer id;
private String userAddress;//用户地址
private String userId;//用户id
private String consignee;//收货人
private String phoneNum;//电话号码
private String isDefault;//是否为默认地址 Y-是, N-否
}
3.1.2 gmall-interface–> OrderService 订单接口
public interface OrderService {
/**
* 初始化订单
* @param userId
*/
public List<UserAddress> initOrder(String userId);
}
3.1.2 gmall-interface–> UserService 用户接口
public interface UserService {
/**
* 按照用户id返回所有的收货地址
* @param userId
* @return
*/
public List<UserAddress> getUserAddressList(String userId);
}
3.1.3 gmall-interface–>pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>Dubbo</artifactId>
<groupId>com.xianyiquan.gmall</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>gmall-interface</artifactId>
<dependencies>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.18</version>
</dependency>
</dependencies>
</project>
3.2、user-service-provider 服务提供者
3.1 先重点看一下provider.xml
这里详细说明一下provider.xml
1、指定当前服务/应用的名字(同样的服务名字相同,不要和别的服务同名)这里用项目名作为服务名。服务注册到注册中心,得有个名字,就像我们得有个身份证号吧。
2、指定注册中心的位置 dubbo:registry
第一种直接一步到位,直接将注册协议+地址写在一起,
第二种注册协议跟地址分开,这里两种用法都可以,个人比较喜欢第二种。
<!-- <dubbo:registry address="zookeeper://127.0.0.1:2181"></dubbo:registry> -->
<dubbo:registry protocol="zookeeper" address="127.0.0.1:2181"></dubbo:registry>
3、指定通信规则(通信协议?通信端口)dubbo:protocol
<dubbo:protocol name="dubbo" port="20882"></dubbo:protocol>
4、暴露服务 dubbo:service , ref:指向服务的真正的实现对象
(说白了就是提供公共api的接口实现类,然后设置一些参数,调用实现类超时时间,使用哪个版本,实现类里面又可以设置方法的超时)
<dubbo:service interface="service.UserService"
ref="userServiceImpl01" timeout="1000" version="1.0.0">
<dubbo:method name="getUserAddressList" timeout="1000"></dubbo:method>
</dubbo:service>
-> service.UserService 为公共api的接口
-> ref 指向服务的实现对象 userServiceImpl01
-> timeout 设置调用类的超时时间为1秒
-> version 指定使用的版本为1.0.0
5、统一设置服务提供方的规则 <dubbo:provider
上面第四点是设置单个类的超时时间,这里直接设置整个服务提供者的超时时间
<dubbo:provider timeout="1000"></dubbo:provider>
6、服务的实现
上面第四点将接口提供暴露出来,并提供实现类,这里需要将实现类注册进IOC里面
<bean id="userServiceImpl01" class="service.impl.UserServiceImpl"></bean>
然后暴露一个接口,并加到spring的容器中
<dubbo:service interface="service.UserService"
ref="userServiceImpl02" timeout="1000" version="2.0.0">
<dubbo:method name="getUserAddressList" timeout="1000"></dubbo:method>
</dubbo:service>
<bean id="userServiceImpl02" class="service.impl.UserServiceImpl2"></bean>
7、 连接监控中心 dubbo:monitor
<dubbo:monitor protocol="registry"></dubbo:monitor>
3.2 user-service-provider–》impl
上面要是看懂了的话,这里直接上代码了,非常简单
UserServiceImpl
package service.impl;
import bean.UserAddress;
import service.UserService;
import java.util.Arrays;
import java.util.List;
/**
* 1.将服务提供者注册到注册中心(暴露服务)
* 1.)导入dubbo依赖
* 2.)配置服务提供者
* 2.让服务消费者去注册中心订阅服务提供者的服务地址
* @author xianyiquan
* @className
* @create 2019-12-06 13:46
*/
public class UserServiceImpl implements UserService {
@Override
public List<UserAddress> getUserAddressList(String userId) {
System.out.println("UserServiceImpl.....old...");
UserAddress address1 = new UserAddress(1, "北京市昌平区宏福科技园综合楼3层", "1", "李老师", "010-56253825", "Y");
UserAddress address2 = new UserAddress(2, "深圳市宝安区西部硅谷大厦B座3层(深圳分校)", "1", "王老师", "010-56253825", "N");
/*try {
Thread.sleep(4000);
} catch (InterruptedException e) {
e.printStackTrace();
}*/
return Arrays.asList(address1,address2);
}
}
UserServiceImpl2
package service.impl;
import bean.UserAddress;
import service.UserService;
import java.util.Arrays;
import java.util.List;
public class UserServiceImpl2 implements UserService {
@Override
public List<UserAddress> getUserAddressList(String userId) {
System.out.println("UserServiceImpl.....new...");
// TODO Auto-generated method stub
UserAddress address1 = new UserAddress(1, "南宁市青秀区南湖公园", "1", "xianyiquan", "012345678", "Y");
UserAddress address2 = new UserAddress(2, "深圳市福田区会展中心(皇庭中心)", "1", "xianyiquan", "012345678", "N");
return Arrays.asList(address1,address2);
}
}
UserServiceStub
package service.impl;
import java.util.List;
import bean.UserAddress;
import org.springframework.util.StringUtils;
import service.UserService;
public class UserServiceStub implements UserService {
private final UserService userService;
/**
* 传入的是userService远程的代理对象
* @param userService
*/
public UserServiceStub(UserService userService) {
super();
this.userService = userService;
}
@Override
public List<UserAddress> getUserAddressList(String userId) {
System.out.println("UserServiceStub.....");
if(!StringUtils.isEmpty(userId)) {
return userService.getUserAddressList(userId);
}
return null;
}
}
MainApplication
import org.springframework.context.support.ClassPathXmlApplicationContext;
import java.io.IOException;
/**
* @author xianyiquan
* @className
* @create 2019-12-06 15:11
*/
public class MainApplication {
public static void main(String[] args) throws IOException {
ClassPathXmlApplicationContext ioc = new ClassPathXmlApplicationContext("provider.xml");
ioc.start();
System.in.read();
}
}
pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>Dubbo</artifactId>
<groupId>com.xianyiquan.gmall</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>order-service-consumer</artifactId>
<dependencies>
<dependency>
<groupId>com.xianyiquan.gmall</groupId>
<artifactId>gmall-interface</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<!-- 引入dubbo-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>dubbo</artifactId>
<version>2.6.2</version>
</dependency>
<!-- 注册中心使用的是zookeeper,引入操作zookeeper的客户端 -->
<dependency>
<groupId>org.apache.curator</groupId>
<artifactId>curator-framework</artifactId>
<version>2.12.0</version>
</dependency>
</dependencies>
</project>
3.2 消费者order-service-consumer
1. 配置原则
同是生产者或者同是消费者, 按照精确优先的原则, 方法级优先, 接口级次之, 全局配置再次之
如果级别一样,则消费方优先,提供方次之
JVM启动 -D参数优先,这样可以使用用户在部署和启动时进行参数重写,比如在启动时需要改变协议的端口。
XML次之,如果在XML中有配置,则dubbo.propertiess中的相应配置项无效。
Properties最后,相当于缺省值,只有XML没有配置时,dubbo.properties中的相应配置项才会生效,通常用于共享公共配置,比如应用名。
2. 重试次数
失败自动切换,当出现失败,重试其他服务器,但重试会带来更长延迟,可通过 retires = "2"
来设置重置次数(不含第一次)。
3. 超时时间
由于网络或服务端不可靠,会导致出现一种不确定的中间状态(超时),为了避免超时导致客户端资源(线程)挂起,必须设置超时时间。
3.1 Dubbo消费端
3.2 Dubbo提供方
3.3 配置原则
dubbo推荐在Provider上尽量多配置Consumer端属性:
- 1.作为服务的提供者,比服务使用更方便清楚服务性能参数,如调用的超时时间,合理的重试次数,等等
- 2.在Provider配置后,Consumer不配置则会使用Provider的配置值,即Provider配置可以作为Consumer的缺省值. 否则, Consumer会使用Consumer端的全局设置, 这对于Provider不可控的, 并且往往是不合理的。
配置的覆盖原则:
1)方法级配置优于接口级别,即小Scope优先。
2)Consumer端配置优于Provider配置 优于 全局配置。
3)最后是Dubbo Hard Code的配置值(见配置文档)
4. 版本号
当一个接口实现,出现不兼容升级时,可以版本号过度,版本号不同的服务相互间不引用,可以按照以下的步骤进行版本迁移:
- 1.在低压力时间段,先升级一半提供者为新版本
- 2.再将所有消费者升级为新版本
- 3.然后将剩下的一半提供者升级为新版本
如果不需要区分版本,可以按照以下的方式配置
version="*"
<dubbo:reference id="UserService" interface="service.UserService" version="*"/>