因為一次bug的教訓，我決定手撕Nacos源碼（先撕用戶端源碼）

Nacos源碼剖析

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

1:Nacos對注冊中心的通路原理

2:Nacos注冊服務處理流程

源碼環境搭建

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

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

5、通路本地的nacos：http://localhost:8848/nacos

至此，源碼環境搭建成功！

nacos用戶端

首先要搞清楚：nacos的用戶端其實在我們自己的服務裡，我們引入了nacos的相關坐标依賴，nacos用戶端以jar包的形式在我們的服務中工作

對于nacos的用戶端，它都要幫我們實作什麼功能呢？

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

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

在Nacos源碼中

nacos-example

中

com.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());
    }
});

public void subscribe(String serviceName, String clusters, EventListener eventListener) {
    //注冊監聽
    notifier.registerListener(serviceName, clusters, eventListener);
    //擷取并更新服務執行個體
    getServiceInfo(serviceName, clusters);
}

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);
}

因為一次bug的教訓，我決定手撕Nacos源碼（先撕用戶端源碼）

Nacos源碼剖析

源碼環境搭建

nacos用戶端

1.1.1 服務注冊

1.1.2 服務發現

1.1.3 服務下線

1.1.4 服務訂閱

繼續閱讀

報錯：'mysql' 不是内部或外部指令，也不是可運作的程式或批處理檔案。

Ubuntu16.04安裝Apache+MySQL+PHP1. 安裝Apache2. 安裝MySQL3. 安裝PHP4. 安裝phpMyAdmin

Linxu常用指令技巧彙總

ERROR 1 (HY000): Can't create/write to file '/tmp/#sql_4188_1.MYI' (Errcode: 28)

艱難安裝LDAP,SSL認證

《Linux指令行與Shell腳本程式設計大全第2版.布盧姆》pdf

MySQL的4種隔離級别？出現問題

XX系統實施過程問題總結

無元件上傳圖檔到資料庫中，最完整解決方案

【MySQL資料庫】資料庫索引事務1.索引2.事務

neo4j之cypher使用文檔

NOSQL安全攻擊

mybatis_入門程式Mybatis入門

mysql使用source指令導入.sql檔案

登入plsql 報錯 the account is locked --使用者被鎖

SequoiaDB巨杉資料庫C++驅動概述