Spring Cloud與Dubbo的完美融合之手「Spring Cl

starkbl發表於2021-09-09

很早以前,在剛開始搞Spring Cloud基礎教程的時候,寫過這樣一篇文章:,可能不少讀者也都看過。之後也就一直有關於這兩個框架怎麼選的問題出來,其實文中我有明確的提過,Spring Cloud與Dubbo的比較本身是不公平的,主要前者是一套較為完整的架構方案,而Dubbo只是服務治理與RPC實現方案。

由於Dubbo在國內有著非常大的使用者群體,但是其周邊設施與元件相對來說並不那麼完善。很多開發者使用者又很希望享受Spring Cloud的生態,因此也會有一些Spring Cloud與Dubbo一起使用的案例與方法出現,但是一直以來大部分Spring Cloud整合Dubbo的使用方案都比較彆扭。這主要是由於Dubbod的註冊中心採用了ZooKeeper,而開始時Spring Cloud體系中的註冊中心並不支援ZooKeeper,所以很多方案是存在兩個不同註冊中心的,之後即使Spring Cloud支援了ZooKeeper,但是由於服務資訊的粒度與儲存也不一致。所以,長期以來,在服務治理層面上,這兩者一直都一套完美的融合方案。

直到Spring Cloud Alibaba的出現,才得以解決這樣的問題。在之前的教程中,我們已經介紹過使用Spring Cloud Alibaba中的Nacos來作為服務註冊中心,並且在此之下可以如傳統的Spring Cloud應用一樣地使用Ribbon或Feign來實現服務消費。這篇,我們就來繼續說說Spring Cloud Alibaba下額外支援的RPC方案:Dubbo。

入門案例

我們先透過一個簡單的例子,來直觀地感受Nacos服務註冊中心之下,利用Dubbo來實現服務提供方與服務消費方。這裡省略Nacos的安裝與使用,如果對Nacos還不瞭解,可以檢視本系列的,下面就直接進入Dubbo的使用步驟。

構建服務介面

建立一個簡單的Java專案,並在下面定義一個抽象介面,比如:

public interface HelloService {

    String hello(String name);

}

構建服務介面提供方

第一步:建立一個Spring Boot專案,在pom.xml中引入第一步中構建的API包以及Spring Cloud Alibaba對Nacos和Dubbo的依賴,比如:

    <dependencies>
        <!-- 第一步中構建的API包 -->
        <dependency>
            <groupId>com.didispace</groupId>
            <artifactId>alibaba-dubbo-api</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>        
            <!--<groupId>com.alibaba.cloud</groupId>-->
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-dubbo</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

        //...
    </dependencies>

這裡需要注意兩點:

  1. 必須包含spring-boot-starter-actuator包,不然啟動會報錯。
  2. spring-cloud-starter-dubbo包需要注意groupId,根據具體使用的spring cloud alibaba版本依賴來確定。
    • 專案孵化期間,使用的groupId為:org.springframework.cloud
    • 專案孵化之後,使用的groupId修改為了com.alibaba.cloud,所以使用者需要注意是否使用正確。避免載入不到對應JAR包的問題。

第二步:實現Dubbo介面

@Service
public class HelloServiceImpl implements HelloService {

    @Override
    public String hello(String name) {
        return "hello " + name;
    }

}

注意:這裡的@Service註解不是Spring的,而是org.apache.dubbo.config.annotation.Service註解。

第三步:配置Dubbo服務相關的資訊,比如:

spring.application.name=alibaba-dubbo-server
server.port=8001

spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

# 指定 Dubbo 服務實現類的掃描基準包
dubbo.scan.base-packages=com.didispace.alibaba.dubbo.server
dubbo.protocol.name=dubbo
dubbo.protocol.port=-1
dubbo.registry.address=spring-cloud://localhost

配置說明如下:

  • dubbo.scan.base-packages: 指定 Dubbo 服務實現類的掃描基準包
  • dubbo.protocol: Dubbo 服務暴露的協議配置,其中子屬性 name 為協議名稱,port 為協議埠( -1 表示自增埠,從 20880 開始)
  • dubbo.registry: Dubbo 服務註冊中心配置,其中子屬性 address 的值 “spring-cloud://localhost”,說明掛載到 Spring Cloud 註冊中心

注意:如果使用Spring Boot 2.1及更高版本時候,需要增加配置spring.main.allow-bean-definition-overriding=true

第四步:建立應用主類,比如:

@EnableDiscoveryClient
@SpringBootApplication
public class DubboServerApplication {

    public static void main(String[] args) {
        SpringApplication.run(DubboServerApplication.class, args);
    }

}

構建服務介面消費方

第一步:建立一個Spring Boot專案,在pom.xml中引入第一步中構建的API包以及Spring Cloud Alibaba對Nacos和Dubbo的依賴,具體內容與服務提供方一致:

    <dependencies>
        <!-- 第一步中構建的API包 -->
        <dependency>
            <groupId>com.didispace</groupId>
            <artifactId>alibaba-dubbo-api</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>        
            <!--<groupId>com.alibaba.cloud</groupId>-->
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-dubbo</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

        //...
    </dependencies>

第二步:配置Dubbo服務相關的資訊,比如:

spring.application.name=alibaba-dubbo-client
server.port=8002

spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

dubbo.protocol.name=dubbo
dubbo.protocol.port=-1
dubbo.registry.address=spring-cloud://localhost
dubbo.cloud.subscribed-services=alibaba-dubbo-server

注意:

  1. 這裡多增加了dubbo.cloud.subscribed-services引數,表示要訂閱服務的服務名,這裡配置的alibaba-dubbo-server對應的就是上一節服務提供方的spring.application.name的值,也就是服務提供方的應用名。
  2. 如果使用Spring Boot 2.1及更高版本時候,需要增加配置spring.main.allow-bean-definition-overriding=true

第三步:建立應用主類,並實現一個介面,在這個介面中呼叫Dubbo服務,比如:

@EnableDiscoveryClient
@SpringBootApplication
public class DubboClientApplication {

    public static void main(String[] args) {
        SpringApplication.run(DubboClientApplication.class, args);
    }

    @Slf4j
    @RestController
    static class TestController {

        @Reference
        HelloService helloService;

        @GetMapping("/test")
        public String test() {
            return helloService.hello("didispace.com");
        }
    }

}

注意:這裡的@Reference註解是org.apache.dubbo.config.annotation.Reference

測試驗證

完成了上面的所有開發之後,我們可以將Nacos、服務提供者、服務消費者依次啟動起來。在完成啟動之後,我們可以在Nacos控制檯的服務列表中看到上面定義的兩個服務,比如:

圖片描述

接下來,我們就可以透過呼叫服務消費者中定義的/test介面來觸發dubbo服務的消費了。如果一切順暢,應該可以得到如下結果:

$ curl localhost:8002/test
hello didispace.com

小結

透過上面的例子,如果你曾經同時玩過Spring Cloud和Dubbo,一定會深有感觸。你不用再同時顧慮Eureka和Zookeeper的配置,也不同同時關注這兩個中介軟體的健康,只需要關注和維護好Nacos一個即可。而對於Dubbo的配置和使用來說,配置還是相當簡單的,而程式碼編寫上與以往的Dubbo沒什麼大的不同。在Spring Cloud Alibaba的整合之下,Dubbo使用者既可以享受到原本RPC帶來效能優勢,又可以更好的享受Spring Cloud的各種福利;而對於Spring Cloud使用者來說,在服務治理層面,又對了一個不錯的可選項。可以說這塊的整合是真正的讓這兩大使用者群體得到了很好的融合,起到了互相成就的作用。更多關於Spring Cloud與Spring Cloud Alibaba教程內容可。

參考資料

程式碼示例

本文介紹內容的客戶端程式碼,示例讀者可以透過檢視下面倉庫中的alibaba-dubbo-apialibaba-dubbo-serveralibaba-dubbo-client專案:

  • Github:
  • Gitee:

如果您對這些感興趣,歡迎star、follow、收藏、轉發給予支援!

歡迎關注我:程式猿DD,獲得獨家整理的學習資源和日常乾貨推送。
如果您對我的專題內容感興趣,也可以關注我的部落格:

來自 “ ITPUB部落格 ” ,連結:http://blog.itpub.net/3705/viewspace-2824015/,如需轉載,請註明出處,否則將追究法律責任。

相關文章