文章詳情頁

Spring Boot 整合 Apache Dubbo的示例代碼

瀏覽：7日期：2023-07-04 15:58:14

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>進行依賴管理。

<dependencyManagement>：聲明全局依賴，當子項目指定引用才會繼承依賴；<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>  <dependency><groupId>org.apache.dubbo</groupId><artifactId>dubbo-spring-boot-starter</artifactId><version>${dubbo.version}</version> </dependency>  <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><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 項目依賴

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

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 項目依賴

4.2 服務實現接口

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

注意：@Service 是 dubbo 包下面的注解不是 Spring 里面的注解。

4.3 項目配置

dubbo 的配置直接用 dubbo，不再以 Spring 開頭; base-packages：指定接口實現所在路徑。

server: # 服務端口 port: 7777spring: 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 項目依賴

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: 7000spring: 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 上如下：

Spring Boot 整合 Apache Dubbo的示例代碼

成功將借口注冊到注冊中心，說明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！

Spring

上一條：Spring緩存注解@Cacheable @CacheEvit @CachePut使用介紹下一條：spring boot 如何指定profile啟動

相關文章：

1. 將properties文件的配置設置為整個Web應用的全局變量實現方法2. asp中response.write("中文")或者js中文亂碼問題3. React實現一個倒計時hook組件實戰示例4. CSS可以做的幾個令你嘆為觀止的實例分享5. 得到XML文檔大小的方法6. xml中的空格之完全解說7. PHP字符串前后字符或空格刪除方法介紹8. css進階學習選擇符9. Jsp中request的3個基礎實踐10. 低版本IE正常運行HTML5+CSS3網站的3種解決方案

排行榜

					
					IntelliJ IDEA刪除類的方法步驟
源碼解讀Spring-Integration執行過程
vue路由切換時取消之前的所有請求操作
低版本IE正常運行HTML5+CSS3網站的3種解決方案
CSS可以做的幾個令你嘆為觀止的實例分享
asp中response.write("中文")或者js中文亂碼問題
得到XML文檔大小的方法
Ajax請求超時與網絡異常處理圖文詳解
Jsp中request的3個基礎實踐
不使用XMLHttpRequest對象實現Ajax效果的方法小結
python 多線程爬取壁紙網站的示例
				