使用 Apache Dubbo 實(shí)現(xiàn)遠(yuǎn)程通信(微服務(wù)架構(gòu))
目錄
- 前言
- 1. Dubbo 基礎(chǔ)知識(shí)
- 1.1 Dubbo 是什么
- 1.2 Dubbo 的架構(gòu)圖
- 1.3 Spring Cloud 與 Dubbo 的區(qū)別
- 1.4 Dubbo 的特點(diǎn)
- 1.5 Dubbo 的 6 種容錯(cuò)模式容錯(cuò)模式
- 1.7 主機(jī)綁定規(guī)則
- 2. 構(gòu)建 Dubbo 服務(wù)提供方
- 2.1 構(gòu)建服務(wù)接口模塊
- 2.2 添加 pom.xml 依賴文件
- 2.3 修改 application.yml 配置文件
- 2.4 在主程序類上添加注解
- 2.5 實(shí)現(xiàn) 2.1 定義的接口
- 3. 構(gòu)建 Dubbo 服務(wù)消費(fèi)方
- 3.1 添加 pom.xml 依賴文件同服務(wù)提供方;
- 3.2 修改 application.yml 配置文件
- 3.3 修改業(yè)務(wù)類
- 4. 在消費(fèi)者端使用 Mock 配置實(shí)現(xiàn)服務(wù)降級(jí)
- 4.1 為接口實(shí)現(xiàn)一種服務(wù)降級(jí)方法
- 4.2 給 @Reference 注解增加 mock 參數(shù)
- 5. Dubbo 使用 Zookeeper 作為注冊(cè)中心(Spring Boot)
- 5.1 下載 Zookeeper 服務(wù)器
- 5.2 引入 pom.xml 依賴文件服務(wù)提供者與服務(wù)消費(fèi)者需要引入的依賴相同;
- 5.3 服務(wù)提供者
- 5.3.1 修改 application.yml 配置文件
- 5.3.2 在主程序類上添加注解
- 5.3.3 編寫業(yè)務(wù)類
- 5.4 服務(wù)消費(fèi)者
- 5.4.1 修改 application.yml 配置文件
- 5.4.2 在主程序類上添加注解
- 5.4.3 編寫業(yè)務(wù)類
- 6. Dubbo 使用 Nacos 作為注冊(cè)中心(Spring Boot)
- 6.1 下載 Nacos 服務(wù)器
- 6.2 工程結(jié)構(gòu)
- 6.3 引入 pom.xml 依賴文件
- 6.4 修改 application.yml 配置文件
- 6.5 在主程序類上添加注解
- 6.6 編寫業(yè)務(wù)類實(shí)現(xiàn)
- 6.7 啟動(dòng)測(cè)試
- 7. Dubbo 使用 Nacos 作為注冊(cè)中心(Spring Cloud)
- 7.1 下載 Nacos 服務(wù)器
- 7.2 工程結(jié)構(gòu)
- 7.3 添加 pom.xml 依賴
- 7.4 添加 application.yml 依賴文
- 7.5 主程序類上無需額外注解
- 7.6 編寫業(yè)務(wù)類實(shí)現(xiàn)
前言
參考資料:
《Spring Microservices in Action》
《Spring Cloud Alibaba 微服務(wù)原理與實(shí)戰(zhàn)》
《B站 尚硅谷 SpringCloud 框架開發(fā)教程 周陽(yáng)》
Apache Dubbo 是一個(gè)分布式服務(wù)框架,主要實(shí)現(xiàn)多個(gè)系統(tǒng)之間的高性能、透明化調(diào)用;
Dubbo 相關(guān)內(nèi)容筆者之前寫過一篇入門筆記:Dubbo快速上手筆記 - 環(huán)境與配置。入門筆記強(qiáng)調(diào)的是 Dubbo 的一些基本特性,以與 Zookeeper 的整合。因此這里將重點(diǎn)放在 Dubbo 與 Spring Cloud 的聯(lián)系、區(qū)別以及整合;
1. Dubbo 基礎(chǔ)知識(shí)
1.1 Dubbo 是什么
- Apache Dubbo 是一個(gè)分布式服務(wù)框架,主要實(shí)現(xiàn)多個(gè)系統(tǒng)之間的高性能、透明化調(diào)用;
- 簡(jiǎn)單來說它就是一個(gè) RPC 框架,但是和普通的 RPC 框架不同的是,它提供了服務(wù)治理功能,比如服務(wù)注冊(cè)、監(jiān)控、路由、容錯(cuò)等;
1.2 Dubbo 的架構(gòu)圖
1.3 Spring Cloud 與 Dubbo 的區(qū)別
參考:https://segmentfault.com/a/1190000038320266
- HTTP 請(qǐng)求會(huì)有更大的報(bào)文,占的帶寬也會(huì)更多。但是 REST 相比 RPC 更為靈活,服務(wù)提供方和調(diào)用方的依賴只依靠一紙契約,不存在代碼級(jí)別的強(qiáng)依賴,這在強(qiáng)調(diào)快速演化的微服務(wù)環(huán)境下,顯得更為合適;
- 模塊組件的具體比較如下:
1.4 Dubbo 的特點(diǎn)
- 支持多種協(xié)議的服務(wù)發(fā)布,默認(rèn)是 dubbo://,還可以支持 rest://、webservice://、thrift:// 等;
- 支持多種不同的注冊(cè)中心,如:Nacos、ZooKeeper、Redis,未來還將會(huì)支持 Consul、Eureka、Etcd 等;
- 支持多種序列化技術(shù),如:avro、fst、fastjson、hessian2、kryo 等;
- 在服務(wù)治理方面的功能非常完善,如:集群容錯(cuò)、服務(wù)路由、負(fù)載均衡、服務(wù)降級(jí)、服務(wù)限流、服務(wù)監(jiān)控、安全驗(yàn)證等;
- 中文文檔;
1.5 Dubbo 的 6 種容錯(cuò)模式容錯(cuò)模式
- 可以自行擴(kuò)展容錯(cuò)模式;
- 配置也很簡(jiǎn)單,在 @Service 接口里添加一個(gè)
cluster
參數(shù)即可;
@Service(cluster = "failfast") //更改容錯(cuò)方式為快速失敗public class TestServiceImpl implements TestService { @Override public String test() { ... }}
1.6 Dubbo 的 4 種負(fù)載均衡策略
- 可以基于 Dubbo 中的 SPI 機(jī)制來擴(kuò)展負(fù)載均衡策略;
- 配置也很簡(jiǎn)單,在 @Service 接口里添加一個(gè)
loadbalance
參數(shù)即可;
@Service(loadbalance = "roundrobin") //更改負(fù)載均衡策略為輪詢public class TestServiceImpl implements TestService { @Override public String test() { ... }}
1.7 主機(jī)綁定規(guī)則
- 主機(jī)綁定表示的是 Dubbo 服務(wù)對(duì)外發(fā)布的 IP 地址,默認(rèn)情況下 Dubbo 會(huì)按照以下順序來查找并綁定主機(jī) IP 地址:
- 查找環(huán)境變量中
DUBBO_IP_TO_BIND
屬性配置的 IP 地址; - 查找
dubbo.protocol.host
屬性配置的 IP 地址,默認(rèn)是空,如果沒有配置或者IP地址不合法,則繼續(xù)往下查找; - 通過
LocalHost.getHostAddress
獲取本機(jī) IP 地址,如果獲取失敗,則繼續(xù)往下查找; - 如果配置了注冊(cè)中心的地址,則使用 Socket 通信連接到注冊(cè)中心的地址后,使用 for 循環(huán)通過
socket.getLocalAddress().getHostAddress()
掃描各個(gè)網(wǎng)卡獲取網(wǎng)卡 IP 地址;
- 查找環(huán)境變量中
- 獲取的 IP 地址并不是寫入注冊(cè)中心的地址。默認(rèn)情況下,寫入注冊(cè)中心的 IP 地址優(yōu)先選擇環(huán)境變量中
DUBBO_IP_TO_REGISTRY
屬性配置的 IP 地址。在這個(gè)屬性沒有配置的情況下,才會(huì)選取前面獲得的 IP 地址并寫入注冊(cè)中心; - 問題:使用默認(rèn)的主機(jī)綁定規(guī)則,可能會(huì)存在獲取的 P 地址不正確的情況;
- 原因:Dubbo 檢測(cè)本地 IP 地址的策略是先調(diào)用
LocalHost.getHostAddress
,這個(gè)方法的原理是通過獲取本機(jī)的 hostname 映射 IP 地址,如果它指向的是一個(gè)錯(cuò)誤的 IP 地址,那么這個(gè)錯(cuò)誤的地址將會(huì)作為服務(wù)發(fā)布的地址注冊(cè)到 ZooKeeper 節(jié)點(diǎn)上; - 解決方案:
- 在
/etc/hosts
中配置機(jī)器名對(duì)應(yīng)正確的 IP 地址映射; - 在環(huán)境變量中添加
DUBBO_IP_TO_BIND
或者DUBBO_IP_TO_REGISTRY
屬性,Value 值為綁定的主機(jī)地址; - 通過
dubbo.protocolhost
設(shè)置主機(jī)地址;
- 在
- 原因:Dubbo 檢測(cè)本地 IP 地址的策略是先調(diào)用
2. 構(gòu)建 Dubbo 服務(wù)提供方
- 同樣,這里使用 Zookeeper,就需要先下載 Zookeeper 服務(wù)器:詳情請(qǐng)見筆者的另一篇文章:apache zookeeper使用方法實(shí)例詳解;
2.1 構(gòu)建服務(wù)接口模塊
- Dubbo 官方推薦把服務(wù)接口打成 Jar 包發(fā)布到倉(cāng)庫(kù)上;
- 這樣服務(wù)消費(fèi)者可以依賴該 Jar 包,通過接口調(diào)用方式完成遠(yuǎn)程通信。對(duì)于服務(wù)提供者來說,也需要依賴該 Jar 包完成接口的實(shí)現(xiàn);
- 做法如下:
- 新建
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);}
執(zhí)行 mvn install
命令將接口 jar 包安裝到本地倉(cāng)庫(kù);
2.2 添加 pom.xml 依賴文件
<!-- Spring Cloud 核心包--><dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter</artifactId></dependency><!-- Dubbo Spring Cloud Starter --> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-dubbo</artifactId><!-- Sample API 接口聲明--> <artifactId>spring-cloud-dubbo-sample-api</artifactId><!-- Spring Cloud Nacos Service Discovery --> <artifactId>spring-cloud-starter-zookeeper-discovery</artifactId>
2.3 修改 application.yml 配置文件
spring: application: name: spring-cloud-dubbo-provider cloud: zookeeper: discovery:register: true #表示該服務(wù)要注冊(cè)進(jìn)注冊(cè)中心 connect-string: localhost:2181 #zookeeper 服務(wù)器位置dubbo: protocol: name: dubbo port: 20880
2.4 在主程序類上添加注解
- @DubboComponentScan:掃描主程序類所在包及其子包下的所有注解,將
@Servicr
注解下類注冊(cè)進(jìn)容器里;
2.5 實(shí)現(xiàn) 2.1 定義的接口
@Servicepublic class TestServiceImpl implements TestService { @Value("${dubbo.application.name}") private String serviceName; @Override public String test(String message) { return serviceName; }}
- 可以在 @Service 注解里添加兩個(gè)屬性配置
cluster
和loadbalance
,分別用來配置容錯(cuò)模式和負(fù)載均衡策略; - 詳情請(qǐng)見本篇《1.5 Dubbo 的 6 種容錯(cuò)模式》和《1.6 Dubbo 的 4 種負(fù)載均衡策略》
3. 構(gòu)建 Dubbo 服務(wù)消費(fèi)方
3.1 添加 pom.xml 依賴文件同服務(wù)提供方;
<!-- Spring Cloud 核心包--><dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter</artifactId></dependency><!-- Dubbo Spring Cloud Starter --> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-dubbo</artifactId><!-- Sample API 接口聲明--> <artifactId>spring-cloud-dubbo-sample-api</artifactId><!-- Spring Cloud Nacos Service Discovery --> <artifactId>spring-cloud-starter-zookeeper-discovery</artifactId>
3.2 修改 application.yml 配置文件
spring: application: name: spring-cloud-dubbo-consumer cloud: zookeeper: discovery:register: false #表示該服務(wù)不要注冊(cè)進(jìn)注冊(cè)中心 connect-string: localhost:2181 dubbo: cloud: subscribed-services: spring-cloud-dubbo-provider #表示服務(wù)調(diào)用者訂閱的服務(wù)提供方的應(yīng)用名稱列表。默認(rèn)值為“*”,不推薦使用默認(rèn)值
3.3 修改業(yè)務(wù)類
在服務(wù)類中使用 @Reference
注解注入 TestService 即可;
@RestControllerpublic class TestController{ @Reference private TestService testService; @GetMapping("/message") public String testController(){return testService.test("message");}
4. 在消費(fèi)者端使用 Mock 配置實(shí)現(xiàn)服務(wù)降級(jí)
- 在本示例中將對(duì) 2.1 中定義的 TestService 接口配置服務(wù)降級(jí)策略;
- 降級(jí)策略的配置都是在基于服務(wù)消費(fèi)者之上的;
4.1 為接口實(shí)現(xiàn)一種服務(wù)降級(jí)方法
public class MockTestService implements TestService { @Override public String test(String message) { return "當(dāng)前無法訪問"; }}
4.2 給 @Reference 注解增加 mock 參數(shù)
@RestControllerpublic 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
參數(shù); - 其中設(shè)置了屬性
cluster="failfast"
,因?yàn)槟J(rèn)的容錯(cuò)策略會(huì)發(fā)起兩次重試,等待的時(shí)間較長(zhǎng);
5. Dubbo 使用 Zookeeper 作為注冊(cè)中心(Spring Boot)
- 這里僅使用到了 Spring Boot 的自動(dòng)配置;
- 有兩種配置方式,一種是使用 .xml,另一種是使用 .yml;
- .xml 的配置詳情請(qǐng)見筆者的另一篇文章:Dubbo | Dubbo快速上手筆記 - 環(huán)境與配置;
5.1 下載 Zookeeper 服務(wù)器
Zookeeper 服務(wù)器的下載詳情請(qǐng)見筆者的另一篇文章:apache zookeeper使用方法實(shí)例詳解
5.2 引入 pom.xml 依賴文件服務(wù)提供者與服務(wù)消費(fèi)者需要引入的依賴相同;
<!-- Zookeeper 相關(guān)依賴 --><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 相關(guān)依賴 --><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>
5.3 服務(wù)提供者
5.3.1 修改 application.yml 配置文件
spring: application: name: springboot-dubbo-demo dubbo: #服務(wù)提供方的信息 application: name: springboot-provider protocol: name: dubbo port: 20880 registry: address: zookeeper://localhost:2181 #zookeeper地址 #scan: #base-packages: com.dlhjw.dubbo.service.impl #指定 Dubbo 服務(wù)實(shí)現(xiàn)類的掃描基準(zhǔn)包,作用等同于 主程序類上的 @DubboComponentScan
5.3.2 在主程序類上添加注解
- @DubboComponentScan:作用同 Spring Boot 的 @ComponentScan,不過這里要掃描 Dubbo 提供的 @Service 注解;
- @DubboComponentScan(basePackages = "com.dlhjw.dubbo.service.impl")
- 如果上面 application 中已經(jīng)做了配置,這里可以不用添加;
5.3.3 編寫業(yè)務(wù)類
創(chuàng)建接口及其實(shí)現(xiàn)類:
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
包下的;
5.4 服務(wù)消費(fèi)者
5.4.1 修改 application.yml 配置文件
dubbo: #服務(wù)消費(fèi)方的信息 application: name: springboot-consumer registry: #zookeeper地址 address: zookeeper://localhost:2181
5.4.2 在主程序類上添加注解
5.4.3 編寫業(yè)務(wù)類
這里直接在 controller 接口里直接調(diào)用服務(wù)提供者提供的 TestService 即可;
@Reference(version = "1.0.0",timeout = 300)private TestService testService;
@Reference 注解可以獲得一個(gè)遠(yuǎn)程代理對(duì)象;
6. Dubbo 使用 Nacos 作為注冊(cè)中心(Spring Boot)
- 這里僅使用到了 Spring Boot 的自動(dòng)配置;
- 這里僅提供服務(wù)提供者的示例,服務(wù)消費(fèi)者類似;
6.1 下載 Nacos 服務(wù)器
Nacos 服務(wù)器的下載詳情請(qǐng)見筆者的另一篇文章:apache zookeeper使用方法實(shí)例詳解
6.2 工程結(jié)構(gòu)
- 新建一個(gè)父工程 spring-cloud-nacos-sample,包含兩個(gè)模塊:nacos-sample-api 和 nacos-sample-provider;
- 在 nacos-sample-api 中聲明接口;
public interface IHelloService{ String sayHello(String name);}
6.3 引入 pom.xml 依賴文件
在 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>
6.4 修改 application.yml 配置文件
dubbo: application: name: spring-boot-dubbo-nacos-sample registry: address: nacos://127.0.0.1:8848 #基于 Nacos 協(xié)議 protocol: name: dubbo port: 20880
6.5 在主程序類上添加注解
@DubboComponentScan:dubbo 的包掃描注解;
6.6 編寫業(yè)務(wù)類實(shí)現(xiàn)
6.2 中定義的接口;
@Service public class HelloServiceImpl implements IHelloService{ @Override public String sayHello(String name){return "He1lo World:"+name; }
6.7 啟動(dòng)測(cè)試
啟動(dòng)服務(wù),訪問 Nacos 控制臺(tái),進(jìn)入“服務(wù)管理” -> “服務(wù)列表”,可以看到所有注冊(cè)在 Nacos 上的服務(wù);
7. Dubbo 使用 Nacos 作為注冊(cè)中心(Spring Cloud)
這里僅提供服務(wù)提供者的示例,服務(wù)消費(fèi)者類似;
7.1 下載 Nacos 服務(wù)器
Nacos 服務(wù)器的下載詳情請(qǐng)見筆者的另一篇文章:apache zookeeper使用方法實(shí)例詳解
7.2 工程結(jié)構(gòu)
- 新建一個(gè)父工程 spring-cloud-nacos-sample,包含兩個(gè)模塊:spring-cloud-nacos-sample-api 和 spring-cloud-nacos-sample-provider;
- 在 nacos-sample-api 中聲明接口;
public interface IHelloService{ String sayHello(String name);}
7.3 添加 pom.xml 依賴
在父工程中顯示聲明依賴的指定版本;
<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 依賴 --> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-dubbo</artifactId><!-- api 模塊 --> <groupId>com.gupaoedu.book.springcloud</groupId> <artifactId>spring-cloud-dubbo-sample-api</artifactId> <version>1.0-SNAPSHOT</version><!-- 基于 Nacos 的服務(wù)注冊(cè)與發(fā)現(xiàn) --> <artifactId>spring-cloud-alibaba-nacos-discovery</artifactId> <artifactId>spring-cloud-context</artifactId> <version>2.1.1.RELEASE</version>
7.4 添加 application.yml 依賴文
件與 Spring Boot 這整合方式的主要區(qū)別就在 pom.xml 配置文件和 application.yml 依賴文件;
spring: application: name: spring-cloud-nacos-sample cloud: nacos: discovery:server-addr: 127.0.0.1:8848 #Nacos 服務(wù)注冊(cè)中心地址dubbo: scan: base-packages: com.gupaoedu.book.nacos.bootstrap #功能等同于 @DubboComponentScan protocol: name: dubbo port: 20880 registry: address: spring-cloud://localhost #將服務(wù)掛載到 Spring Cloud 注冊(cè)中心
7.5 主程序類上無需額外注解
7.6 編寫業(yè)務(wù)類實(shí)現(xiàn)
7.2 中定義的接口即可;
@Service public class HelloServiceImpl implements IHelloService{ @Override public String sayHello(String name){return "He1lo World:"+name; }}
到此這篇關(guān)于使用 Apache Dubbo 實(shí)現(xiàn)遠(yuǎn)程通信(微服務(wù)架構(gòu))的文章就介紹到這了,更多相關(guān)Apache Dubbo 遠(yuǎn)程通信內(nèi)容請(qǐng)搜索以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持!
