Spring Boot 整合 Apache Dubbo

来源:https://www.cnblogs.com/vandusty/archive/2020/05/09/12853973.html
-Advertisement-
Play Games

`Apache Dubbo Java RPC` 框架，它提供了三大核心能力：面向介面的遠程方法調用，智能容錯和負載均衡，以及服務自動註冊和發現。 註意，是 ，不再是 。簡單來說就是 將 移交給 開源社區進行維護。參見 "dubbo spring boot project" "Spring Boot ...


Apache Dubbo是一款高性能、輕量級的開源 Java RPC 框架，它提供了三大核心能力：面向介面的遠程方法調用，智能容錯和負載均衡，以及服務自動註冊和發現。

註意，是 Apache Dubbo，不再是 Alibaba Dubbo。簡單來說就是 Alibaba 將 Dubbo 移交給 Apache 開源社區進行維護。參見 dubbo-spring-boot-project

Spring Boot 系列：整合 Alibaba Dubbo

一、本文示例說明

1.1 框架版本

  • Dubbo 版本
<dependency>
    <groupId>org.apache.dubbo</groupId>
    <artifactId>dubbo-spring-boot-starter</artifactId>
    <version>2.7.5</version>
</dependency>
  • Spring Boot 版本
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.1.RELEASE</version>
    <relativePath/>
</parent>

1.2 模塊關係

  • 根工程 order：管理工程信息；
  • 子工程 order-api：定義RPC服務的介面、參數以及響應結果的結果集；
  • 子工程 order-provider：RPC服務的提供端；
  • 子工程 order-consumer：RPC服務的消費端，實際開發過程中實際情況是其它服務的調用該訂單RPC服務

二、根工程

2.1 創建項目 order

我這裡為了和之前老版本的alibaba的dubbo項目區分，文件名取為apache-dubbo-demo，maven 項目名稱為order。

該項目主要作用是定義工程信息、管理整個項目依賴版本等等，所以src目錄不需要。

2.2 pom.xml

根工程中使用了<dependencyManagement>和<dependencies>進行依賴管理。

  1. <dependencyManagement>：聲明全局依賴，當子項目指定引用才會繼承依賴；
  2. <dependencies>：聲明全局依賴，子項目直接自動繼承依賴。
<?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">
    <modelVersion>4.0.0</modelVersion>

    <!-- 父級引用 -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.1.RELEASE</version>
        <relativePath/>
    </parent>

    <!-- 基本信息 -->
    <groupId>cn.van.order</groupId>
    <artifactId>order</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <name>${project.artifactId}</name>
    <description>Apache Dubbo 根項目</description>

    <!--配置-->
    <properties>
        <java.version>1.8</java.version>
        <dubbo.version>2.7.5</dubbo.version>
        <zookeeper.version>3.4.14</zookeeper.version>
    </properties>

    <!-- 子項目 -->
    <modules>
        <module>order-api</module>
        <module>order-provider</module>
        <module>order-consumer</module>
    </modules>

    <!--聲明全局依賴（子項目需要顯示的引用才會繼承依賴）-->
    <dependencyManagement>
        <dependencies>
            <!-- dubbo-start依賴 -->
            <dependency>
                <groupId>org.apache.dubbo</groupId>
                <artifactId>dubbo-spring-boot-starter</artifactId>
                <version>${dubbo.version}</version>
            </dependency>
            <!--zookeeper 註冊中心客戶端引入 使用的是curator客戶端 -->
            <dependency>
                <groupId>org.apache.dubbo</groupId>
                <artifactId>dubbo-dependencies-zookeeper</artifactId>
                <version>${dubbo.version}</version>
                <type>pom</type>
                <exclusions>
                    <exclusion>
                        <artifactId>slf4j-log4j12</artifactId>
                        <groupId>org.slf4j</groupId>
                    </exclusion>
                </exclusions>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <!--聲明全局依賴（子項目不需要顯示的引用，自動繼承依賴）-->
    <dependencies>
        <!-- spring boot 依賴 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <!-- 打包插件 -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

三、order-api

3.1 項目依賴

無需更多依賴，所以很簡單。

<?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">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>cn.van.order</groupId>
        <artifactId>order</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>

    <groupId>cn.van.order</groupId>
    <artifactId>order-api</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <name>${project.artifactId}</name>
    <description>dubbo公共項目</description>


    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

3.2 封裝 RPC 結果集

  • 先封裝一個返回碼枚舉類ResultCodeEnum.java
public enum ResultCodeEnum {
    /*** 通用部分 100 - 599***/
    // 成功請求
    SUCCESS(200, "successful"),
    
    /*** 這裡可以根據不同模塊用不同的區級分開錯誤碼，例如:  ***/

    // 1000～1999 區間表示用戶模塊錯誤
    // 2000～2999 區間表示訂單模塊錯誤
    // 3000～3999 區間表示商品模塊錯誤
    // 。。。

    ORDER_NOT_FOUND(2000, "order not found"),
    ;
    /**
     * 響應狀態碼
     */
    private Integer code;
    /**
     * 響應信息
     */
    private String message;

    ResultCodeEnum(Integer code, String msg) {
        this.code = code;
        this.message = msg;
    }

    public Integer getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}
  • 先封裝一個RPC 響應結果集RpcResult.java
public class RpcResult <T> implements Serializable {

    /**
     * 是否響應成功
     */
    private Boolean success;
    /**
     * 響應狀態碼
     */
    private Integer code;
    /**
     * 響應數據
     */
    private T data;
    /**
     * 錯誤信息
     */
    private String message;

    // 構造器開始
    /**
     * 無參構造器(構造器私有，外部不可以直接創建)
     */
    private RpcResult() {
        this.code = 200;
        this.success = true;
    }
    /**
     * 有參構造器
     * @param obj
     */
    private RpcResult(T obj) {
        this.code = 200;
        this.data = obj;
        this.success = true;
    }

    /**
     * 有參構造器
     * @param resultCode
     */
    private RpcResult(ResultCodeEnum resultCode) {
        this.success = false;
        this.code = resultCode.getCode();
        this.message = resultCode.getMessage();
    }
    // 構造器結束

    /**
     * 通用返回成功（沒有返回結果）
     * @param <T>
     * @return
     */
    public static<T> RpcResult<T> success(){
        return new RpcResult();
    }

    /**
     * 返回成功（有返回結果）
     * @param data
     * @param <T>
     * @return
     */
    public static<T> RpcResult<T> success(T data){
        return new RpcResult<T>(data);
    }

    /**
     * 通用返回失敗
     * @param resultCode
     * @param <T>
     * @return
     */
    public static<T> RpcResult<T> failure(ResultCodeEnum resultCode){
        return  new RpcResult<T>(resultCode);
    }

    public Boolean getSuccess() {
        return success;
    }

    public void setSuccess(Boolean success) {
        this.success = success;
    }

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    @Override
    public String toString() {
        return "RpcResult{" +
                "success=" + success +
                ", code=" + code +
                ", data=" + data +
                ", message='" + message + '\'' +
                '}';
    }
}

3.3 編寫一個 RPC 介面

public interface OrderDubboService {
    RpcResult<OrderDomain> getOrder();
}

實體OrderDomain.java挺簡單的，詳見 Github 倉庫。

四、order-provider

此子項目是一個服務類項目，也就是將介面服務註冊到zookeeper註冊中心供消費端調取使用。

4.1 項目依賴

<?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">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>cn.van.order</groupId>
        <artifactId>order</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>

    <groupId>cn.van.order</groupId>
    <artifactId>order-provider</artifactId>
    <version>1.0-SNAPSHOT</version>
    <name>${project.artifactId}</name>
    <description>Dubbo 服務提供者</description>

    <dependencies>
        <dependency>
            <groupId>cn.van.order</groupId>
            <artifactId>order-api</artifactId>
            <version>1.0.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-spring-boot-starter</artifactId>
        </dependency>
        <!-- zookeeper依賴 -->
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-dependencies-zookeeper</artifactId>
            <version>${dubbo.version}</version>
            <type>pom</type>
            <exclusions>
                <exclusion>
                    <artifactId>slf4j-log4j12</artifactId>
                    <groupId>org.slf4j</groupId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

4.2 服務實現介面

@Service
public class OrderDubboServiceImpl implements OrderDubboService {
    
    @Override
    public RpcResult<OrderDomain> getOrder() {
        return RpcResult.success(new OrderDomain(1, 10086, LocalDateTime.now()));
    }
}

註意：
@Service 是 dubbo 包下麵的註解不是 Spring 裡面的註解。

4.3 項目配置

  1. dubbo 的配置直接用 dubbo，不再以 Spring 開頭;
  2. base-packages：指定介面實現所在路徑。
server:
  # 服務埠
  port: 7777
spring:
  application:
    name: order-provider
# dubbo 相關配置(dubbo 的配置不再以 Spring 開頭)
dubbo:
  application:
    # 應用名稱
    name: order-provider
  scan:
    # 介面實現者（服務實現）包
    base-packages: cn.van.order.service.impl
  # 註冊中心信息
  registry:
    address: zookeeper://127.0.0.1:2181
  protocol:
    # 協議名稱
    name: dubbo
    # 協議埠
    port: 20880

五、order-consumer

此子項目就是一個消費項目，比如商品模塊、財務模塊等等。

5.1 項目依賴

<?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">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>cn.van.order</groupId>
        <artifactId>order</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>

    <groupId>cn.van.order</groupId>
    <artifactId>order-consumer</artifactId>
    <version>1.0-SNAPSHOT</version>
    <name>${project.artifactId}</name>
    <description>Dubbo 消費者</description>


    <dependencies>
        <dependency>
            <groupId>cn.van.order</groupId>
            <artifactId>order-api</artifactId>
            <version>1.0.0-SNAPSHOT</version>
        </dependency>

        <!-- web項目依賴 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- dubbo依賴 -->
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-spring-boot-starter</artifactId>
        </dependency>

        <!-- dubbo的zookeeper依賴 -->
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-dependencies-zookeeper</artifactId>
            <version>${dubbo.version}</version>
            <type>pom</type>
            <exclusions>
                <exclusion>
                    <artifactId>slf4j-log4j12</artifactId>
                    <groupId>org.slf4j</groupId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

5.2 測試介面

模擬一個介面獲取訂單詳情。

@RestController
@RequestMapping("/order")
public class OrderConsumerController {
    @Reference
    OrderDubboService orderDubboService;

    @GetMapping("getOrder")
    public RpcResult getOrder() {
        return orderDubboService.getOrder();
    }
}

註意：@Reference引入的是 Dubbo 介面，所以是 Dubbo 的註解。

5.3 配置文件

server:
  port: 7000
spring:
  application:
    name: order-consumer
# dubbo 相關配置
dubbo:
  application:
    name: order-consumer
  registry:
    address: zookeeper://127.0.0.1:2181

六、測試

一切就緒，如果在order-consumer 的測試介面能成功請求到數據，則證明 Dubbo 服務搭建成功。

6.1 啟動 zookeeper

我們選用zookeeper作為註冊中心，因此啟動項目之前需要先啟動它。

6.2 dubbo-admin

dubbo-admin 便於觀察 order-provider 是否成功將介面註冊，具體安裝步驟詳見apache/dubbo-admin

預設埠：8080。

6.3 啟動 dubbo-provider

成功啟動後可以在dubbo-admin：已經成功將介面 OrderService 註冊到 zookeeper 上如下：

風塵博客

成功將藉口註冊到註冊中心，說明dubbo-provider 註冊成功。

6.4 啟動 order-cosumer

啟動消費者項目，在瀏覽器請求消費介面：http://localhost:7000/order/getOrder，成功返回數據如下：

{
    "success":true,
    "code":200,
    "data":{
        "id":1,
        "orderNum":10086,
        "gmtCreate":"2020-05-06T11:59:45.535"
    },
    "message":null
}

成功請求到 order-provider 提供的數據，說明 Dubbo 搭建成功！

七、總結

以上的完整代碼我已上傳到 Github，需要的可以自取測試，歡迎star！

文化交流

  1. 風塵博客
  2. 風塵博客-掘金
  3. 風塵博客-博客園
  4. 風塵博客-CSDN
  5. Github

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • B2B網站後臺管理系統側導航
    效果圖 index.html <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>index</title> <link rel="stylesheet" href="https://cdn.bootcss.co ...
  • Java編程技術之淺析SPI服務發現機制
    SPI服務發現機制 SPI是Java JDK內部提供的一種服務發現機制。 SPI Service Provider Interface,服務提供介面，是Java JDK內置的一種服務發現機制 通過在ClassPath路徑下的META INF/services文件夾查找文件，自動載入文件里所定義的類 ...
  • 軟體設計七大原則
    軟體設計七大原則 1、 開閉原則 定義：一個軟體實體，如類、模塊和函數應該對擴展開放，對修改關閉。中心思想：用抽象構建框架，用實現擴展細節。即面向抽象編程。優點：提高軟體系統的可復用性和可維護性。舉例：很多互聯網公司實行彈性制考勤，每天上班8小時，這是不可修改的，但是什麼時間上班和下班，是開放的。 ...
  • Spring Cloud Alibaba系列（一）nacos作為服務註冊中心
    Spring Cloud Alibaba各組件版本關係 | Spring Cloud Alibaba Version | Sentinel Version | Nacos Version | RocketMQ Version | Dubbo Version | Seata Version | | | ...
  • docker中安裝elasticsearch
    1、更改docker鏡像倉庫 2、可以先查看有哪些容器了 3、查看正在運行和沒有運行的容器 4、從中央倉庫拉取鏡像 5、後臺運行容器並映射配置文件 6、查看是否啟動成功 docker ps 根據自己的IP加上9200埠訪問即可 此時有可能會失敗，可以使用 docker logs 查看運行日誌 拿去 ...
  • 聚合類型與POD類型
    Lippman在《深度探索C++對象模型》的前言中寫道： I have heard a number of people over the years voice opinions similar to those of your colleagues. In every case, those o ...
  • Java創建對象的六種方法-權當記錄一下
    1 簡介 是面向對象的編程語言，只要使用它，就需要創建對象。Java創建對象有六種方法，實際常用的不會這麼多，這裡權當是記錄一下。 2 六種方法 （1）使用new關鍵字 （2）反射之Class類newInstance() （3）反射之Constructor類的newInstance() （4）Obj ...
  • 定義person類及其子類，並按要求設計、定義和實例化類 (實例)
    問題 設計一個person類，條件如下： 1）定義protected屬性：name（姓名）、age（年齡）、sex（性別） 2）定義static靜態屬性：num（用於計算已實例化的人數） 3）定義構造函數，實現在對象創建時輸出“I am a person”，並對num加1； 4）定義析構函數，在對象 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類