手把手教你搭建 Spring Cloud Alibaba 服務(wù)調(diào)用源碼調(diào)試環(huán)境
近期因?yàn)閭€(gè)人需要，所以基于Spring Cloud Alibaba完成nacos服務(wù)提供者和服務(wù)消費(fèi)者的源碼搭建，遂以此文記錄一下筆者的搭建過(guò)程，希望對(duì)你有幫助。
一、Spring Cloud Alibaba前置配置步驟
1. 拉取指定版本
首先到GitHub上拉取指定版本的源碼，以筆者為例需要下載2021.0.5.0版本，所以對(duì)應(yīng)的指令就如下所示：
git clone --branch 2021.0.5.0 https://github.com/alibaba/spring-cloud-alibaba等待克隆完成后我們就可以得到所需的版本：
2. 配置并編譯
在完成必要的maven和jdk配置之后，我們需要?jiǎng)h除父pom文件中check-style插件，避免后續(xù)進(jìn)行代碼注釋等導(dǎo)致格式檢查報(bào)錯(cuò)導(dǎo)致項(xiàng)目無(wú)法啟動(dòng)的問題：
完成上述操作后點(diǎn)擊編譯等待SCA完成必要的代碼生成和代碼編譯：
等待片刻后，如果輸出顯示成功，則說(shuō)明我們的前置項(xiàng)目初始化工作完成了，后續(xù)就可以開始基于該項(xiàng)目添加服務(wù)生產(chǎn)者和消費(fèi)者完成源碼級(jí)的調(diào)試了：
二、服務(wù)提供者搭建
1. 調(diào)測(cè)架構(gòu)說(shuō)明
本質(zhì)上nacos是作為服務(wù)注冊(cè)中心和服務(wù)配置中心，本系列文章將會(huì)針對(duì)服務(wù)注冊(cè)和服務(wù)配置的工作原理展開探討，所以我們需要搭建一套具備如下條件的調(diào)測(cè)環(huán)境：
- 一個(gè)單機(jī)模式的nacos作為服務(wù)注冊(cè)中心和配置中心(本系列更多強(qiáng)調(diào)是服務(wù)注冊(cè)中心)。
- 兩個(gè)服務(wù)提供者nacos-provider分別對(duì)應(yīng)9001和9002端口提供負(fù)載均衡的服務(wù)調(diào)用。
- 一個(gè)服務(wù)消費(fèi)者nacos-consumer對(duì)應(yīng)8080端口通過(guò)nacos感知nacos-provider信息發(fā)起服務(wù)調(diào)用。
對(duì)應(yīng)的邏輯架構(gòu)圖如下所示：
2. 基于源碼環(huán)境創(chuàng)建nacos-provider子模塊
首先基于該項(xiàng)目創(chuàng)建一個(gè)nacos-provider子模塊，然后注明必要的外部版本信息，以筆者為例，項(xiàng)目中需要用到spring boot和Lombok等基礎(chǔ)依賴，所以就在properties注明這些配置版本方便復(fù)用：
<artifactId>nacos-provider</artifactId>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<lombok.version>1.18.30</lombok.version>
<spring-boot.version>2.7.6</spring-boot.version>
</properties>3. 引入核心依賴配置
如下圖所示，SCA通過(guò)reversion等信息配置當(dāng)前項(xiàng)目的版本號(hào)，所以在引入源碼包中的組件時(shí)，我們也可以使用這個(gè)標(biāo)簽控制版本信息：
于是筆者的服務(wù)注冊(cè)中心和配置中心的版本配置就如下所示可以看到筆者的配置有如下處理：
- 使用spring loadbalancer作為負(fù)載均衡器，棄用已停止維護(hù)的ribbon。
- nacos作為服務(wù)注冊(cè)和配置中心。
- openfeign作為服務(wù)調(diào)用。
<!-- nacos服務(wù)注冊(cè) -->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
<!-- 使用spring loadbalancer作為負(fù)載均衡器，棄用ribbon -->
<exclusions>
<exclusion>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
</exclusion>
</exclusions>
<version>${revision}</version>
</dependency>
<!-- nacos配置中心 -->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
<version>${revision}</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
<version>${spring-boot.version}</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--No spring.config.import set-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-bootstrap</artifactId>
<version>3.1.5</version>
</dependency>
<!--負(fù)載均衡器 替換ribbon使用-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-loadbalancer</artifactId>
<version>3.1.5</version>
</dependency>
<!-- 服務(wù)調(diào)用 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
<version>3.1.5</version>
</dependency>
<!--lombok 考慮弄成provided-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>${lombok.version}</version>
</dependency>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
</dependency>
<!--工具類-->
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.8.24</version>
</dependency>
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-okhttp</artifactId>
<version>10.10.1</version>
</dependency>4. 啟用服務(wù)發(fā)現(xiàn)
對(duì)應(yīng)的我們?cè)诜?wù)提供者的啟動(dòng)類上注明EnableDiscoveryClient開啟服務(wù)發(fā)現(xiàn)：
@SpringBootApplication
@EnableDiscoveryClient//啟用服務(wù)發(fā)現(xiàn)
public class NacosProviderApplication {
public static void main(String[] args) {
SpringApplication.run(NacosProviderApplication.class, args);
}
}5. 指明注冊(cè)中心
隨后我們?cè)赼pplication.properties然指明服務(wù)名稱為nacos-provider，并通過(guò)spring.cloud.nacos.discovery.server-addr
# 指定服務(wù)名稱為
spring.application.name=nacos-provider
# 指定nacos地址用于服務(wù)注冊(cè)和服務(wù)發(fā)現(xiàn)
spring.cloud.nacos.discovery.server-addr=127.0.0.1:88486. 編寫測(cè)試接口
作為服務(wù)提供者，我們可以先寫一個(gè)簡(jiǎn)單的測(cè)試接口provide，返回當(dāng)前服務(wù)提供者的服務(wù)名和端口號(hào)，便于服務(wù)消費(fèi)者觀測(cè)當(dāng)前調(diào)用到哪個(gè)服務(wù)上：
@Autowired
private Environment env;
@GetMapping("/provide")
public String provide() {
Map<String, String> map = new HashMap<>();
//服務(wù)名稱
map.put("provider", env.getProperty("spring.application.name"));
//服務(wù)端口號(hào)，用于后續(xù)調(diào)用時(shí)查看結(jié)果使用
map.put("port", env.getProperty("server.port"));
return JSONUtil.toJsonStr(map);
}7. 基于不同端口號(hào)啟動(dòng)服務(wù)提供者
完成基本服務(wù)配置之后，我們就要通過(guò)不同端口啟動(dòng)服務(wù)提供者，首先點(diǎn)擊services啟動(dòng)服務(wù)配置項(xiàng)：
然后點(diǎn)擊add service添加服務(wù)：
然后我們通過(guò)JVM參數(shù)-Dserver.port=9001指明服務(wù)1的端口號(hào)為9001：
完成后將服務(wù)啟動(dòng)鍵入curl 127.0.0.1:9001/provide進(jìn)行連通性測(cè)試，如果輸出結(jié)果如下則說(shuō)明服務(wù)提供者的接口是可用的：
{"provider":"nacos-provider","port":"9001"}同理服務(wù)2配置為9002啟動(dòng)：
三、服務(wù)消費(fèi)者環(huán)境搭建
1. 開啟服務(wù)發(fā)現(xiàn)和Feign客戶端功能
完成這些配置之后，我們不妨創(chuàng)建一個(gè)項(xiàng)目作為服務(wù)消費(fèi)者，依賴和服務(wù)提供者一致，這里就不多做贅述，這里我們給出服務(wù)消費(fèi)者需要強(qiáng)調(diào)的配置：
- 在服務(wù)消費(fèi)者上添加@EnableDiscoveryClient開啟服務(wù)發(fā)現(xiàn)。
- 添加EnableFeignClients在服務(wù)啟動(dòng)過(guò)程中掃描@FeignClient注解類并為其生成動(dòng)態(tài)代理。
@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class NacosConsumerApplication {
public static void main(String[] args) {
SpringApplication.run(NacosConsumerApplication.class, args);
}
}22. 針對(duì)nacos-provider聲明feign接口
然后我們就可以編寫一個(gè)feign接口調(diào)用服務(wù)提供者的服務(wù)了：
@FeignClient(name = "nacos-provider")//告知調(diào)用的服務(wù)名為nacos-provider
public interface NacosProvider {
/**
* 指明通過(guò)get請(qǐng)求調(diào)用/provide
* @return
*/
@GetMapping("/provide")
String provide();
}3. 測(cè)試接口
為了方便測(cè)試這里我們直接，我們直接創(chuàng)建一個(gè)test接口調(diào)用服務(wù)提供者的feign接口：
@RestController
public class TestController {
@Resource
private NacosProvider nacosProvider;
@GetMapping("/test")
public String test() {
//發(fā)起對(duì)服務(wù)提供者的遠(yuǎn)程調(diào)用
return nacosProvider.provide();
}
}4. 啟動(dòng)測(cè)試
此時(shí)我們就可以直接將4個(gè)服務(wù)啟動(dòng)，它們分別是：
- 服務(wù)注冊(cè)中心nacos
- 兩個(gè)服務(wù)提供者nacos-provider分別對(duì)應(yīng)9001和9002端口。
- 一個(gè)服務(wù)消費(fèi)者nacos-consumer采用默認(rèn)的8080端口。
完成啟動(dòng)后，我們調(diào)用消費(fèi)者的接口地址即127.0.0.1:8080/test，可以看到服務(wù)成功完成調(diào)用：
然后進(jìn)行兩次調(diào)用，可以發(fā)現(xiàn)服務(wù)消費(fèi)者調(diào)用了不同的nacos-provider，自此我們的調(diào)測(cè)環(huán)境搭建完成：
C:\Users\sharkchili>curl 127.0.0.1:8080/test
{"provider":"nacos-provider","port":"9002"}
C:\Users\sharkchili>curl 127.0.0.1:8080/test
{"provider":"nacos-provider","port":"9001"}
