Nacos 源碼環(huán)境搭建與調(diào)試指南
近期因?yàn)閭€(gè)人需要，需要搭建一套nacos源碼環(huán)境來(lái)調(diào)測(cè)了解如下3個(gè)模塊的工作機(jī)制：
- 服務(wù)啟動(dòng)時(shí)注冊(cè)至nacos。
- nacos服務(wù)端處理下線請(qǐng)求。
- nacos服務(wù)消費(fèi)者負(fù)載均衡算法。
本質(zhì)個(gè)人技術(shù)驅(qū)動(dòng)，遂以此文作為nacos系列的第一篇文章，記錄一下筆者搭建nacos源碼調(diào)試環(huán)境的步驟。
一、詳解源碼環(huán)境搭建步驟
1. 拉取指定版本nacos源碼
因?yàn)楣P者使用的nacos源碼版本為2.3.2，所以到GitHub拉取時(shí)通過(guò)--branch指定tag為2.3.2，對(duì)應(yīng)的指令如下所示，讀者可以按需調(diào)整版本拉取源碼：
git clone --branch 2.3.0 git@github.com:alibaba/nacos.git由此我們就可從github上拿到2.3.2版本的nacos的完整代碼：
2. 依賴加載并完成編譯與數(shù)據(jù)庫(kù)配置
在完成必要的maven依賴加載之后，由于nacos需要通過(guò)maven插件生成特定的代碼，否者就可以出現(xiàn)下圖所示的異常：
所以我們需要通過(guò)IDEA的maven插件進(jìn)行編譯，讓nacos中的特定插件運(yùn)行生成所需要代碼：
等待片刻后，如果輸出編譯成功則說(shuō)明我們的項(xiàng)目基本初始化完成了：
3. 配置數(shù)據(jù)庫(kù)
因?yàn)楣P者是通過(guò)MySQL來(lái)統(tǒng)一存儲(chǔ)nacos的管理信息，所以筆者專門(mén)創(chuàng)建了一個(gè)名為nacos的數(shù)據(jù)庫(kù)，然后將distribution模塊下的mysql-schema.sql中的初始化數(shù)據(jù)刷到數(shù)據(jù)庫(kù)中：
刷完腳本之后，對(duì)應(yīng)的數(shù)據(jù)庫(kù)就會(huì)有如下幾張數(shù)據(jù)表：
最后將console模塊下的application.properties配置為上述的數(shù)據(jù)庫(kù)連接：
以筆者為例，因?yàn)閿?shù)據(jù)庫(kù)配置在本地且名為nacos，所以對(duì)應(yīng)的配置如下：
## Count of DB:
db.num=1
## Connect URL of DB:
db.url.0=jdbc:mysql://127.0.0.1:3306/nacos
db.user=xxxxxx
db.password=xxxxxxx4. 設(shè)置單機(jī)模式并啟動(dòng)測(cè)試
默認(rèn)情況下nacos是采用集群模式的方式運(yùn)行，因?yàn)楣P者需要單機(jī)模式運(yùn)行，所以需要通過(guò)JVM參數(shù)指定運(yùn)行模式為單機(jī)模式：
-Dnacos.standalnotallow=true對(duì)應(yīng)的配置截圖示例如下所示：
此時(shí)我們通過(guò)Nacos將其啟動(dòng)，如果可以正常進(jìn)入nacos訪問(wèn)頁(yè)面則說(shuō)明本次配置成功：
二、服務(wù)提供者和服務(wù)消費(fèi)者
1. 調(diào)測(cè)架構(gòu)說(shuō)明
本質(zhì)上nacos是作為服務(wù)注冊(cè)中心和服務(wù)配置中心，本系列文章將會(huì)針對(duì)服務(wù)注冊(cè)和服務(wù)配置的工作原理展開(kāi)探討，所以我們需要搭建一套具備如下條件的調(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)圖如下所示：
三、服務(wù)提供者環(huán)境搭建
1. 依賴配置
先來(lái)搭建服務(wù)提供者，結(jié)合版本兼容性我們首先給出對(duì)應(yīng)SCA、Spring Boot以及JDK等版本信息：
<properties>
<java.version>11</java.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<lombok.version>1.18.30</lombok.version>
<spring-cloud.version>2021.0.5</spring-cloud.version>
<spring-cloud-alibaba.verison>2021.0.5.0</spring-cloud-alibaba.verison>
<spring-boot.version>2.7.6</spring-boot.version>
</properties>基于上述的版本，我們引入如下依賴，可以看到筆者的配置有如下處理：
- 使用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>
<!-- 使用Loadbalancer作為負(fù)載均衡器，棄用已停止維護(hù)的ribbon -->
<exclusions>
<exclusion>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
</exclusion>
</exclusions>
</dependency>
<!-- nacos配置中心 -->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
<!--No spring.config.import set-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-bootstrap</artifactId>
</dependency>
<!--負(fù)載均衡器loadbalancer 替換ribbon使用-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-loadbalancer</artifactId>
</dependency>
<!-- openfeign作為服務(wù)調(diào)用 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-okhttp</artifactId>
<version>10.10.1</version>
</dependency>啟用服務(wù)發(fā)現(xiàn)
對(duì)應(yīng)的我們?cè)诜?wù)提供者的啟動(dòng)類上注明EnableDiscoveryClient開(kāi)啟服務(wù)發(fā)現(xiàn)：
@SpringBootApplication
@EnableDiscoveryClient//啟用服務(wù)發(fā)現(xiàn)
public class NacosProviderApplication {
public static void main(String[] args) {
SpringApplication.run(NacosProviderApplication.class, args);
}
}2. 指明注冊(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:88483. 編寫(xiě)測(cè)試接口
作為服務(wù)提供者，我們可以先寫(xiě)一個(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);
}4. 基于不同端口號(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)：
四、小結(jié)
自此我們完成nacos源碼環(huán)境的搭建，后續(xù)筆者會(huì)針對(duì)nacos服務(wù)注冊(cè)、服務(wù)發(fā)現(xiàn)等核心流程進(jìn)行詳盡的源碼分析，希望對(duì)你有幫助。
