手撕Nacos源碼(先撕客戶端源碼)

来源:https://www.cnblogs.com/jiagooushi/archive/2022/07/07/16454636.html
-Advertisement-
Play Games

Nacos源碼剖析 Nacos源碼有很多值得我們學習的地方,為了深入理解Nacos,我們剖析源碼,分析如下2個知識點: 1:Nacos對註冊中心的訪問原理 2:Nacos註冊服務處理流程 源碼環境搭建 1、從官方項目上克隆下來,並且檢出 1.4.1 版本,導入idea。nacos源碼環境搭建起來比較 ...


Nacos源碼剖析

Nacos源碼有很多值得我們學習的地方,為了深入理解Nacos,我們剖析源碼,分析如下2個知識點:

1:Nacos對註冊中心的訪問原理

2:Nacos註冊服務處理流程

源碼環境搭建

1、從官方項目上克隆下來,並且檢出 1.4.1 版本,導入idea。nacos源碼環境搭建起來比較輕鬆,幾乎不會報什麼錯誤,導入後編譯安裝到本地環境即可

file

2、找到config 模塊中找到 \resources\META-INF\nacos-db.sql,在本地mysql中創建資料庫nacos-config,將該腳本導入執行創建表。

3、找到console模塊下的配置文件application.properties,修改相關配置

#*************** Config Module Related Configurations ***************#
### If use MySQL as datasource:
spring.datasource.platform=mysql

### Count of DB:
db.num=1

### Connect URL of DB:
db.url.0=jdbc:mysql://127.0.0.1:3306/nacos-config?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true&useUnicode=true&useSSL=false&serverTimezone=UTC
db.user.0=nacos
db.password.0=nacos

4、找到console模塊下的啟動類,啟動nacos的服務端,啟動時添加啟動參數,指定啟動模式為非集群啟動

-Dnacos.standalone=true

file

5、訪問本地的nacos:http://localhost:8848/nacos

至此,源碼環境搭建成功!

nacos客戶端

首先要搞清楚:nacos的客戶端其實在我們自己的服務里,我們引入了nacos的相關坐標依賴,nacos客戶端以jar包的形式在我們的服務中工作

file

對於nacos的客戶端,它都要幫我們實現什麼功能呢?

它的主要工作有:服務註冊、服務發現、服務下線操作、服務訂閱操作等相關操作。

客戶端與註冊中心服務端的交互,主要集中在服務註冊、服務下線、服務發現、訂閱某個服務,其實使用最多的就是服務註冊和服務發現,下麵我會從源碼的角度分析一下這四個功能。

在Nacos源碼中nacos-examplecom.alibaba.nacos.example.NamingExample類分別演示了這4個功能的操作,我們可以把它當做入口,代碼如下:

public class NamingExample {

    public static void main(String[] args) throws NacosException {

        Properties properties = new Properties();
        properties.setProperty("serverAddr", System.getProperty("serverAddr"));
        properties.setProperty("namespace", System.getProperty("namespace"));

        NamingService naming = NamingFactory.createNamingService(properties);
        //服務註冊
        naming.registerInstance("nacos.test.3", "11.11.11.11", 8888, "TEST1");
        naming.registerInstance("nacos.test.3", "2.2.2.2", 9999, "DEFAULT");
        //服務發現
        System.out.println(naming.getAllInstances("nacos.test.3"));
        //服務下線
        naming.deregisterInstance("nacos.test.3", "2.2.2.2", 9999, "DEFAULT");
        System.out.println(naming.getAllInstances("nacos.test.3"));
        //服務訂閱
        Executor executor = new ThreadPoolExecutor(1, 1, 0L, TimeUnit.MILLISECONDS, new LinkedBlockingQueue<Runnable>(),
                new ThreadFactory() {
                    @Override
                    public Thread newThread(Runnable r) {
                        Thread thread = new Thread(r);
                        thread.setName("test-thread");
                        return thread;
                    }
                });

        naming.subscribe("nacos.test.3", new AbstractEventListener() {

            //EventListener onEvent is sync to handle, If process too low in onEvent, maybe block other onEvent callback.
            //So you can override getExecutor() to async handle event.
            @Override
            public Executor getExecutor() {
                return executor;
            }

            @Override
            public void onEvent(Event event) {
                System.out.println(((NamingEvent) event).getServiceName());
                System.out.println(((NamingEvent) event).getInstances());
            }
        });
    }
}

1.1.1 服務註冊

我們沿著案例中的服務註冊方法調用找到nacos-api中的NamingService.registerInstance()並找到它的實現類和方法com.alibaba.nacos.client.naming.NacosNamingService,代碼如下:

/***
 * 服務註冊
 * @param serviceName 服務名字
 * @param ip          服務IP
 * @param port        服務埠
 * @param clusterName 集群名字
 * @throws NacosException
 */
@Override
public void registerInstance(String serviceName, String ip, int port, String clusterName) throws NacosException {
    registerInstance(serviceName, Constants.DEFAULT_GROUP, ip, port, clusterName);
}

@Override
public void registerInstance(String serviceName, String groupName, String ip, int port, String clusterName)
        throws NacosException {
    //設置實例IP:Port,預設權重為1.0
    Instance instance = new Instance();
    instance.setIp(ip);
    instance.setPort(port);
    instance.setWeight(1.0);
    instance.setClusterName(clusterName);
    //註冊實例
    registerInstance(serviceName, groupName, instance);
}

@Override
public void registerInstance(String serviceName, Instance instance) throws NacosException {
    registerInstance(serviceName, Constants.DEFAULT_GROUP, instance);
}

/***
 * 實例註冊
 * @param serviceName name of service
 * @param groupName   group of service
 * @param instance    instance to register
 * @throws NacosException
 */
@Override
public void registerInstance(String serviceName, String groupName, Instance instance) throws NacosException {
    NamingUtils.checkInstanceIsLegal(instance);
    String groupedServiceName = NamingUtils.getGroupedName(serviceName, groupName);
    //該欄位表示註冊的實例是否是臨時實例還是持久化實例。
    // 如果是臨時實例,則不會在 Nacos 服務端持久化存儲,需要通過上報心跳的方式進行包活,
    // 如果一段時間內沒有上報心跳,則會被 Nacos 服務端摘除。
    if (instance.isEphemeral()) {
        //為註冊服務設置一個定時任務獲取心跳信息,預設為5s彙報一次
        BeatInfo beatInfo = beatReactor.buildBeatInfo(groupedServiceName, instance);
        beatReactor.addBeatInfo(groupedServiceName, beatInfo);
    }
    //註冊到服務端
    serverProxy.registerService(groupedServiceName, groupName, instance);
}

註冊主要做了兩件事,第一件事:為註冊的服務設置一個定時心跳任務。 第二件事:將服務註冊到服務端。

1:啟動一個定時心跳任務,時間間隔為5s,如果服務正常,不做處理,如果不正常,重新註冊

2:發送http請求給註冊中心服務端,調用服務註冊介面,註冊服務

上面代碼我們可以看到定時任務添加,但並未完全看到遠程請求,serverProxy.registerService()方法如下,會先封裝請求參數,接下來調用reqApi()reqApi()最後會調用callServer(),代碼如下:

public void registerService(String serviceName, String groupName, Instance instance) throws NacosException {
    
    NAMING_LOGGER.info("[REGISTER-SERVICE] {} registering service {} with instance: {}", namespaceId, serviceName,
            instance);
    //封裝Http請求參數
    final Map<String, String> params = new HashMap<String, String>(16);
    params.put(CommonParams.NAMESPACE_ID, namespaceId);
    params.put(CommonParams.SERVICE_NAME, serviceName);
    params.put(CommonParams.GROUP_NAME, groupName);
    params.put(CommonParams.CLUSTER_NAME, 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", JacksonUtils.toJson(instance.getMetadata()));
    //執行Http請求
    reqApi(UtilAndComs.nacosUrlInstance, params, HttpMethod.POST);
}


/***
*執行遠程調用
**/
public String callServer(String api, Map<String, String> params, Map<String, String> body, String curServer,
        String method) throws NacosException {
    long start = System.currentTimeMillis();
    long end = 0;
    injectSecurityInfo(params);
    //封裝請求頭部
    Header header = builderHeader();
    
    //請求是Http還是Https協議
    String url;
    if (curServer.startsWith(UtilAndComs.HTTPS) || curServer.startsWith(UtilAndComs.HTTP)) {
        url = curServer + api;
    } else {
        if (!IPUtil.containsPort(curServer)) {
            curServer = curServer + IPUtil.IP_PORT_SPLITER + serverPort;
        }
        url = NamingHttpClientManager.getInstance().getPrefix() + curServer + api;
    }

    try {
        //執行遠程請求,並獲取結果集
        HttpRestResult<String> restResult = nacosRestTemplate
                .exchangeForm(url, header, Query.newInstance().initParams(params), body, method, String.class);
        end = System.currentTimeMillis();
        
        MetricsMonitor.getNamingRequestMonitor(method, url, String.valueOf(restResult.getCode()))
                .observe(end - start);
        //結果集解析
        if (restResult.ok()) {
            return restResult.getData();
        }
        if (HttpStatus.SC_NOT_MODIFIED == restResult.getCode()) {
            return StringUtils.EMPTY;
        }
        throw new NacosException(restResult.getCode(), restResult.getMessage());
    } catch (Exception e) {
        NAMING_LOGGER.error("[NA] failed to request", e);
        throw new NacosException(NacosException.SERVER_ERROR, e);
    }
}

執行遠程Http請求的對象是NacosRestTemplate,該對象就是封裝了普通的Http請求,大家可以自己查閱一下。

1.1.2 服務發現

兩個入口:

1、NamingService.getAllInstances(serviceName)

我們沿著案例中的服務發現方法調用找到nacos-api中的NamingService.getAllInstances()並找到它的實現類和方法com.alibaba.nacos.client.naming.NacosNamingService.getAllInstances(),代碼如下:

@Override
public List<Instance> getAllInstances(String serviceName, String groupName, List<String> clusters,
        boolean subscribe) throws NacosException {

    ServiceInfo serviceInfo;
    /*預設true->獲取服務實例*/
    if (subscribe) {
        //從本地緩存中獲取,如果本地緩存不存在從服務端拉取
        //本地緩存會存儲在HostReactor.serviceInfoMap中,它是一個Map對象
        serviceInfo = hostReactor.getServiceInfo(NamingUtils.getGroupedName(serviceName, groupName),
                StringUtils.join(clusters, ","));
    } else {
        serviceInfo = hostReactor
                .getServiceInfoDirectlyFromServer(NamingUtils.getGroupedName(serviceName, groupName),
                        StringUtils.join(clusters, ","));
    }
    List<Instance> list;
    if (serviceInfo == null || CollectionUtils.isEmpty(list = serviceInfo.getHosts())) {
        return new ArrayList<Instance>();
    }
    return list;
}

上面的代碼調用了hostReactor.getServiceInfo()方法,該方法會先調用getServiceInfo0()方法從本地緩存獲取數據,緩存沒有數據,就構建實例更新到Nacos,並從Nacos中獲取最新數據,getServiceInfo0()方法源碼如下:

public ServiceInfo getServiceInfo(final String serviceName, final String clusters) {

    NAMING_LOGGER.debug("failover-mode: " + failoverReactor.isFailoverSwitch());
    String key = ServiceInfo.getKey(serviceName, clusters);
    if (failoverReactor.isFailoverSwitch()) {
        return failoverReactor.getService(key);
    }
    /*1。先從本地緩存中獲取服務對象,因為啟動是第一次進來,所以緩存暫不存在*/
    ServiceInfo serviceObj = getServiceInfo0(serviceName, clusters);

    if (null == serviceObj) {
        /*構建服務實例*/
        serviceObj = new ServiceInfo(serviceName, clusters);
        /*將服務實例存放到緩存中*/
        serviceInfoMap.put(serviceObj.getKey(), serviceObj);
        /*更新nacos-上的服務*/
        updatingMap.put(serviceName, new Object());
        /*主動獲取,並且更新到緩存本地,以及已過期的服務更新等*/
        updateServiceNow(serviceName, clusters);
        updatingMap.remove(serviceName);

    } else if (updatingMap.containsKey(serviceName)) {

        if (UPDATE_HOLD_INTERVAL > 0) {
            // hold a moment waiting for update finish
            synchronized (serviceObj) {
                try {
                    serviceObj.wait(UPDATE_HOLD_INTERVAL);
                } catch (InterruptedException e) {
                    NAMING_LOGGER
                            .error("[getServiceInfo] serviceName:" + serviceName + ", clusters:" + clusters, e);
                }
            }
        }
    }
    /*2.開啟定時任務*/
    scheduleUpdateIfAbsent(serviceName, clusters);
    return serviceInfoMap.get(serviceObj.getKey());
}

updateServiceNow(serviceName, clusters);主從從遠程伺服器獲取更新數據,最終會調用updateService()方法,在該方法中完成遠程請求和數據處理,源碼如下:

public void updateService(String serviceName, String clusters) throws NacosException {
    /*獲取本地緩存列表中所存在的服務*/
    ServiceInfo oldService = getServiceInfo0(serviceName, clusters);
    try {
        /*獲取服務以及提供者埠信息,埠等*/
        String result = serverProxy.queryList(serviceName, clusters, pushReceiver.getUdpPort(), false);

        if (StringUtils.isNotEmpty(result)) {
            /*對結果進行處理*/
            processServiceJson(result);
        }
    } finally {
        if (oldService != null) {
            synchronized (oldService) {
                oldService.notifyAll();
            }
        }
    }
}

1.1.3 服務下線

我們沿著案例中的服務下線方法調用找到nacos-api中的NamingService.deregisterInstance()並找到它的實現類和方法NacosNamingService.deregisterInstance(),代碼如下:

@Override
public void deregisterInstance(String serviceName, String groupName, String ip, int port, String clusterName)
        throws NacosException {
    //構建實例信息
    Instance instance = new Instance();
    instance.setIp(ip);
    instance.setPort(port);
    instance.setClusterName(clusterName);
    //服務下線操作
    deregisterInstance(serviceName, groupName, instance);
}

@Override
public void deregisterInstance(String serviceName, String groupName, Instance instance) throws NacosException {
    if (instance.isEphemeral()) {
        //移除心跳信息監測的定時任務
        beatReactor.removeBeatInfo(NamingUtils.getGroupedName(serviceName, groupName), instance.getIp(),
                instance.getPort());
    }
    //發送遠程請求執行服務下線銷毀操作
    serverProxy.deregisterService(NamingUtils.getGroupedName(serviceName, groupName), instance);
}

服務下線方法比較簡單,和服務註冊做的事情正好相反,也做了兩件事,第一件事:不在進行心跳檢測。 第二件事:請求服務端服務下線介面。

1.1.4 服務訂閱

我們可以查看訂閱服務的案例,會先創建一個線程池,接下來會把線程池封裝到監聽器中,而監聽器中可以監聽指定實例信息,代碼如下:

//服務訂閱
Executor executor = new ThreadPoolExecutor(1, 1, 0L, TimeUnit.MILLISECONDS, new LinkedBlockingQueue<Runnable>(),
        new ThreadFactory() {
            @Override
            public Thread newThread(Runnable r) {
                Thread thread = new Thread(r);
                thread.setName("test-thread");
                return thread;
            }
        });

naming.subscribe("nacos.test.3", new AbstractEventListener() {

    //EventListener onEvent is sync to handle, If process too low in onEvent, maybe block other onEvent callback.
    //So you can override getExecutor() to async handle event.
    @Override
    public Executor getExecutor() {
        return executor;
    }
    //讀取監聽到的服務實例
    @Override
    public void onEvent(Event event) {
        System.out.println(((NamingEvent) event).getServiceName());
        System.out.println(((NamingEvent) event).getInstances());
    }
});

我們沿著案例中的服務訂閱方法調用找到nacos-api中的NamingService.subscribe()並找到它的實現類和方法NacosNamingService.deregisterInstance(),代碼如下:

public void subscribe(String serviceName, String clusters, EventListener eventListener) {
    //註冊監聽
    notifier.registerListener(serviceName, clusters, eventListener);
    //獲取並更新服務實例
    getServiceInfo(serviceName, clusters);
}

此時會註冊監聽,註冊監聽,註冊監聽就是將當前的監聽對象信息註入到listenerMap集合中,在監聽對象的指定方法onEvent中可以讀取實例信息,代碼如下:

public void registerListener(String serviceName, String clusters, EventListener listener) {
    String key = ServiceInfo.getKey(serviceName, clusters);
    ConcurrentHashSet<EventListener> eventListeners = listenerMap.get(key);
    if (eventListeners == null) {
        synchronized (lock) {
            eventListeners = listenerMap.get(key);
            if (eventListeners == null) {
                eventListeners = new ConcurrentHashSet<EventListener>();
                listenerMap.put(key, eventListeners);
            }
        }
    }
    //將當前監聽對象放入到集合中,在監聽對象的onEvent中可以讀出對應的實例對象
    eventListeners.add(listener);
}

本文由傳智教育博學谷 - 狂野架構師教研團隊發佈
如果本文對您有幫助,歡迎關註和點贊;如果您有任何建議也可留言評論或私信,您的支持是我堅持創作的動力
轉載請註明出處!


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • package cn.daheww.demo.juc.reentrylock; import sun.misc.Unsafe; import java.lang.reflect.Field; import java.util.concurrent.locks.LockSupport; /** * @ ...
  • 開始之前,pandas中DataFrame刪除對象可能存在幾種情況 1、刪除具體列 2、刪除具體行 3、刪除包含某些數值的行或者列 4、刪除包含某些字元、文字的行或者列 本文就針對這四種情況探討一下如何操作。 數據準備 模擬了一份股票交割的記錄。 In [1]: import pandas as p ...
  • 大家好,我是棧長。 大家都知道,程式員這個職業需要不斷總結,對我印象最深的一件事是,我曾經花了幾天時間解決了一個驚天 bug,而幾個月過後,這個 bug 再次發生了,我知道我之前解決過這個 bug,但再次發生時卻束手無策,怎麼想也想不出當時是怎麼解決的。。 相信大家都有遇到過這樣的場景吧? 所以,自 ...
  • 前言 嗨嘍,大家好呀~這裡是愛看美女的茜茜吶 一周工作,忙忙碌碌,身心疲憊,一到周末,倒頭大睡,懶得做飯,點個外賣。 今天我們要採集的網站呢,是國內知名的網上訂餐平臺~ 我做的是採集商家商品數據信息,你也可以採集另外數據哦~ 準備工作 下麵的儘量跟我保持一致哦~不然有可能會發生報錯 💕 環境使用: ...
  • public static void main(String[] args) { ListFor(2); } public static void ListFor(int a){ //測試list集合遍歷(直接有四種遍歷方式) final ArrayList<Integer> integers = ...
  • 在看題的時候發現了Java8中新加入的日期時間類,覺得這個小哥寫的不錯,自己也跟著練習下。原文地址:https://blog.csdn.net/yy139926/article/details/124298574 前言: Java中1.8之前有date類,date類到了1.8大部分的方法被棄而且da ...
  • 🏏 前言 大家早好、午好、晚好吖~ 再寫python代碼的時候,我們有時候的習慣會導致很繁瑣的結果。 現在我整理以下9個編程好習慣,提供給大家參考一下,希望給你們帶來幫助~ 🏑 1. 提前設計 寫代碼和寫作文一樣,需要有大綱,不然很容易變成"屎山"。 思考業務邏輯和代碼流程,是動手前的準備工作, ...
  • 文件太亂了?不要慌,教你用Python全自動整理到對應分類中~ 主要知識點 文件讀寫 基礎語法 字元串處理 迴圈遍歷 素材 先來看看我這亂七八糟的文件​ 這就看起來亂七八糟了,這要是手動整理,還好,哈哈~ 但是幾百個上千個文件呢? 所以,還得是有個技能傍身才方便啊! 馬上安排! 代碼展示 # 我還給 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...