SpringBoot整合Dubbo2.5.10

SpringBoot整合Dubbo2.5.10,使用官方最新spring-boot-starter

开始

Dubbo已经进入了Apache孵化器,并且发布了官方的spring-boot-starter0.1.0,用于简化dubbo应用的配置,主要包括了autoconfigure(自动装配),externalized-configuration(外部化配置),actuator(生产准备)等,可参考官方github dubbo-spring-boot-starter.

准备工作

需要提前安装好JDK1.8,Maven,Zookeeper。

初始化Maven项目

为了整个项目结构清晰,使用模块化的maven项目。pom文件如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.8.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>

<modelVersion>4.0.0</modelVersion>
<groupId>org.boot.dubbo</groupId>
<artifactId>boot-dubbo</artifactId>
<version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>

<name>boot-dubbo</name>
<description>Dubbo project for Spring Boot</description>

<modules>
<module>dubbo-provider</module>
<module>dubbo-consumer</module>
<module>dubbo-api</module>
</modules>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
<dubbo-spring-boot-starter.version>0.1.0</dubbo-spring-boot-starter.version>
<springboot.version>1.5.8.RELEASE</springboot.version>
<fastjson-version>1.2.31</fastjson-version>
<zk-client.version>0.2</zk-client.version>
<dockerfile-maven.version>1.4.3</dockerfile-maven.version>
</properties>

<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.alibaba.boot</groupId>
<artifactId>dubbo-spring-boot-starter</artifactId>
<version>${dubbo-spring-boot-starter.version}</version>
</dependency>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
<version>${springboot.version}</version>
</dependency>

<dependency>
<groupId>com.101tec</groupId>
<artifactId>zkclient</artifactId>
<version>${zk-client.version}</version>
</dependency>
</dependencies>
</dependencyManagement>

</project>

主要分为三个模块,api,provider和consumer

创建生产者

有了spring-boot-starter,dubbo的配置变得非常简单,再也不用像以前一样配置一大堆xml文件,只需要几个简单的配置,就可以做到开箱即用。

  1. 先配置生产者的pom.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.boot.dubbo</groupId>
<artifactId>dubbo-provider</artifactId>
<version>${parent.version}</version>
<packaging>jar</packaging>

<parent>
<artifactId>boot-dubbo</artifactId>
<groupId>org.boot.dubbo</groupId>
<version>1.0.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>

<name>dubbo-provider</name>
<description>Dubbo project for Spring Boot:Provider</description>

<dependencies>
<!-- Spring Boot dependencies -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-actuator</artifactId>
</dependency>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</dependency>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
</dependency>

<dependency>
<groupId>com.alibaba.boot</groupId>
<artifactId>dubbo-spring-boot-starter</artifactId>
<exclusions>
<exclusion>
<artifactId>zookeeper</artifactId>
<groupId>org.apache.zookeeper</groupId>
</exclusion>
</exclusions>
</dependency>

<dependency>
<groupId>com.101tec</groupId>
<artifactId>zkclient</artifactId>
</dependency>

<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>

<dependency>
<groupId>org.boot.dubbo</groupId>
<artifactId>dubbo-api</artifactId>
<version>${parent.version}</version>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
  1. 接着使用properties进行SpringBoot和Dubbo的配置,配置如下:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    spring.application.name=springboot-dubbo-provider
    server.port=9090
    #dubbo配置
    dubbo.application.id=springboot-dubbo-provider
    dubbo.application.name=springboot-dubbo-provider
    dubbo.application.owner=luoliang
    #协议配置
    dubbo.protocol.id=dubbo
    dubbo.protocol.name=dubbo
    #把默认的20880端口换成12345
    dubbo.protocol.port=12345
    #服务注册配置
    dubbo.registry.id=my-registry
    dubbo.registry.address=zookeeper://localhost:2181
    #配置dubbo的包扫描,针对dubbo的@Service, @Reference注解
    dubbo.scan.base-packages=org.boot.dubbo.provider.service
    #dubbo健康监控
    endpoints.dubbo.enabled=true
    management.health.dubbo.status.defaults=memory
    management.health.dubbo.status.extras=load,threadpool
    management.port=9091
    1. 进行了上面两步之后,Dubbo已经集成好了,接下来就可以直接开始撸服务代码了,可以直接使用注解来暴露服务接口
  • 先在api中写一个interface

    1
    2
    3
    public interface HelloService {
    String sayHello(String name);
    }
  • 实现接口,加上自己的业务逻辑

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    @Service(version = "1.0.0",
    application = "${dubbo.application.id}",
    protocol = "${dubbo.protocol.id}",
    registry = "${dubbo.registry.id}")
    public class HelloServiceImpl implements HelloService {

    @Override
    public String sayHello(String name) {
    return "Hello, " + name + " (from Spring Boot)";
    }
    }

注意,这里的service注解是com.alibaba.dubbo.config.annotation.Service

创建消费者

  1. 配置消费者者的pom.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.boot.dubbo</groupId>
<artifactId>dubbo-consumer</artifactId>
<version>${parent.version}</version>
<packaging>jar</packaging>

<parent>
<artifactId>boot-dubbo</artifactId>
<groupId>org.boot.dubbo</groupId>
<version>1.0.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>

<name>dubbo-consumer</name>
<description>Dubbo project for Spring Boot:Consumer</description>

<dependencies>
<!-- Spring Boot dependencies -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-actuator</artifactId>
</dependency>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
</dependency>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</dependency>

<dependency>
<groupId>com.alibaba.boot</groupId>
<artifactId>dubbo-spring-boot-starter</artifactId>
</dependency>

<dependency>
<groupId>com.101tec</groupId>
<artifactId>zkclient</artifactId>
</dependency>

<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>

<dependency>
<groupId>org.boot.dubbo</groupId>
<artifactId>dubbo-api</artifactId>
<version>${parent.version}</version>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
  1. application.properties配置如下:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    spring.application.name=springboot-dubbo-consumer
    server.port=8081
    #dubbo配置
    dubbo.application.id=springboot-dubbo-consumer
    dubbo.application.name=springboot-dubbo-consumer
    dubbo.application.owner=luoliang
    #服务注册配置
    dubbo.registry.id=my-registry
    dubbo.registry.address=zookeeper://localhost:2181
    management.port=8082
  2. 编写service来消费dubbo的服务,主要代码如下:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    @Service
    public class ConsumerServiceImpl implements ConsumerService {
    @Reference(version = "1.0.0",
    application = "${dubbo.application.id}")
    private HelloService helloService;

    @Override
    public String sayHello(String name) {
    return helloService.sayHello(name);
    }
    }

    在mvc的controller中注入此服务

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    @RestController
    @RequestMapping("/user")
    public class DefaultController {
    @Resource
    private ConsumerService consumerService;

    @RequestMapping("/sayHello")
    public String register(String name) {
    return consumerService.sayHello(name);
    }
    }
到这里,整个项目基本结构已经搭建完成,consumer已经能够消费provider提供的服务。

现在来测试一下,分别启动provider和consumer,打开浏览器,输入http://localhost:8081/user/sayHello?name=dubbo

可以看到,返回的结果和预期一样,说明项目已经成功集成

需要源码请移步本人github,如果能顺手star就更好啦! boot-dubbo下一篇博客接这篇博客,学习使用Docker容器化SpringBoot+Dubbo应用。

参考