Spring Boot 集成 Dubbo

　　此系列文章将会描述Java框架Spring Boot、服务治理框架Dubbo、应用容器引擎Docker，及使用Spring Boot集成Dubbo、Mybatis等开源框架，其中穿插着Spring Boot中日志切面等技术的实现，然后通过gitlab-CI以持续集成为Docker镜像。

　　本文为此Spring Boot通过使用起步依赖dubbo-spring-boot-starter及自动装配的方式集成Dubbo。

本系列文章中所使用的框架版本为Spring Boot 2.0.3-RELEASE，Spring 5.0.7-RELEASE，Dubbo 2.6.2。

Spring Boot

　　Spring Boot旨在让开发人员使用最少的配置，尽可能快地着手开发并运行一个应用。Spring Boot框架从本质上来说就是Spring，但通过自动配置和起步依赖的方式将开发人员从繁重的配置中解放出来，专注于业务逻辑的实现。Spring Boot 的特性见微服务框架（一）Spring Boot + Dubbo + Docker 框架特性简述

Profile运行环境配置

　　Spring Boot简化了开发人员需要的模板配置，因此我们只需要引入application.properties/application.yml即可。

在多环境配置下常使用application.properties只配置spring.profiles.active属性，以起选择对应环境的配置文件的作用

如上中，application.properties只需要配置spring.profiles.active = dev来选择配置文件，Spring Boot会自动加载config包下application-dev.properties的配置

在运行jar包或docker镜像时只需要设置spring.profiles.active运行变量

1
2
jar: `java -jar provider.jar --spring.profiles.active=dev`
docker: `-e "SPEING_PROFILES_ACTIVE=dev"`

Dubbo

Dubbo是一个由阿里巴巴开源的高性能、基于Java的RPC框架。与许多RPC系统一样，dubbo基于定义服务的思想，指定可以使用其参数和返回类型来远程调用的方法。在服务器端，Provider实现此接口并运行dubbo服务器来处理客户端调用。在客户端，Customer有一个提供与服务器相同的方法的存根。

　　Dubbo Spring Boot 项目致力于简化 Dubbo RPC 框架在 Spring Boot 应用场景的开发。同时也整合了 Spring Boot 自动装配及生产就绪的特性。

依赖引入及接口定义

Maven中引入dubbo-spring-boot-starter的起步依赖至pom.xml

1
2
3
4
5
<dependency>
    <groupId>com.alibaba.boot</groupId>
    <artifactId>dubbo-spring-boot-starter</artifactId>
    <version>0.2.0</version>
</dependency>

依赖关系：

Dubbo RPC API:

1
2
3
public interface DemoService {
	String saySomething(String word);
}

Dubbo Provider

1.编写Spring Boot启动类

Dubbo的服务容器是一个 standalone 的启动程序，不需要Web容器

1
2
3
4
5
6
7
8
9
@SpringBootApplication
public class Starter {

	public static void main(String[] args) {
		new SpringApplicationBuilder(Starter.class)
			.web(WebApplicationType.NONE) // 非 Web 应用
			.run(args);
	}
}

2.实现DemoService接口

1
2
3
4
5
6
7
8
9
@Service(version = "${demo.service.version}")
public class DemoServiceImpl implements DemoService {

	@Override
	public String saySomething(String word) {
		return StringUtils.isNotEmpty(word) ? word : "Say you won't let go";
	}

}

3.spring boot配置文件

Spring Boot的自动装配及起步依赖使开发人员只需配置文件，而无需重复使用模板定义

application.properties/application.yml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# Spring boot application
spring.application.name = dubbo-provider-demo
server.port = 9090

# Service version
demo.service.version = 1.0.0

# Base packages to scan Dubbo Components (e.g @Service , @Reference)
dubbo.scan.basePackages  = org.spring.boot.dubbo.provider

# Dubbo Config properties
## ApplicationConfig Bean
dubbo.application.id = dubbo-provider-demo
dubbo.application.name = dubbo-provider-demo

## ProtocolConfig Bean
dubbo.protocol.id = dubbo
dubbo.protocol.name = dubbo
dubbo.protocol.port = 9900

## RegistryConfig Bean
dubbo.registry.id = my-registry
dubbo.registry.address = zookeeper://127.0.0.1:2181

注：启动消费者时需启动对应的注册中心，否则服务会启动失败

Dubbo Customer

使用Spring Boot框架构建Web应用时需引入spring-boot-starter-web的起步依赖

1
2
3
4
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>

1.编写Spring Boot启动类（Web应用）

1
2
3
4
5
6
7
8
@SpringBootApplication(scanBasePackages = "org.spring.boot.dubbo.consumer.controller")
public class Starter {

	public static void main(String[] args) {
		new SpringApplicationBuilder(Starter.class)
			.web(WebApplicationType.SERVLET).run(args);
	}
}

2.通过 @Reference 注入 DemoService

下述配置中消费者为直连生产者，未经过注册中心（@Reference中url参数若已配置则直连对应生产者，若未配置则经过配置文件中dubbo.registry.address参数连接注册中心，获取相应的生产者信息）

1
2
3
4
5
6
7
8
9
10
11
12
@RestController
public class DemoController {

	@Reference(version = "${demo.service.version}", 
				url = "dubbo://localhost:9900")
	private DemoService demoService;

	@RequestMapping("/saySomething")
	public String sayHello(@RequestParam String name) {
		return demoService.saySomething(name);
	}
}

3.spring boot配置文件

Spring Boot的自动装配及起步依赖使开发人员只需配置文件，而无需重复使用模板定义

application.properties/application.yml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# Spring boot application
spring.application.name = dubbo-consumer-demo
server.port = 9090

# Service version
demo.service.version = 1.0.0

# Base packages to scan Dubbo Components (e.g @Service , @Reference)
dubbo.scan.basePackages  = org.spring.boot.dubbo.consumer.controller

# Dubbo Config properties
## ApplicationConfig Bean
dubbo.application.id = dubbo-consumer-demo
dubbo.application.name = dubbo-consumer-demo

## ProtocolConfig Bean
dubbo.protocol.id = dubbo
dubbo.protocol.name = dubbo
dubbo.protocol.port = 9901

## RegistryConfig Bean
dubbo.registry.id = my-registry
dubbo.registry.address = zookeeper://localhost:2181

参考资料：

1. Dubbo Spring Boot官方文档

• Previous
  Spring Boot + Dubbo + Docker 框架特性简述
• Next
  Dubbo性能调优配置