在spring boot中3分钟上手RPC框架Dubbo

桃扇骨 2022-10-01 08:42 208阅读 0赞

官方提供的demo太多，内容也很详细，资料也多，导致不易快速上手，以下是我根据官方文档整理出来的快速上手步骤

首先rpc调用都需要有注册中心，zookeeper, nacos，redis等都可以拿来作为注册中心 这里为了演示方便我们还是拿经典的zookeeper做演示

完整代码已上传github：[github.com/neatlife/my…][github.com_neatlife_my] 下载后启动zookeeper即可运行

### 获取一个可用的zookeeper实例 ###

可以使用docker启动zookeeper，比如 docker-compose-single.yml

version: '3.1'
    
    services:
        zoo:
            image: 31z4/zookeeper
            restart: always
            hostname: zoo1
            ports:
                - 2181:2181
    复制代码

然后执行`docker-compose -f docker-compose-single.yml up -d`命令启动zookeeper实例

执行 lsof -i :2181 查看效果

可以看到zookeeper已经在2181端口进行监听了

### 规划模块 ###

一个rpc服务至少需要以下4个模块组成

<table> 
 <thead> 
  <tr> 
   <th>模块名</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>my-api</td> 
   <td>给my-provider和my-consumer<br>提供统一的接口和数据传输dto</td> 
  </tr> 
  <tr> 
   <td>my-provider</td> 
   <td>服务提供方</td> 
  </tr> 
  <tr> 
   <td>my-consumer</td> 
   <td>服务消费方</td> 
  </tr> 
  <tr> 
   <td>my-dubbo-spring-boot</td> 
   <td>项目外层模块，组织以上3个模块<br>非必须，可以提供一些子模块可以复用的依赖，属性等</td> 
  </tr> 
 </tbody> 
</table>

在idea中创建项目my-dubbo-spring-boot和三个子模块，都使用maven来管理依赖

my-provider和my-consumer都要依赖dubbo库

<dependency>
        <groupId>org.apache.dubbo</groupId>
        <artifactId>dubbo-spring-boot-starter</artifactId>
        <version>2.7.1</version>
    </dependency>
    
    <dependency>
        <groupId>org.apache.dubbo</groupId>
        <artifactId>dubbo</artifactId>
    </dependency>
    复制代码

my-api提供通用依赖，所以不需要任何依赖 因为是spring boot项目，所以spring boot依赖肯定是有的，完整依赖可以去github查看源代码

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    复制代码

### 编写消费者和服务提供者的接口 ###

在模块my-api中创建服务接口DemoService，代码如下

package com.demo.consumer;
    
    /** * Demo Service interface * * @since 2.7.0 */
    public interface DemoService {
    
        String sayHello(String name);
    
    }
    复制代码

这个就是服务提供者需要提供的服务

然后在my-consumer和my-provider模块中都依赖这个my-api模块，代码如下：

<dependency>
        <groupId>com.demo</groupId>
        <artifactId>my-api</artifactId>
        <version>2.7.1</version>
    </dependency>
    复制代码

### 编写服务提供者 ###

在my-provider里实现DemoService，核心代码如下

@Service(version = "${demo.service.version}")
    public class DefaultDemoService implements DemoService {
    
        /** * The default value of ${dubbo.application.name} is ${spring.application.name} */
        @Value("${dubbo.application.name}")
        private String serviceName;
    
        @Override
        public String sayHello(String name) {
            return String.format("[%s] : Hello, %s", serviceName, name);
        }
    }
    复制代码

然后在项目配置文件声明服务提供者的名字等配置，核心配置如下

# Spring boot application
    spring.application.name=my-provider
    # Base packages to scan Dubbo Component: @org.apache.dubbo.config.annotation.Service
    dubbo.scan.base-packages=com.demo.provider
    
    # Dubbo Application
    ## The default value of dubbo.application.name is ${spring.application.name}
    ## dubbo.application.name=${spring.application.name}
    
    # Dubbo Protocol
    dubbo.protocol.name=dubbo
    ## Random port
    dubbo.protocol.port=-1
    
    ## Dubbo Registry
    dubbo.registry.address=zookeeper://127.0.0.1:2181
    dubbo.registry.file = ${user.home}/dubbo-cache/${spring.application.name}/dubbo.cache
    
    ## DemoService version
    demo.service.version=1.0.0
    复制代码

然后启动服务者，查看控制台输出效果

### 编写服务消费者 ###

在my-consumer里调用DemoService，核心代码如下

@EnableAutoConfiguration
    public class MyConsumerApplication {
    
        private final Logger log = LoggerFactory.getLogger(getClass());
    
        @Reference(version = "${demo.service.version}")
        private DemoService demoService;
    
        public static void main(String[] args) {
            SpringApplication.run(MyConsumerApplication.class).close();
        }
    
        @Bean
        public ApplicationRunner runner() {
            return args -> log.error(demoService.sayHello("World"));
        }
    }
    复制代码

为了看到明显的输出效果，这里使用了log.error

启动项目，查看调用效果

可以看到输出里带了服务提供者加上的字符串 Hello

### 一些注意的点 ###

my-api 模块作为dubbo消费者和服务提供者的通用依赖，可以提供通用的服务接口，服务输入，输出dto等

spring boot dubbo官方有提供一个内置的zookeeper，参考：[EmbeddedZooKeeper.java][]，作者认为一般不会用这种方式启动zookeeper，所以使用docker启动了一个zookeeper，可以自行选择

看到最后了，点个关注再走呗 `_(:з」∠)_`

可以加作者微信一起研究dubbo的使用和原理

转载于:https://juejin.im/post/5cc6dd1b6fb9a032514bb90f

[github.com_neatlife_my]: https://link.juejin.im?target=https%3A%2F%2Fgithub.com%2Fneatlife%2Fmy-dubbo-spring-boot
[EmbeddedZooKeeper.java]: https://link.juejin.im?target=https%3A%2F%2Fgithub.com%2Fapache%2Fincubator-dubbo-spring-boot-project%2Fblob%2Fmaster%2Fdubbo-spring-boot-samples%2Fdubbo-registry-zookeeper-samples%2Fprovider-sample%2Fsrc%2Fmain%2Fjava%2Forg%2Fapache%2Fdubbo%2Fspring%2Fboot%2Fdemo%2Fprovider%2Fbootstrap%2FEmbeddedZooKeeper.java