dubbo實戰之三:使用Zookeeper註冊中心

歡迎訪問我的GitHub

https://github.com/zq2599/blog_demos

內容:所有原創文章分類彙總及配套源碼,涉及Java、Docker、Kubernetes、DevOPS等;

《dubbo實戰》系列導航

  1. 準備和初體驗
  2. 與SpringBoot集成
  3. 使用Zookeeper註冊中心
  4. 管理控制檯dubbo-admin

本篇概覽

  • 本文是《dubbo實戰》系列的第三篇,主要內容是使用Zookeeper作爲註冊中心的實戰;
  • 前面兩篇的實戰都是使用了廣播模式,整個環境由服務提供者和服務消費者組成,這種簡單形態只是爲了方便學習,實際上多數情況都會部署註冊中心,服務提供者在上面註冊,服務消費者再從註冊中心得到具體的服務信息;
  • 下面是個典型的提供者、消費者、註冊中心的典型架構圖:

在這裏插入圖片描述

  • 如下圖所示,dubbo官方推薦的註冊中心是<font color="blue">Zookeeper</font>:

在這裏插入圖片描述

關於Zookeeper

  1. 本次使用了單節點Zookeeper,版本<font color="red">3.4.13</font>,IP<font color="blue">192.168.50.43</font>,端口<font color="blue">2181</font>
  2. 關於Zookeeper的部署,我這邊是通過docker快速部署的,參考文章《羣暉DS218+部署kafka》
  • 如果您部署好了Zookeeper,接下來開始編寫服務提供者和消費者的代碼;

源碼下載

  1. 如果您不想編碼,可以在GitHub下載所有源碼,地址和鏈接信息如下表所示:
名稱 鏈接 備註
項目主頁 https://github.com/zq2599/blog_demos 該項目在GitHub上的主頁
git倉庫地址(https) https://github.com/zq2599/blog_demos.git 該項目源碼的倉庫地址,https協議
git倉庫地址(ssh) [email protected]:zq2599/blog_demos.git 該項目源碼的倉庫地址,ssh協議
  1. 這個git項目中有多個文件夾,本章的應用在<font color="blue">dubbopractice</font>文件夾下,如下圖紅框所示:

在這裏插入圖片描述 3. <font color="blue">dubbopractice</font>是父子結構的工程,本篇的代碼在<font color="red">springbootzkprovider</font>和<font color="red">springbootzkconsumer</font>這兩個子工程中,如下圖:

在這裏插入圖片描述

編碼(服務提供方)

  • 先創建提供服務的工程<font color="blue">springbootmulticastprovider</font>,一共要創建4個文件,創建順序和功能如下表:
創建順序 文件名 作用
1 pom.xml 工程的pom文件
2 src/main/resources/application.yml 配置文件
3 DemoServiceImpl.java 提供具體的服務
4 SpringBootZKProviderApplication.java 啓動類
  • 完整的文件位置如下圖:

在這裏插入圖片描述

  • 接下來逐個創建上述內容;
  1. 創建名爲<font color="blue">springbootmulticastprovider</font>的子工程,pom.xml內容如下,要重點關注的是新增依賴<font color="blue">dubbo-spring-boot-starter</font>,這就是dubbo在SpringBoot環境的starter依賴,還有Zookeeper的依賴<font color="blue">dubbo-dependencies-zookeeper</font>:
<?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>dubbopractice</artifactId>
        <groupId>com.bolingcavalry</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.bolingcavalry</groupId>
    <artifactId>springbootzkprovider</artifactId>
    <version>1.0-SNAPSHOT</version>
    <name>springbootzkprovider</name>
    <description>Demo project for dubbo service provider from Spring Boot</description>

    <!--不用spring-boot-starter-parent作爲parent時的配置-->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.3.3.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>com.bolingcavalry</groupId>
            <artifactId>practiceinterface</artifactId>
            <version>${project.version}</version>
        </dependency>
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-dependencies-zookeeper</artifactId>
            <type>pom</type>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-spring-boot-starter</artifactId>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>${springboot.version}</version>
            </plugin>
        </plugins>
    </build>
</project>
  1. 配置文件<font color="blue">application.yml</font>,要注意的是registry.address的值<font color="red">zookeeper://192.168.50.43:2181</font>,這就是Zookeeper註冊中心的配置:
dubbo:
  application:
    #application-name 本模塊名字
    name: springboot-zk-provider
  registry:
    address: zookeeper://192.168.50.43:2181
  protocol:
    name: dubbo
    port: 20880
  1. 編寫服務實現類<font color="blue">DemoServiceImpl.java</font>,注意<font color="red">@Service</font>註解將當前類的實例作爲遠程服務對外暴露:
package com.bolingcavalry.springbootzkprovider;

import com.bolingcavalry.dubbopractice.service.DemoService;
import lombok.extern.slf4j.Slf4j;
import org.apache.dubbo.config.annotation.Service;
import org.apache.dubbo.rpc.RpcContext;

@Slf4j
@Service
public class DemoServiceImpl implements DemoService {
    @Override
    public String sayHello(String name) {
        log.info("I'm springboot-zk-provider, Hello " + name + ", request from consumer: " + RpcContext.getContext().getRemoteAddress());
        try {
            Thread.sleep(1000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        return "I'm springboot-zk-provider, Hello " + name + ", response from provider: " + RpcContext.getContext().getLocalAddress();
    }
}
  1. 編寫SpringBoot啓動類<font color="blue">SpringBootZKProviderApplication.java</font>,注意要添加<font color="red">@EnableDubbo註解</font>:
package com.bolingcavalry.springbootzkprovider;

import org.apache.dubbo.config.spring.context.annotation.EnableDubbo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@EnableDubbo
public class SpringBootZKProviderApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringBootZKProviderApplication.class, args);
    }
}
  1. 至此服務提供方編碼完成,直接在IDEA上運行<font color="blue">SpringBootZKProviderApplication</font>類即可啓動服務,啓動成功後的日誌輸出如下圖,如紅框所示,已連上了Zookeeper:

在這裏插入圖片描述

編碼(服務消費方)

  • 現在網絡上已經有了服務,咱們再來編寫服用消費方的代碼,一共要創建6個文件,創建順序和功能如下表:
創建順序 文件名 作用
1 pom.xml 工程的pom文件
2 src/main/resources/application.yml 配置文件
3 RemoteInvokeServiceImpl.java service層,在這裏遠程調用服務提供方的服務
4 DemoController.java web接口類,對外提供web服務
5 SwaggerConfig.java swagger配置類,便於通過頁面測試接口
6 SpringBootZKConsumerApplication.java 啓動類
  • 完整的文件位置如下圖:

在這裏插入圖片描述

  • 接下來逐個創建上述文件;
  1. 創建名爲<font color="blue">springbootzkconsumer</font>的子工程,pom.xml內容如下,同樣需要依賴<font color="blue">dubbo-spring-boot-starter</font>和<font color="blue">dubbo-dependencies-zookeeper</font>:
<?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>dubbopractice</artifactId>
        <groupId>com.bolingcavalry</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.bolingcavalry</groupId>
    <artifactId>springbootzkconsumer</artifactId>
    <version>1.0-SNAPSHOT</version>
    <name>springbootzkconsumer</name>
    <description>Demo project for dubbo service consumer from Spring Boot</description>

    <!--不用spring-boot-starter-parent作爲parent時的配置-->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.3.3.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- swagger依賴 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
        </dependency>
        <!-- swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
        </dependency>
        <dependency>
            <groupId>com.bolingcavalry</groupId>
            <artifactId>practiceinterface</artifactId>
            <version>${project.version}</version>
        </dependency>
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-dependencies-zookeeper</artifactId>
            <type>pom</type>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-spring-boot-starter</artifactId>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>${springboot.version}</version>
            </plugin>
        </plugins>
    </build>
</project>
  1. 編寫配置文件<font color="blue">application.yml</font>,注意dubbo.registry.address的值:
dubbo:
  application:
    #application-name 本模塊名字
    name: springboot-zk-consumer
  registry:
    address: zookeeper://192.168.50.43:2181
server:
  port: 8081
  1. 編寫調用遠程服務的代碼,如下,可見如果想調用遠程服務,只要對接口做<font color="blue">@Reference</font>註釋即可,另外還通過<font color="red">timeout</font>屬性增加了超時配置:
package com.bolingcavalry.springbootzkconsumer.service;

import com.bolingcavalry.dubbopractice.service.DemoService;
import org.apache.dubbo.config.annotation.Reference;
import org.springframework.stereotype.Service;

@Service
public class RemoteInvokeServiceImpl {

    @Reference(timeout = 2000)
    private DemoService demoService;

    public String sayHello(String name) {
        return "from dubbo remote (zk registry center mode) : " + demoService.sayHello(name);
    }
}
  1. 再編寫對外提供web服務的Controller類:
package com.bolingcavalry.springbootzkconsumer.controller;

import com.bolingcavalry.springbootzkconsumer.service.RemoteInvokeServiceImpl;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/demo")
@Api(tags = {"DemoController"})
public class DemoController {
    @Autowired
    private RemoteInvokeServiceImpl remoteInvokeService;

    @ApiOperation(value = "獲取dubbo service provider的響應", notes="\"獲取dubbo service provider的響應")
    @ApiImplicitParam(name = "name", value = "暱稱", paramType = "path", required = true, dataType = "String")
    @RequestMapping(value = "/{name}", method = RequestMethod.GET)
    public String sayHello(@PathVariable String name){
        return remoteInvokeService.sayHello(name);
    }
}
  1. 還要添加swagger配置類:
package com.bolingcavalry.springbootzkconsumer;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Tag;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .tags(new Tag("DemoController", "演示服務"))
                .select()
                // 當前包路徑
                .apis(RequestHandlerSelectors.basePackage("com.bolingcavalry.springbootzkconsumer.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    //構建 api文檔的詳細信息函數,注意這裏的註解引用的是哪個
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //頁面標題
                .title("dubbo遠程調用服務的操作(zk註冊中心)")
                //創建人
                .contact(new Contact("程序員欣宸", "https://github.com/zq2599/blog_demos", "[email protected]"))
                //版本號
                .version("1.0")
                //描述
                .description("API 描述")
                .build();
    }
}
  1. 最後是啓動類<font color="blue">SpringBootZKConsumerApplication.java</font>:
package com.bolingcavalry.springbootzkconsumer;

import org.apache.dubbo.config.spring.context.annotation.EnableDubbo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@EnableDubbo
public class SpringBootZKConsumerApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringBootZKConsumerApplication.class, args);
    }
}
  1. 至此,服務消費方編碼完成,直接在IDEA上運行<font color="blue">SpringBootZKConsumerApplication</font>類即可啓動,如下圖,可見服務消費方也連接Zookeeper成功:

在這裏插入圖片描述 8. 通過瀏覽器訪問swagger,地址是:http://localhost:8081/swagger-ui.html ,如下圖,點擊紅框位置展開接口詳情:

在這裏插入圖片描述

  1. 如下圖,輸入web接口參數發起請求:

在這裏插入圖片描述 10. 下圖紅框中就是響應的數據,內容是<font color="blue">springbootzkconsumer</font>遠程調用<font color="red">springbootzkprovider</font>的服務得到的:

在這裏插入圖片描述

查看Zookeeper上的數據

  1. 再回顧一下官方的有關Zookeeper註冊中心中數據的描述,如下圖:

在這裏插入圖片描述

  1. 按照上述信息,咱們去Zookeeper看看數據,驗證和上圖是否一致,登錄Zookeeper後執行<font color="blue">zkCli.sh</font>進度交互模式;
  2. 查看根目錄,果然有名爲dubbo的子目錄:
[zk: localhost:2181(CONNECTED) 18] ls /                                                                    
[dubbo, log_dir_event_notification, isr_change_notification, zookeeper, admin, consumers, cluster, config, latest_producer_id_block, controller, brokers, controller_epoch]
  1. 再看dubbo目錄下,有遠程服務的子目錄:
[zk: localhost:2181(CONNECTED) 19] ls /dubbo
[com.bolingcavalry.dubbopractice.service.DemoService, config, metadata]
  1. 查看遠程服務的providers節點,果然有服務提供者的信息:
[zk: localhost:2181(CONNECTED) 16] get /dubbo/com.bolingcavalry.dubbopractice.service.DemoService/providers
169.254.38.208
cZxid = 0x552
ctime = Sat Oct 17 04:05:52 UTC 2020
mZxid = 0x552
mtime = Sat Oct 17 04:05:52 UTC 2020
pZxid = 0x5ec
cversion = 27
dataVersion = 0
aclVersion = 0
ephemeralOwner = 0x0
dataLength = 14
numChildren = 1
  1. 再看看consumer節點的內容:
[zk: localhost:2181(CONNECTED) 17] get /dubbo/com.bolingcavalry.dubbopractice.service.DemoService/consumers
169.254.38.208
cZxid = 0x55f
ctime = Sat Oct 17 04:22:58 UTC 2020
mZxid = 0x55f
mtime = Sat Oct 17 04:22:58 UTC 2020
pZxid = 0x5f0
cversion = 33
dataVersion = 0
aclVersion = 0
ephemeralOwner = 0x0
dataLength = 14
numChildren = 1
  1. 可見Zookeeper上記錄的數據與官方文檔描述的一致;
  • 至此,dubbo與springboot集成的實戰就完成了,希望能給您提供一些參考,助您快速開發dubbo應用;

歡迎關注公衆號:程序員欣宸

微信搜索「程序員欣宸」,我是欣宸,期待與您一同暢遊Java世界...

你不孤單,欣宸原創一路相伴

  1. Java系列
  2. Spring系列
  3. Docker系列
  4. kubernetes系列
  5. 數據庫+中間件系列
  6. DevOps系列

歡迎關注公衆號:程序員欣宸

微信搜索「程序員欣宸」,我是欣宸,期待與您一同暢遊Java世界... https://github.com/zq2599/blog_demos

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章