Nacos 源碼環境搭建與調試指南
近期因為個人需要,需要搭建一套nacos源碼環境來調測了解如下3個模塊的工作機制:
- 服務啟動時注冊至nacos。
- nacos服務端處理下線請求。
- nacos服務消費者負載均衡算法。
本質個人技術驅動,遂以此文作為nacos系列的第一篇文章,記錄一下筆者搭建nacos源碼調試環境的步驟。
一、詳解源碼環境搭建步驟
1. 拉取指定版本nacos源碼
因為筆者使用的nacos源碼版本為2.3.2,所以到GitHub拉取時通過--branch指定tag為2.3.2,對應的指令如下所示,讀者可以按需調整版本拉取源碼:
git clone --branch 2.3.0 git@github.com:alibaba/nacos.git
由此我們就可從github上拿到2.3.2版本的nacos的完整代碼:
2. 依賴加載并完成編譯與數據庫配置
在完成必要的maven依賴加載之后,由于nacos需要通過maven插件生成特定的代碼,否者就可以出現下圖所示的異常:
所以我們需要通過IDEA的maven插件進行編譯,讓nacos中的特定插件運行生成所需要代碼:
等待片刻后,如果輸出編譯成功則說明我們的項目基本初始化完成了:
3. 配置數據庫
因為筆者是通過MySQL來統一存儲nacos的管理信息,所以筆者專門創建了一個名為nacos的數據庫,然后將distribution模塊下的mysql-schema.sql中的初始化數據刷到數據庫中:
刷完腳本之后,對應的數據庫就會有如下幾張數據表:
最后將console模塊下的application.properties配置為上述的數據庫連接:
以筆者為例,因為數據庫配置在本地且名為nacos,所以對應的配置如下:
## 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=xxxxxxx
4. 設置單機模式并啟動測試
默認情況下nacos是采用集群模式的方式運行,因為筆者需要單機模式運行,所以需要通過JVM參數指定運行模式為單機模式:
-Dnacos.standalnotallow=true
對應的配置截圖示例如下所示:
此時我們通過Nacos將其啟動,如果可以正常進入nacos訪問頁面則說明本次配置成功:
二、服務提供者和服務消費者
1. 調測架構說明
本質上nacos是作為服務注冊中心和服務配置中心,本系列文章將會針對服務注冊和服務配置的工作原理展開探討,所以我們需要搭建一套具備如下條件的調測環境:
- 一個單機模式的nacos作為服務注冊中心和配置中心(本系列更多強調是服務注冊中心)。
- 兩個服務提供者nacos-provider分別對應9001和9002端口提供負載均衡的服務調用。
- 一個服務消費者nacos-consumer對應8080端口通過nacos感知nacos-provider信息發起服務調用。
對應的邏輯架構圖如下所示:
三、服務提供者環境搭建
1. 依賴配置
先來搭建服務提供者,結合版本兼容性我們首先給出對應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作為負載均衡器,棄用已停止維護的ribbon。
- nacos作為服務注冊和配置中心。
- openfeign作為服務調用。
<!-- nacos服務注冊 -->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
<!-- 使用Loadbalancer作為負載均衡器,棄用已停止維護的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>
<!--負載均衡器loadbalancer 替換ribbon使用-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-loadbalancer</artifactId>
</dependency>
<!-- openfeign作為服務調用 -->
<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>
啟用服務發現
對應的我們在服務提供者的啟動類上注明EnableDiscoveryClient開啟服務發現:
@SpringBootApplication
@EnableDiscoveryClient//啟用服務發現
public class NacosProviderApplication {
public static void main(String[] args) {
SpringApplication.run(NacosProviderApplication.class, args);
}
}
2. 指明注冊中心
隨后我們在application.properties然指明服務名稱為nacos-provider,并通過spring.cloud.nacos.discovery.server-addr
# 指定服務名稱為
spring.application.name=nacos-provider
# 指定nacos地址用于服務注冊和服務發現
spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848
3. 編寫測試接口
作為服務提供者,我們可以先寫一個簡單的測試接口provide,返回當前服務提供者的服務名和端口號,便于服務消費者觀測當前調用到哪個服務上:
@Autowired
private Environment env;
@GetMapping("/provide")
public String provide() {
Map<String, String> map = new HashMap<>();
//服務名稱
map.put("provider", env.getProperty("spring.application.name"));
//服務端口號,用于后續調用時查看結果使用
map.put("port", env.getProperty("server.port"));
return JSONUtil.toJsonStr(map);
}
4. 基于不同端口號啟動服務提供者
完成基本服務配置之后,我們就要通過不同端口啟動服務提供者,首先點擊services啟動服務配置項:
然后點擊add service添加服務:
然后我們通過JVM參數-Dserver.port=9001指明服務1的端口號為9001:
完成后將服務啟動鍵入curl 127.0.0.1:9001/provide進行連通性測試,如果輸出結果如下則說明服務提供者的接口是可用的:
{"provider":"nacos-provider","port":"9001"}
同理服務2配置為9002啟動:
四、小結
自此我們完成nacos源碼環境的搭建,后續筆者會針對nacos服務注冊、服務發現等核心流程進行詳盡的源碼分析,希望對你有幫助。