Dubbo | Dubbo快速上手笔记 - 环境与配置

目录

• 前言
• 1. Dubbo相关概念
  • 1.1 自动服务发现工作原理
• 2. 启动文件
  • 2.1 zookeeper-3.4.11\bin\zkServer.cmd
  • 2.2 zookeeper-3.4.11\bin\zkCli.cmd
  • 2.3 java -jar dubbo-admin-0.0.1-SNAPSHOT.jar
  • 2.4 dubbo-monitor-simple-2.0.0\assembly.bin\start.bat
• 3. 修改项目文件
  • 3.1 在pom.xml文件里导入相关依赖
  • 3.2 在application.properties文件 / src/main/resources/provider.xml文件中配置dubbo
  • 3.2.1 提供者
  • 3.2.2 消费者
  • 3.3 使用注解开启功能
• 4. 配置文件
  • 4.1 配置文件的优先级
  • 4.2 不同粒度配置的覆盖关系
  • 4.3 关闭启动检查check
  • 4.4 超时timeout
  • 4.5 重试次数retries
  • 4.6 多版本version
  • 4.7 本地存根stub
  • 4.8 SpringBoot与Dubbo整合的三种方式
• 最后

---

前言

比较基础的dubbo学习笔记，一些参考资料如下：

尚硅谷Dubbo教程(dubbo经典之作)

Dubbo官网

Dubbo 2.x文档

---

1. Dubbo相关概念

1.1 自动服务发现工作原理

2. 启动文件

这里指使用zookeeper作为注册中心；并启动相关dubbo监控；

2.1 zookeeper-3.4.11\bin\zkServer.cmd

可以在zookeeper-3.4.11\conf路径下配置zookeeper客户端的端口号以及data数据：

在zookeeper-3.4.11\bin目录下运行cmd启动zookeeper服务：

2.2 zookeeper-3.4.11\bin\zkCli.cmd

在zookeeper-3.4.11\bin目录下运行cmd启动zookeeper客户端：

2.3 java -jar dubbo-admin-0.0.1-SNAPSHOT.jar

可以在incubator-dubbo-ops-master\dubbo-admin\src\main\resources路径下修改application.properties文件中修改DubboWeb界面的端口：

在项目根路径下打开命令行，执行mvn clean package将项目打成jar包，再执行java -jar dubbo-admin-0.0.1-SNAPSHOT.jar命令运行Dubbo；

2.4 dubbo-monitor-simple-2.0.0\assembly.bin\start.bat

可以在dubbo-monitor-simple-2.0.0\conf路径下的dubbo.properties文件配置监控页端口：

在dubbo-monitor-simple-2.0.0\assembly.bin路径下双击运行start.bat文件：

3. 修改项目文件

需要对项目文件做些修改；以开启dubbo相关功能；

3.1 在pom.xml文件里导入相关依赖

<!-- 引入dubbo -->
<!-- https://mvnrepository.com/artifact/com.alibaba/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>

3.2 在application.properties文件 / src/main/resources/provider.xml文件中配置dubbo

3.2.1 提供者

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:dubbo="http://code.alibabatech.com/schema/dubbo"
	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
		http://code.alibabatech.com/schema/dubbo http://code.alibabatech.com/schema/dubbo/dubbo.xsd">

	<!-- 1、指定当前服务/应用的名字（同样的服务名字相同，不要和别的服务同名） -->
	<dubbo:application name="user-service-provider"></dubbo:application>

	<!-- 2、指定注册中心的位置 -->
	<!-- <dubbo:registry address="zookeeper://127.0.0.1:2181"></dubbo:registry> -->
	<dubbo:registry protocol="zookeeper" address="127.0.0.1:2181"></dubbo:registry>

	<!-- 3、指定通信规则（name指定通信协议？通信端口） -->
	<dubbo:protocol name="dubbo" port="20882"></dubbo:protocol>

	<!-- 4、暴露服务   ref：指向服务的真正的实现对象 -->
	<dubbo:service interface="com.atguigu.gmall.service.UserService"
		ref="userServiceImpl01" timeout="1000" version="1.0.0">
		<dubbo:method name="getUserAddressList" timeout="1000"></dubbo:method>
	</dubbo:service>

	<!--统一设置服务提供方的规则  -->
	<dubbo:provider timeout="1000"></dubbo:provider>

	<!-- 服务的实现 -->
	<bean id="userServiceImpl01" class="com.atguigu.gmall.service.impl.UserServiceImpl"></bean>

	<dubbo:service interface="com.atguigu.gmall.service.UserService"
		ref="userServiceImpl02" timeout="1000" version="2.0.0">
		<dubbo:method name="getUserAddressList" timeout="1000"></dubbo:method>
	</dubbo:service>
	<bean id="userServiceImpl02" class="com.atguigu.gmall.service.impl.UserServiceImpl2"></bean>

	<!-- 连接监控中心 -->
	<dubbo:monitor protocol="registry"></dubbo:monitor>

</beans>

3.2.2 消费者

<?xml version="1.0" encoding="UTF-8"?>
<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:context="http://www.springframework.org/schema/context"
	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd
		http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd
		http://code.alibabatech.com/schema/dubbo http://code.alibabatech.com/schema/dubbo/dubbo.xsd">
    <!--启用包扫描-->
	<context:component-scan base-package="com.atguigu.gmall.service.impl"></context:component-scan>

	<dubbo:application name="order-service-consumer"></dubbo:application>

	<dubbo:registry address="zookeeper://127.0.0.1:2181"></dubbo:registry>

	<!--  配置本地存根-->

	<!--声明需要调用的远程服务的接口；生成远程服务代理  -->
	<!--
		1）、精确优先 (方法级优先，接口级次之，全局配置再次之)
		2）、消费者设置优先(如果级别一样，则消费方优先，提供方次之)
	-->
	<!-- timeout="0" 默认是1000ms-->
	<!-- retries="":重试次数，不包含第一次调用，0代表不重试-->
	<!-- 幂等（设置重试次数）【查询、删除、修改】、非幂等（不能设置重试次数）【新增】 -->
	<dubbo:reference interface="com.atguigu.gmall.service.UserService"
		id="userService" timeout="5000" retries="3" version="*">
		<!-- <dubbo:method name="getUserAddressList" timeout="1000"></dubbo:method> -->
	</dubbo:reference>

	<!-- 配置当前消费者的统一规则：所有的服务都不检查 -->
	<dubbo:consumer check="false" timeout="5000"></dubbo:consumer>

	<dubbo:monitor protocol="registry"></dubbo:monitor>
	<!-- <dubbo:monitor address="127.0.0.1:7070"></dubbo:monitor> -->

</beans>

在进行SpringBoot整合Dubbo时，以上信息可以配置进application.properties文件里；详情请见《4.8 SpringBoot与Dubbo整合的三种方式》

3.3 使用注解开启功能

注解	位置	功能
@EnableDubbo	开启dubbo相关功能	主启动类
@Service	暴露服务	服务提供者provider
@Reference	远程调用	服务消费者consumer

4. 配置文件

Dubbo 的 XML Schema 配置参考手册

dubbo:consumer 配置

4.1 配置文件的优先级

• JVM 启动 -D 参数优先；
• XML 次之；
• Properties 最后，相当于缺省值；

4.2 不同粒度配置的覆盖关系

• 越上面优先级越高；
• 精确优先 (方法级优先，接口级次之，全局配置再次之)；
• 消费者设置优先(如果级别一样，则消费方优先，提供方次之)；

4.3 关闭启动检查check

提供者有三种关闭启动检查注册中心的配置：

• Spring配置文件

<!-- 关闭某个服务的启动时检查 (没有提供者时报错) -->
<dubbo:reference interface="com.foo.BarService" check="false" />

<!-- 关闭所有服务的启动时检查 (没有提供者时报错) -->
<dubbo:consumer check="false" />

<!-- 关闭注册中心启动时检查 (注册订阅失败时报错) -->
<dubbo:registry check="false" />

• dubbo.properties

dubbo.reference.com.foo.BarService.check=false
dubbo.reference.check=false
dubbo.consumer.check=false
dubbo.registry.check=false

• 通过 -D 参数

java -Ddubbo.reference.com.foo.BarService.check=false
java -Ddubbo.reference.check=false
java -Ddubbo.consumer.check=false
java -Ddubbo.registry.check=false

消费者有一种关闭启动检查服务提供者的配置：

<dubbo:reference check="false"/>

4.4 超时timeout

提供者：

<!-- 配置超时时间 -->
<dubbo:service interface="com.atguigu.gmall.service.UserService"
	ref="userServiceImpl01" timeout="1000"">
	<dubbo:method name="getUserAddressList" timeout="1000"></dubbo:method>
</dubbo:service>

消费者：

<!-- 配置超时时间 -->
<dubbo:reference interface="com.foo.BarService"
	id="BarService" timeout="5000">
</dubbo:reference>

<!-- 还可以给具体方法配置超时时间(假设BarService里有testMethod方法) -->
<dubbo:reference interface="com.foo.BarService"
	id="BarService" timeout="5000">
	<dubbo:method name="testMethod" timeout="2000"></dubbo:method>
</dubbo:reference>

可以体现：

• 精确优先 (方法级优先，接口级次之，全局配置再次之)；
• 消费者设置优先(如果级别一样，则消费方优先，提供方次之)；

4.5 重试次数retries

消费者：

<!-- retries="":重试次数，不包含第一次调用，0代表不重试-->
<!-- 幂等（设置重试次数）【查询、删除、修改】、非幂等（不能设置重试次数）【新增】 -->
<dubbo:reference interface="com.foo.BarService"
	id="BarService" timeout="5000" retries="3" >
</dubbo:reference>

4.6 多版本version

提供者：

<!-- 1.0.0版本-->
<dubbo:service interface="com.atguigu.gmall.service.UserService"
	ref="userServiceImpl01" timeout="1000" version="1.0.0">
	<dubbo:method name="getUserAddressList" timeout="1000"></dubbo:method>
</dubbo:service>
<!-- 服务的实现 -->
<bean id="userServiceImpl01" class="com.atguigu.gmall.service.impl.UserServiceImpl"></bean>

<!-- 2.0.0版本-->
<dubbo:service interface="com.atguigu.gmall.service.UserService"
	ref="userServiceImpl02" timeout="1000" version="2.0.0">
	<dubbo:method name="getUserAddressList" timeout="1000"></dubbo:method>
</dubbo:service>
<bean id="userServiceImpl02" class="com.atguigu.gmall.service.impl.UserServiceImpl2"></bean>

消费者：

<!-- version指定用哪个版本，*表示随机版本-->
<dubbo:reference interface="com.atguigu.gmall.service.UserService"
	id="userService" timeout="5000" retries="3" version="*">
	<!-- <dubbo:method name="getUserAddressList" timeout="1000"></dubbo:method> -->
</dubbo:reference>

4.7 本地存根stub

提供者：

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;
	}
}

消费者：

<!--  配置本地存根-->
<dubbo:reference interface="com.atguigu.gmall.service.UserService"
	id="userService" timeout="5000" retries="3" version="*" stub="com.*.UserServiceStub">
</dubbo:reference>

4.8 SpringBoot与Dubbo整合的三种方式

1. 导入dubbo-starter；在application.properties配置属性；使用@Service暴露服务；使用@Reference引用服务；
2. 保留dubbo xml配置文件；导入dubbo-starter；使用@ImportResource导入dubbo的配置文件即可；
   • 在主启动类上@ImportResource(locations="classpath:provider.xml")；
3. 使用注解API的方式；将每一个组件手动创建到容器中，让dubbo来扫描其他的组件；使用@Service暴露服务；
   • 主启动类上：@EnableDubbo(scanBasePackages="com.atguigu.gmall")；
   • 在config包下进行如下配置：

@Configuration
public class MyDubboConfig {

	@Bean
	public ApplicationConfig applicationConfig() {
		ApplicationConfig applicationConfig = new ApplicationConfig();
		applicationConfig.setName("boot-user-service-provider");
		return applicationConfig;
	}

	//<dubbo:registry protocol="zookeeper" address="127.0.0.1:2181"></dubbo:registry>
	@Bean
	public RegistryConfig registryConfig() {
		RegistryConfig registryConfig = new RegistryConfig();
		registryConfig.setProtocol("zookeeper");
		registryConfig.setAddress("127.0.0.1:2181");
		return registryConfig;
	}

	//<dubbo:protocol name="dubbo" port="20882"></dubbo:protocol>
	@Bean
	public ProtocolConfig protocolConfig() {
		ProtocolConfig protocolConfig = new ProtocolConfig();
		protocolConfig.setName("dubbo");
		protocolConfig.setPort(20882);
		return protocolConfig;
	}

	/**
	 *<dubbo:service interface="com.atguigu.gmall.service.UserService"
		ref="userServiceImpl01" timeout="1000" version="1.0.0">
		<dubbo:method name="getUserAddressList" timeout="1000"></dubbo:method>
	</dubbo:service>
	 */
	@Bean
	public ServiceConfig<UserService> userServiceConfig(UserService userService){
		ServiceConfig<UserService> serviceConfig = new ServiceConfig<>();
		serviceConfig.setInterface(UserService.class);
		serviceConfig.setRef(userService);
		serviceConfig.setVersion("1.0.0");

		//配置每一个method的信息
		MethodConfig methodConfig = new MethodConfig();
		methodConfig.setName("getUserAddressList");
		methodConfig.setTimeout(1000);

		//将method的设置关联到service配置中
		List<MethodConfig> methods = new ArrayList<>();
		methods.add(methodConfig);
		serviceConfig.setMethods(methods);

		//ProviderConfig
		//MonitorConfig
		return serviceConfig;
	}

}

---

最后

新人制作，如有错误，欢迎指出，感激不尽！
欢迎关注公众号，会分享一些更日常的东西！
如需转载，请标注出处！