Nacos源碼閱讀方法
為什么我會經(jīng)常閱讀源碼呢，因為閱讀源碼能讓你更加接近大佬，哈哈，這是我瞎扯的。
這篇文章將會帶大家閱讀Nacos源碼 以及 教大家閱讀源碼的技巧，我們正式開始吧！
先給大家獻上一張我梳理的高清源碼圖，方便大家對nacos的源碼有一個整體上的認識。
有了這張圖，我們就很容易去看nacos源碼了。
如何找切入點
首先我們得要找一個切入點進入到nacos源碼中，那么就從nacos依賴入手
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>進入這個依賴文件，會發(fā)現(xiàn)它又依賴了一個組件：
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-alibaba-nacos-discovery</artifactId>
</dependency>進入依賴之后，我們發(fā)現(xiàn)它長這樣：
從這張圖中，我們發(fā)現(xiàn)了一個熟悉的配置文件spring.factories，這是sringboot自動裝配的必備文件
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ com.alibaba.cloud.nacos.discovery.NacosDiscoveryAutoConfiguration,\ com.alibaba.cloud.nacos.ribbon.RibbonNacosAutoConfiguration,\ com.alibaba.cloud.nacos.endpoint.NacosDiscoveryEndpointAutoConfiguration,\ com.alibaba.cloud.nacos.registry.NacosServiceRegistryAutoConfiguration,\ com.alibaba.cloud.nacos.discovery.NacosDiscoveryClientConfiguration,\ com.alibaba.cloud.nacos.discovery.reactive.NacosReactiveDiscoveryClientConfiguration,\ com.alibaba.cloud.nacos.discovery.configclient.NacosConfigServerAutoConfiguration org.springframework.cloud.bootstrap.BootstrapConfiguration=\ com.alibaba.cloud.nacos.discovery.configclient.NacosDiscoveryClientConfigServiceBootstrapConfiguration
因為這張主要說的是服務(wù)注冊源碼，所以我們可以只用關(guān)注(NacosServiceRegistryAutoConfiguration)自動裝配文件
public class NacosServiceRegistryAutoConfiguration {
@Bean
public NacosServiceRegistry nacosServiceRegistry(
NacosDiscoveryProperties nacosDiscoveryProperties) {
return new NacosServiceRegistry(nacosDiscoveryProperties);
}
@ConditionalOnBean(AutoServiceRegistrationProperties.class)
public NacosRegistration nacosRegistration(
NacosDiscoveryProperties nacosDiscoveryProperties,
ApplicationContext context) {
return new NacosRegistration(nacosDiscoveryProperties, context);
public NacosAutoServiceRegistration nacosAutoServiceRegistration(
NacosServiceRegistry registry,
AutoServiceRegistrationProperties autoServiceRegistrationProperties,
NacosRegistration registration) {
return new NacosAutoServiceRegistration(registry,
autoServiceRegistrationProperties, registration);
}
我們看到的是三個bean注入，這里給大家介紹一個看源碼的小技巧：自動裝配的文件中申明的bean類，我們只需要看帶有auto的bean，這個往往是入口;NacosAutoServiceRegistration 帶有auto，我們點進去看看里面都有什么：
@Override
protected void register() {
if (!this.registration.getNacosDiscoveryProperties().isRegisterEnabled()) {
log.debug("Registration disabled.");
return;
}
if (this.registration.getPort() < 0) {
this.registration.setPort(getPort().get());
}
super.register();
}
里面有一個register()方法，我在這里打個斷點，因為我猜測這個就是注冊的入口，我現(xiàn)在使用debug模式，啟動一個服務(wù)，看它會不會調(diào)用這個方法：
客戶端注冊
這里貼上我debug后，進入register方法的調(diào)用鏈截圖
看到這個調(diào)用鏈，看到一個onApplicationEvent的回調(diào)方法，找到這個方法所在的類AbstractAutoServiceRegistration
這個類繼承了ApplicationListener這個多播器監(jiān)聽器，spring啟動之后，會發(fā)布多播器事件，然后回調(diào)實現(xiàn)多播器組件的onApplicationEvent方法，我們從這個方法開始分析：
public void onApplicationEvent(WebServerInitializedEvent event) {
bind(event); // 綁定端口，并啟動
}
@Deprecated
public void bind(WebServerInitializedEvent event) {
// 設(shè)置端口
this.port.compareAndSet(0, event.getWebServer().getPort());
// 啟動客戶端注冊組件
this.start();
}
public void start() {
// 省略分支代碼
// 調(diào)用注冊
register()；
}
因為springcloud提供了多種注冊中心擴展，但是我們這里只引用了nacos注冊中心，所以這里直接調(diào)用的是NacosServiceRegistry的register方法：
public void register(Registration registration) {
// 省略分支代碼
// 獲取服務(wù)id
String serviceId = registration.getServiceId();
// 獲取組配置
String group = nacosDiscoveryProperties.getGroup();
// 封裝服務(wù)實例
Instance instance = getNacosInstanceFromRegistration(registration);
// 調(diào)用 命名服務(wù)的 registerInstance方法 注冊實例
namingService.registerInstance(serviceId, group, instance);
}
進入到registerInstance方法
public void registerInstance(String serviceName, String groupName, Instance instance) throws NacosException {
if (instance.isEphemeral()) {
// 省略分支代碼
// 與服務(wù)端建立心跳，默認每隔5秒定時發(fā)送新跳包
this.beatReactor.addBeatInfo(NamingUtils.getGroupedName(serviceName, groupName), beatInfo);
}
// 通過http方式向服務(wù)端發(fā)送注冊請求
this.serverProxy.registerService(NamingUtils.getGroupedName(serviceName, groupName), groupName, instance);
}
serverproxy通過調(diào)用對http進行封裝的reapi方法，向服務(wù)端接口("/nacos/v1/ns/instance")發(fā)送請求，
public void registerService(String serviceName, String groupName, Instance instance) throws NacosException {
LogUtils.NAMING_LOGGER.info("[REGISTER-SERVICE] {} registering service {} with instance: {}", new Object[]{this.namespaceId, serviceName, instance});
Map<String, String> params = new HashMap(9);
params.put("namespaceId", this.namespaceId);
params.put("serviceName", serviceName);
params.put("groupName", groupName);
params.put("clusterName", instance.getClusterName());
params.put("ip", instance.getIp());
params.put("port", String.valueOf(instance.getPort()));
params.put("weight", String.valueOf(instance.getWeight()));
params.put("enable", String.valueOf(instance.isEnabled()));
params.put("healthy", String.valueOf(instance.isHealthy()));
params.put("ephemeral", String.valueOf(instance.isEphemeral()));
params.put("metadata", JSON.toJSONString(instance.getMetadata()));
this.reqAPI(UtilAndComs.NACOS_URL_INSTANCE, params, (String)"POST");
}
我們知道nacos經(jīng)常是以集群形式部署的，那客戶端是如何選擇其中一個節(jié)點發(fā)送呢，肯定得實現(xiàn)負載均衡的邏輯，我們點擊reqAPI，看它是如何實現(xiàn)的
if (servers != null && !servers.isEmpty()) {
Random random = new Random(System.currentTimeMillis());
// 隨機獲取一個索引，servers保存的是所有nacos節(jié)點地址
int index = random.nextInt(servers.size());
// 遍歷所有節(jié)點，根據(jù)index值，從servers中找到對應(yīng)位置的server，進行請求調(diào)用，如果調(diào)用成功則返回，否則依次往后遍歷，直到請求成功
for(int i = 0; i < servers.size(); ++i) {
String server = (String)servers.get(index);
try {
return this.callServer(api, params, server, method);
} catch (NacosException var11) {
exception = var11;
LogUtils.NAMING_LOGGER.error("request {} failed.", server, var11);
} catch (Exception var12) {
exception = var12;
LogUtils.NAMING_LOGGER.error("request {} failed.", server, var12);
}
// index+1 然后取模 是保證index不會越界
index = (index + 1) % servers.size();
}
throw new IllegalStateException("failed to req API:" + api + " after all servers(" + servers + ") tried: " + ((Exception)exception).getMessage());
}
到這里，客戶端注冊的代碼已經(jīng)分析完了，不過這還不是本篇的結(jié)束，我們還得繼續(xù)分析服務(wù)端是如何處理客戶端發(fā)送過來的注冊請求：
服務(wù)端處理客戶端注冊請求
如果需要查看服務(wù)端源碼的話，則需要將nacos源碼下下來 下載地址
我們從服務(wù)注冊api接口地址（/nacos/v1/ns/instance），可以找到對應(yīng)的controller為（com.alibaba.nacos.naming.controllers.InstanceController）
因為注冊實例發(fā)送的是post請求，所以直接找被postmapping注解的register方法
@CanDistro
@PostMapping
public String register(HttpServletRequest request) throws Exception {
// 獲取服務(wù)名
String serviceName = WebUtils.required(request, CommonParams.SERVICE_NAME);
// 獲取命名空間id
String namespaceId = WebUtils.optional(request, CommonParams.NAMESPACE_ID, Constants.DEFAULT_NAMESPACE_ID);
// 注冊實例
serviceManager.registerInstance(namespaceId, serviceName, parseInstance(request));
return "ok";
}
我們點擊進入到registerInstance方法：
public void registerInstance(String namespaceId, String serviceName, Instance instance) throws NacosException {
createEmptyService(namespaceId, serviceName, instance.isEphemeral());
Service service = getService(namespaceId, serviceName);
if (service == null) {
throw new NacosException(NacosException.INVALID_PARAM,
"service not found, namespace: " + namespaceId + ", service: " + serviceName);
}
// 執(zhí)行添加實例的操作
addInstance(namespaceId, serviceName, instance.isEphemeral(), instance);
}
分析
在nacos中，注冊實例后，還需要將注冊信息同步到其他節(jié)點，所有在nacos中存在兩種同步模式AP和CP，ap和cp主要體現(xiàn)在集群中如何同步注冊信息到其它集群節(jié)點的實現(xiàn)方式上；
nacos通過ephemeral 字段值來決定是使用ap方式同步還是cp方式同步，默認使用的的ap方式同步注冊信息。com.alibaba.nacos.naming.core.ServiceManager.addInstance()
public void addInstance(String namespaceId, String serviceName, boolean ephemeral, Instance... ips) throws NacosException {
// 生成服務(wù)的key
String key = KeyBuilder.buildInstanceListKey(namespaceId, serviceName, ephemeral);
// 獲取服務(wù)
Service service = getService(namespaceId, serviceName);
// 使用同步鎖處理
synchronized (service) {
List<Instance> instanceList = addIpAddresses(service, ephemeral, ips);
Instances instances = new Instances();
instances.setInstanceList(instanceList);
// 調(diào)用consistencyService.put 處理同步過來的服務(wù)
consistencyService.put(key, instances);
}
}
我們在進入到consistencyService.put方法中
點擊put方法時，會看到有三個實現(xiàn)類，根據(jù)上下文(或者debug方式)，可以推斷出這里引用的是DelegateConsistencyServiceImpl實現(xiàn)類
@Override
public void put(String key, Record value) throws NacosException {
// 進入到這個put方法后，就可以知道應(yīng)該使用ap方式同步還是cp方式同步
mapConsistencyService(key).put(key, value);
}
從下面的方法中 可以判斷通過key來判斷使用ap還是cp來同步注冊信息，其中key是由ephemeral字段組成；
private ConsistencyService mapConsistencyService(String key) {
return KeyBuilder.matchEphemeralKey(key) ? ephemeralConsistencyService : persistentConsistencyService;
}
AP 方式同步的流程（ephemeralConsistencyService） 本地服務(wù)器處理注冊信息&將注冊信息同步到其它節(jié)點
@Override
public void put(String key, Record value) throws NacosException {
// 處理本地注冊列表
onPut(key, value);
// 添加阻塞任務(wù)，同步信息到其他集群節(jié)點
taskDispatcher.addTask(key);
}
處理本地注冊節(jié)點
nacos將key做為一個task，添加到notifer中阻塞隊列tasks中，并且使用單線程執(zhí)行，其中notifer是初始化的時候，作為一個線程被放到線程池中（線程池只設(shè)置了一個核心線程）；
這里有一個點需要告訴大家：在大多數(shù)分布式框架，都會采用單線程的阻塞隊列來處理耗時的任務(wù)，一方面解決并發(fā)問題，另一方面能夠解決并發(fā)帶來的寫寫沖突問題。
線程中的主要處理邏輯就是，循環(huán)讀取阻塞隊列中的內(nèi)容，然后處理注冊信息，更新到內(nèi)存注冊列表中。
同步注冊信息到其他集群節(jié)點
nacos同樣也是把注冊key作為一個task存放到 TaskDispatcher 中的taskShedule阻塞隊列中，然后開啟線程循環(huán)讀取阻塞隊列:
@Override
public void run() {
List<String> keys = new ArrayList<>();
while (true) {
String key = queue.poll(partitionConfig.getTaskDispatchPeriod(),
TimeUnit.MILLISECONDS);
// 省略判斷代碼
// 添加同步的key
keys.add(key);
// 計數(shù)
dataSize++;
// 判斷同步的key大小是否等于 批量同步設(shè)置的限量 或者 判斷據(jù)上次同步時間 是否大于 配置的間隔周期，如果滿足任意一個，則開始同步
if (dataSize == partitionConfig.getBatchSyncKeyCount() ||
(System.currentTimeMillis() - lastDispatchTime) > partitionConfig.getTaskDispatchPeriod()) {
// 遍歷所有集群節(jié)點，直接調(diào)用http進行同步
for (Server member : dataSyncer.getServers()) {
if (NetUtils.localServer().equals(member.getKey())) {
continue;
}
SyncTask syncTask = new SyncTask();
syncTask.setKeys(keys);
syncTask.setTargetServer(member.getKey());
if (Loggers.DISTRO.isDebugEnabled() && StringUtils.isNotBlank(key)) {
Loggers.DISTRO.debug("add sync task: {}", JSON.toJSONString(syncTask));
}
dataSyncer.submit(syncTask, 0);
}
// 記錄本次同步時間
lastDispatchTime = System.currentTimeMillis();
// 計數(shù)清零
dataSize = 0;
}
}
}
}
使用ap方式作同步的過程很簡單，但是這里面有兩種設(shè)計思路來解決單個key同步的問題：
如果有新的key推送上來，nacos就發(fā)起一次同步，這會造成網(wǎng)絡(luò)資源浪費，因為每次同步的就只有一個key或者幾個key；
同步少量的key解決方案: 只有積累到指定數(shù)量的key，才發(fā)起批量同步距離上次同步時間超過配置的限制時間，則忽略key數(shù)量，直接發(fā)起同步 CP 方式同步的流程（RaftConsistencyServiceImpl）
cp模式追求的是數(shù)據(jù)一致性，為了數(shù)據(jù)一致性，那么肯定得選出一個leader，由leader首先同步，然后再由leader通知follower前來獲取最新的注冊節(jié)點(或者主動推送給follower)
nacos使用raft協(xié)議來進行選舉leader，來實現(xiàn)cp模式。
同樣進入到 RaftConsistencyServiceImpl的put方法
@Override
public void put(String key, Record value) throws NacosException {
try {
raftCore.signalPublish(key, value);
} catch (Exception e) {
Loggers.RAFT.error("Raft put failed.", e);
throw new NacosException(NacosException.SERVER_ERROR, "Raft put failed, key:" + key + ", value:" + value, e);
}
}
進入到raftCore.signalPublish方法中，我提取幾個關(guān)鍵的代碼
// 首先判斷當前nacos節(jié)點是否是leader，如果不是leader，則獲取leader節(jié)點的ip，然后將請求轉(zhuǎn)發(fā)到leader處理，否則往下走
if (!isLeader()) {
JSONObject params = new JSONObject();
params.put("key", key);
params.put("value", value);
Map<String, String> parameters = new HashMap<>(1);
parameters.put("key", key);
raftProxy.proxyPostLarge(getLeader().ip, API_PUB, params.toJSONString(), parameters);
return;
}
同樣采用同樣隊列的方式，去處理本地注冊列表
onPublish(datum, peers.local());
public void onPublish(Datum datum, RaftPeer source) throws Exception {
// 添加同步key任務(wù)到阻塞隊列中
notifier.addTask(datum.key, ApplyAction.CHANGE);
Loggers.RAFT.info("data added/updated, key={}, term={}", datum.key, local.term);
}
遍歷所有集群節(jié)點，發(fā)送http同步請求
for (final String server : peers.allServersIncludeMyself()) {
// 如果是leader，則不進行同步
if (isLeader(server)) {
latch.countDown();
continue;
}
// 組裝url 發(fā)送同步請求到其它集群節(jié)點
final String url = buildURL(server, API_ON_PUB);
HttpClient.asyncHttpPostLarge(url, Arrays.asList("key=" + key), content, new AsyncCompletionHandler<Integer>() {
@Override
public Integer onCompleted(Response response) throws Exception {
if (response.getStatusCode() != HttpURLConnection.HTTP_OK) {
Loggers.RAFT.warn("[RAFT] failed to publish data to peer, datumId={}, peer={}, http code={}",
datum.key, server, response.getStatusCode());
return 1;
}
latch.countDown();
return 0;
}
@Override
public STATE onContentWriteCompleted() {
return STATE.CONTINUE;
}
});
}
到此，nacos服務(wù)注冊及服務(wù)實例同步的主干源碼已經(jīng)分析完了。
總結(jié)
對于剛開始接觸nacos源碼的同學(xué)，可以先把頭上的圖多看幾遍，然后對照著源碼找到對應(yīng)的位置 ，最后結(jié)合圖再結(jié)合本文，整體連貫的看下來，相信會有很大收獲的；雖然閱讀源碼的過程很痛苦，但是你只要堅持下來了，掌握到了閱讀源碼的技巧，你就會發(fā)現(xiàn)再難的源碼，你都能把它啃下來；后面我會專門寫一篇教你如何高效閱讀源碼的文章，希望對于剛接觸源碼的同學(xué)能有所幫助。
到此這篇關(guān)于Nacos源碼閱讀方法的文章就介紹到這了,更多相關(guān)Nacos源碼閱讀內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
這篇文章主要給大家介紹了關(guān)于Java核心教程之常見時間日期的相關(guān)資料，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-02-02
IDEA創(chuàng)建javaee項目依賴war exploded變紅失效的解決方案
在使用IntelliJ IDEA創(chuàng)建JavaEE項目時,可能會遇到Tomcat部署的warexploded文件出現(xiàn)問題,解決方法是首先刪除有問題的warexploded依賴,然后根據(jù)圖示重新導(dǎo)入項目,此外,調(diào)整虛擬路徑有時也能有效解決問題2024-09-09
下面小編就為大家?guī)硪黄趈ava List中進行模糊查詢的實現(xiàn)方法。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2021-08-08
Java多線程工具CompletableFuture的使用教程
CompletableFuture實現(xiàn)了CompletionStage接口和Future接口，前者是對后者的一個擴展，增加了異步回調(diào)、流式處理、多個Future組合處理的能力。本文就來詳細講講CompletableFuture的使用方式，需要的可以參考一下2022-08-08
這篇文章主要介紹了SpringBoot攔截器讀取流后不能再讀取的問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-10-10
解讀@Bean和@Autowired、@Resource之間的區(qū)別
這篇文章主要介紹了@Bean和@Autowired、@Resource之間的區(qū)別及說明,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2025-03-03
SpringBoot導(dǎo)出Excel的四種方式小結(jié)
近期接到了一個小需求,要將系統(tǒng)中的數(shù)據(jù)導(dǎo)出為Excel,且能將Excel數(shù)據(jù)導(dǎo)入到系統(tǒng),對于大多數(shù)研發(fā)人員來說,這算是一個最基本的操作了,本文就給大家總結(jié)一下SpringBoot導(dǎo)出Excel的四種實現(xiàn)方式,需要的朋友可以參考下2024-12-12
springboot+maven多環(huán)境動態(tài)配置及編譯失敗的解決方案(步驟詳解)
這篇文章主要介紹了springboot+maven多環(huán)境動態(tài)配置及編譯失敗的解決方案,本文通過實例圖文相結(jié)合給大家介紹的非常詳細,對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友參考下吧2023-11-11
這篇文章主要為大家詳細介紹了java基于RMI遠程過程調(diào)用，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-08-08
這篇文章主要為大家詳細介紹了SpringBoot實現(xiàn)單文件上傳，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2019-11-11