天天看點

微服務架構 | 12.1 使用 Apache Dubbo 實作遠端通信

目錄

  • 前言
  • 1. Dubbo 基礎知識
    • 1.1 Dubbo 是什麼
    • 1.2 Dubbo 的架構圖
    • 1.3 Spring Cloud 與 Dubbo 的差別
    • 1.4 Dubbo 的特點
    • 1.5 Dubbo 的 6 種容錯模式
    • 1.6 Dubbo 的 4 種負載均衡政策
    • 1.7 主機綁定規則
  • 2. 建構 Dubbo 服務提供方
    • 2.1 建構服務接口子產品
    • 2.2 添加 pom.xml 依賴檔案
    • 2.3 修改 application.yml 配置檔案
    • 2.4 在主程式類上添加注解
    • 2.5 實作 2.1 定義的接口
  • 3. 建構 Dubbo 服務消費方
    • 3.1 添加 pom.xml 依賴檔案
    • 3.2 修改 application.yml 配置檔案
    • 3.3 修改業務類
  • 4. 在消費者端使用 Mock 配置實作服務降級
    • 4.1 為接口實作一種服務降級方法
    • 4.2 給 @Reference 注解增加 mock 參數
  • 5. Dubbo 使用 Zookeeper 作為注冊中心(Spring Boot)
    • 5.1 下載下傳 Zookeeper 伺服器
    • 5.2 引入 pom.xml 依賴檔案
    • 5.3 服務提供者
      • 5.3.1 修改 application.yml 配置檔案
      • 5.3.2 在主程式類上添加注解
      • 5.3.3 編寫業務類
    • 5.4 服務消費者
      • 5.4.1 修改 application.yml 配置檔案
      • 5.4.2 在主程式類上添加注解
      • 5.4.3 編寫業務類
  • 6. Dubbo 使用 Nacos 作為注冊中心(Spring Boot)
    • 6.1 下載下傳 Nacos 伺服器
    • 6.2 工程結構
    • 6.3 引入 pom.xml 依賴檔案
    • 6.4 修改 application.yml 配置檔案
    • 6.5 在主程式類上添加注解
    • 6.6 編寫業務類
    • 6.7 啟動測試
  • 7. Dubbo 使用 Nacos 作為注冊中心(Spring Cloud)
    • 7.1 下載下傳 Nacos 伺服器
    • 7.2 工程結構
    • 7.3 添加 pom.xml 依賴
    • 7.4 添加 application.yml 依賴檔案
    • 7.5 主程式類上無需額外注解
    • 7.6 編寫業務類
  • 最後

參考資料:

《Spring Microservices in Action》

《Spring Cloud Alibaba 微服務原理與實戰》

《B站 尚矽谷 SpringCloud 架構開發教程 周陽》

Apache Dubbo 是一個分布式服務架構,主要實作多個系統之間的高性能、透明化調用;

Dubbo 相關内容筆者之前寫過一篇入門筆記:Dubbo快速上手筆記 - 環境與配置。入門筆記強調的是 Dubbo 的一些基本特性,以與 Zookeeper 的整合。是以這裡将重點放在 Dubbo 與 Spring Cloud 的聯系、差別以及整合;

  • 簡單來說它就是一個 RPC 架構,但是和普通的 RPC 架構不同的是,它提供了服務治理功能,比如服務注冊、監控、路由、容錯等;

微服務架構 | 12.1 使用 Apache Dubbo 實作遠端通信

  • 參考:https://segmentfault.com/a/1190000038320266
比較項 Dubbo Spring Cloud
通信協定 基于 TCP 協定傳輸,使用 Netty 配合以Hession序列化完成RPC通信 基于 HTTP 協定 + REST 接口調用遠端過程的通信
服務調用方式 RPC REST API
定位 SOA 時代的産物 微服務架構時代
關注點 服務的重用性及解決資訊孤島問題;服務治理 解耦,降低業務之間的耦合度;微服務治理整套方案
子產品 服務注冊中心、服務提供者、服務消費者、管控中心 分布式一站式架構
  • HTTP 請求會有更大的封包,占的帶寬也會更多。但是 REST 相比 RPC 更為靈活,服務提供方和調用方的依賴隻依靠一紙契約,不存在代碼級别的強依賴,這在強調快速演化的微服務環境下,顯得更為合适;
  • 子產品元件的具體比較如下:
元件 Spring Cloud (Netflix)
注冊中心 以前是 Zookeeper,現在推廣 Nacos Spring Cloud Eureka
服務監控 Dubbo-monitor Spring Boot Admin
熔斷器 6種容錯模式 Spring Cloud Hystrix
負載均衡 4 種負載均衡政策 Spring Cloud Ribbon
服務降級 Mock 機制 Hystrix 的 @HystrixCommand 注解
網關 Spring Cloud Zuul
配置 Spring Cloud Config
服務跟蹤 Spring Cloud Sleuth
資料流 Spring Cloud Stream
批量任務 Spring Cloud Task
消息總線 Spring Cloud Bus

  • 支援多種協定的服務釋出,預設是 dubbo://,還可以支援 rest://、webservice://、thrift:// 等;
  • 支援多種不同的注冊中心,如:Nacos、ZooKeeper、Redis,未來還将會支援 Consul、Eureka、Etcd 等;
  • 支援多種序列化技術,如:avro、fst、fastjson、hessian2、kryo 等;
  • 在服務治理方面的功能非常完善,如:叢集容錯、服務路由、負載均衡、服務降級、服務限流、服務監控、安全驗證等;
  • 中文文檔;

容錯模式 模式名稱 說明 适用場景
Failover Cluster 【預設】失敗自動切換 當服務調用失敗後,會切換到叢集中的其他機器進行重試,預設重試次數為2,通過屬性 retries=2 可以修改次數 通常用于讀操作(查),因為事務型操作會帶來資料重複問題
Failfast Cluster 快速失敗 當服務調用失敗後,立即報錯,也就是隻發起一次調用 通常用于一些幂等的寫操作(增删改),比如新增資料;以避免在結果不确定的情況下導緻資料重複插入的問題
Failsafe Cluster 失敗安全 出現異常時,直接忽略異常 使用 Failover Cluster(retries="0"),應對(增删改)操作
Failback Cluster 失敗後自動回複 服務調用出現異常時,在背景記錄這條失敗的請求定時重發 适合用于消息通知操作,保證這個請求一定發送成功
Forking Cluster 并行送出 并行調用叢集中的多個服務,隻要其中一個成功就傳回。可以通過forks=2來設定最大并行數
Broadcast Cluster 廣播通知 廣播調用所有的服務提供者,任意一個服務報錯則表示服務調用失敗 通常用于通知所有的服務提供者更新緩存或者本地資源資訊
  • 可以自行擴充容錯模式;
  • 配置也很簡單,在 @Service 接口裡添加一個

    cluster

    參數即可;
    @Service(cluster = "failfast") //更改容錯方式為快速失敗
    public class TestServiceImpl implements TestService {
    	@Override
    	public String test() {
    	    ...
    	}
    }
               

負載均衡政策 政策名稱
Random LoadBalance 随機算法 可以針對性能較好的伺服器設定較大的權重值,權重值越大,随機的機率也會越大
RoundRobin LoadBalance 輪詢 按照公約後的權重設定輪詢比例
LeastActive LoadBalance 最少活躍調用 處理較慢的節點将會收到更少的請求
ConsistentHash LoadBalance 一緻性Hash 相同參數的請求總是發送到同一個服務提供者
  • 可以基于 Dubbo 中的 SPI 機制來擴充負載均衡政策;
  • loadbalance

    @Service(loadbalance = "roundrobin") //更改負載均衡政策為輪詢
    public class TestServiceImpl implements TestService {
    	@Override
    	public String test() {
    	    ...
    	}
    }
               

  • 主機綁定表示的是 Dubbo 服務對外釋出的 IP 位址,預設情況下 Dubbo 會按照以下順序來查找并綁定主機 IP 位址:
    • 查找環境變量中

      DUBBO_IP_TO_BIND

      屬性配置的 IP 位址;
    • 查找

      dubbo.protocol.host

      屬性配置的 IP 位址,預設是空,如果沒有配置或者IP位址不合法,則繼續往下查找;
    • 通過

      LocalHost.getHostAddress

      擷取本機 IP 位址,如果擷取失敗,則繼續往下查找;
    • 如果配置了注冊中心的位址,則使用 Socket 通信連接配接到注冊中心的位址後,使用 for 循環通過

      socket.getLocalAddress().getHostAddress()

      掃描各個網卡擷取網卡 IP 位址;
  • 擷取的 IP 位址并不是寫入注冊中心的位址。預設情況下,寫入注冊中心的 IP 位址優先選擇環境變量中

    DUBBO_IP_TO_REGISTRY

    屬性配置的 IP 位址。在這個屬性沒有配置的情況下,才會選取前面獲得的 IP 位址并寫入注冊中心;
  • 問題:使用預設的主機綁定規則,可能會存在擷取的 P 位址不正确的情況;
    • 原因:Dubbo 檢測本地 IP 位址的政策是先調用

      LocalHost.getHostAddress

      ,這個方法的原理是通過擷取本機的 hostname 映射 IP 位址,如果它指向的是一個錯誤的 IP 位址,那麼這個錯誤的位址将會作為服務釋出的位址注冊到 ZooKeeper 節點上;
    • 解決方案:
      • /etc/hosts

        中配置機器名對應正确的 IP 位址映射;
      • 在環境變量中添加

        DUBBO_IP_TO_BIND

        或者

        DUBBO_IP_TO_REGISTRY

        屬性,Value 值為綁定的主機位址;
      • dubbo.protocolhost

        設定主機位址;

  • 同樣,這裡使用 Zookeeper,就需要先下載下傳 Zookeeper 伺服器:詳情請見筆者的另一篇文章:微服務架構 | 3.3 Apache Zookeeper 注冊中心;

  • Dubbo 官方推薦把服務接口打成 Jar 包釋出到倉庫上;
  • 這樣服務消費者可以依賴該 Jar 包,通過接口調用方式完成遠端通信。對于服務提供者來說,也需要依賴該 Jar 包完成接口的實作;
  • 做法如下:
  • 建立

    spring-cloud-dubbo-sample-api

    子產品,添加 pom.xml 依賴檔案;
    <!-- Dubbo -->
    <dependency>
        <groupId>org.apache.dubbo</groupId>
        <artifactId>dubbo</artifactId>
        <version>${dubbo.version}</version>
    </dependency>
               
  • 在 service 包下建立接口:
    public interface TestService {
    	String test(String message);
    }
               
  • 執行

    mvn install

    指令将接口 jar 包安裝到本地倉庫;

<!-- Spring Cloud 核心包-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter</artifactId>
</dependency>

<!-- Dubbo Spring Cloud Starter -->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-dubbo</artifactId>
</dependency>

<!-- Sample API 接口聲明-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-dubbo-sample-api</artifactId>
</dependency>

<!-- Spring Cloud Nacos Service Discovery -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-zookeeper-discovery</artifactId>
</dependency>
           

spring:
  application:
    name: spring-cloud-dubbo-provider
  cloud:
    zookeeper:
      discovery:
        register: true  #表示該服務要注冊進注冊中心
      connect-string: localhost:2181  #zookeeper 伺服器位置
dubbo:     
  protocol:
    name: dubbo
    port: 20880
           

  • @DubboComponentScan:掃描主程式類所在包及其子包下的所有注解,将

    @Servicr

    注解下類注冊進容器裡;

@Service
public class TestServiceImpl implements TestService {
    @Value("${dubbo.application.name}")
    private String serviceName;
    
	@Override
	public String test(String message) {
		return serviceName;
	}
}
           
  • 可以在 @Service 注解裡添加兩個屬性配置

    cluster

    loadbalance

    ,分别用來配置容錯模式和負載均衡政策;
  • 詳情請見本篇《1.5 Dubbo 的 6 種容錯模式》和《1.6 Dubbo 的 4 種負載均衡政策》

  • 同服務提供方;
<!-- Spring Cloud 核心包-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter</artifactId>
</dependency>

<!-- Dubbo Spring Cloud Starter -->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-dubbo</artifactId>
</dependency>

<!-- Sample API 接口聲明-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-dubbo-sample-api</artifactId>
</dependency>

<!-- Spring Cloud Nacos Service Discovery -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-zookeeper-discovery</artifactId>
</dependency>
           

spring:
  application:
    name: spring-cloud-dubbo-consumer
  cloud:
    zookeeper:
      discovery:
        register: false #表示該服務不要注冊進注冊中心
      connect-string: localhost:2181  
dubbo:     
  cloud:
    subscribed-services: spring-cloud-dubbo-provider  #表示服務調用者訂閱的服務提供方的應用名稱清單。預設值為“*”,不推薦使用預設值
           

  • 在服務類中使用

    @Reference

    注解注入 TestService 即可;
@RestController
public class TestController{
    @Reference 
    private TestService testService;
    
    @GetMapping("/message")
    public String testController(){
        return testService.test("message");
}
           

  • 在本示例中将對 2.1 中定義的 TestService 接口配置服務降級政策;
  • 降級政策的配置都是在基于服務消費者之上的;

public class MockTestService implements TestService {
	@Override
	public String test(String message) {
		return "目前無法通路";
	}
}
           

@RestController
public class TestController{
    @Reference(mock = "com.dlhjw.springcloud.mock.MockTestService", cluster="failfast")
    private TestService testService;
    
    @GetMapping("/message")
    public String testController(){
        return testService.test("message");
}
           
  • 在 TestController 類中修改 @Reference 注解增加

    mock

    參數;
  • 其中設定了屬性

    cluster="failfast"

    ,因為預設的容錯政策會發起兩次重試,等待的時間較長;

  • 這裡僅使用到了 Spring Boot 的自動配置;
  • 有兩種配置方式,一種是使用 .xml,另一種是使用 .yml;
  • .xml 的配置詳情請見筆者的另一篇文章:Dubbo | Dubbo快速上手筆記 - 環境與配置;

  • Zookeeper 伺服器的下載下傳詳情請見筆者的另一篇文章:微服務架構 | 3.3 Apache Zookeeper 注冊中心;

  • 服務提供者與服務消費者需要引入的依賴相同;
<!-- Zookeeper 相關依賴 -->
<dependency>
    <groupId>org.apache.zookeeper</groupId>
    <artifactId>zookeeper</artifactId>
    <version>3.5.3-beta</version>
</dependency>
<dependency>
    <groupId>org.apache.curator</groupId>
    <artifactId>curator-framework</artifactId>
    <version>4.0.1</version>
</dependency>
<dependency>
    <groupId>org.apache.curator</groupId>
    <artifactId>curator-recipes</artifactId>
    <version>4.0.1</version>
</dependency>

<!-- Dubbo 相關依賴 -->
<dependency>
    <groupId>org.apache.dubbo</groupId>
    <artifactId>dubbo-spring-boot-starter</artifactId>
    <version>2.7.5</version>
</dependency>

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

spring:
  application:
    name: springboot-dubbo-demo 
dubbo:
  #服務提供方的資訊
  application:
    name: springboot-provider      
  protocol:
    name: dubbo
    port: 20880
  registry:
    address: zookeeper://localhost:2181  #zookeeper位址
  #scan:
    #base-packages: com.dlhjw.dubbo.service.impl  #指定 Dubbo 服務實作類的掃描基準包,作用等同于 主程式類上的 @DubboComponentScan
           

  • @DubboComponentScan:作用同 Spring Boot 的

    @ComponentScan

    ,不過這裡要掃描 Dubbo 提供的 @Service 注解;
  • @DubboComponentScan(basePackages = "com.dlhjw.dubbo.service.impl")
  • 如果上面 application 中已經做了配置,這裡可以不用添加;

  • 建立接口及其實作類:
public interface TestService {
    void testDubbo();
}
           
@Service(version = "1.0.0",timeout = 3000)
public class TestServiceImpl implements TestService{
    @Override
    public void testDubbo() {
    }
}
           
  • 注意:@Service 注解是

    com.alibaba.dubbo.config.annotation.Service

    包下的;

dubbo:
  #服務消費方的資訊
  application:
    name: springboot-consumer 
  registry:
    #zookeeper位址
    address: zookeeper://localhost:2181
           

  • 這裡直接在 controller 接口裡直接調用服務提供者提供的 TestService 即可;
@Reference(version = "1.0.0",timeout = 300)
private TestService testService;
           
  • @Reference 注解可以獲得一個遠端代理對象;

  • 這裡僅提供服務提供者的示例,服務消費者類似;

  • Nacos 伺服器的下載下傳詳情請見筆者的另一篇文章:微服務架構 | 3.2 Alibaba Nacos 注冊中心;

  • 建立一個父工程 spring-cloud-nacos-sample,包含兩個子產品:nacos-sample-api 和 nacos-sample-provider;
  • 在 nacos-sample-api 中聲明接口;
public interface IHelloService{
    String sayHello(String name);
}
           

  • 在 nacos-sample-provider 中添加依賴檔案:
<!-- 接口定義類 -->
<dependency>
  <groupId>com.gupaoedu.book.nacos</groupId>
  <version>1.0-SNAPSHOT</version>
  <artifactId>nacos-sample-api</artifactId>
</dependency>
<!-- Nacos 的 starter 元件 -->
<dependency>
  <groupId>com.alibaba.boot</groupId>
  <artifactId>nacos-discovery-spring-boot-starter</artifactId>
  <version>0.2.4</version>
  <exclusions>
    <exclusion>
      <groupId>com.alibaba.spring</groupId>
      <artifactId>spring-context-support</artifactId>
    </exclusion>
  </exclusions>
</dependency>
<!-- Dubbo 的 starter 元件 -->
<dependency>
  <groupId>org.apache.dubbo</groupId>
  <artifactId>dubbo-spring-boot-starter</artifactId>
  <version>2.7.5</version>
</dependency>
           

dubbo:
  application:
    name: spring-boot-dubbo-nacos-sample 
  registry:
    address: nacos://127.0.0.1:8848  #基于 Nacos 協定
  protocol: 
    name: dubbo
    port: 20880
           

  • @DubboComponentScan:dubbo 的包掃描注解;

  • 實作 6.2 中定義的接口;
@Service 
public class HelloServiceImpl implements IHelloService{
    @Override 
    public String sayHello(String name){
        return "He1lo World:"+name;
    }
}        
           

  • 啟動服務,通路 Nacos 控制台,進入“服務管理” -> “服務清單”,可以看到所有注冊在 Nacos 上的服務;

  • 建立一個父工程 spring-cloud-nacos-sample,包含兩個子產品:spring-cloud-nacos-sample-api 和 spring-cloud-nacos-sample-provider;
public interface IHelloService{
    String sayHello(String name);
}
           

  • 在父工程中顯示聲明依賴的指定版本;
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-dependencies</artifactId>
  <version>Greenwich.SR2</version>
  <type>pom</type>
  <scope>import</scope>
</dependency>
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-dependencies</artifactId>
  <version>2.1.11.RELEASE</version>
  <type>pom</type>
  <scope>import</scope>
</dependency>
<dependency>
  <groupId>com.alibaba.cloud</groupId>
  <artifactId>spring-cloud-alibaba-dependencies</artifactId>
  <version>2.1.1.RELEASE</version>
  <type>pom</type>
  <scope>import</scope>
</dependency>
           
  • 在 spring-cloud-nacos-sample-provider 中添加依賴檔案:
<!-- Spring Cloud 核心包 -->
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter</artifactId>
  <exclusions>
    <exclusion>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-context</artifactId>
    </exclusion>
  </exclusions>
</dependency>

<!-- Spring Cloud 的 Dubbo 依賴 -->
<dependency>
  <groupId>com.alibaba.cloud</groupId>
  <artifactId>spring-cloud-starter-dubbo</artifactId>
</dependency>

<!-- api 子產品 -->
<dependency>
  <groupId>com.gupaoedu.book.springcloud</groupId>
  <artifactId>spring-cloud-dubbo-sample-api</artifactId>
  <version>1.0-SNAPSHOT</version>
</dependency>

<!-- 基于 Nacos 的服務注冊與發現 -->
<dependency>
  <groupId>com.alibaba.cloud</groupId>
  <artifactId>spring-cloud-alibaba-nacos-discovery</artifactId>
  <exclusions>
    <exclusion>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-context</artifactId>
    </exclusion>
  </exclusions>
</dependency>
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-context</artifactId>
  <version>2.1.1.RELEASE</version>
</dependency>
           

  • 與 Spring Boot 這整合方式的主要差別就在 pom.xml 配置檔案和 application.yml 依賴檔案;
spring: 
  application: 
    name: spring-cloud-nacos-sample 
  cloud: 
    nacos: 
      discovery:
        server-addr: 127.0.0.1:8848  #Nacos 服務注冊中心位址

dubbo: 
  scan: 
    base-packages: com.gupaoedu.book.nacos.bootstrap  #功能等同于 @DubboComponentScan   
  protocol: 
    name: dubbo
    port: 20880
  registry:
    address: spring-cloud://localhost  #将服務挂載到 Spring Cloud 注冊中心
           

  • 實作 7.2 中定義的接口即可;
@Service 
public class HelloServiceImpl implements IHelloService{
    @Override 
    public String sayHello(String name){
        return "He1lo World:"+name;
    }
}        
           

新人制作,如有錯誤,歡迎指出,感激不盡!

歡迎關注公衆号,會分享一些更日常的東西!

如需轉載,請标注出處!

微服務架構 | 12.1 使用 Apache Dubbo 實作遠端通信