Spring Cloud 2.2.2 源碼之三十三nacos客戶端LongPollingRunnable配置更新一

ClientWorker的checkConfigInfo

先得再說下這個，這個方法是每10毫秒執行一次，但是並不是會一直去執行新的LongPollingRunnable任務，是根據監聽器的數量決定要不要再啓動一個LongPollingRunnable，每個LongPollingRunnable默認可以負責3000個監聽器的輪詢。所以一般就只是開啓了一個，因爲是Math.ceil向上取整，最開始就會開啓。

    public void checkConfigInfo() {
        // 分任務 根據監聽器數量開啓任務，默認一個任務3000個監聽器
        int listenerSize = cacheMap.get().size();
        // 向上取整爲批數
        int longingTaskCount = (int) Math.ceil(listenerSize / ParamUtil.getPerTaskConfigSize());
        if (longingTaskCount > currentLongingTaskCount) {
            for (int i = (int) currentLongingTaskCount; i < longingTaskCount; i++) {
                // 要判斷任務是否在執行 這塊需要好好想想。 任務列表現在是無序的。變化過程可能有問題
                executorService.execute(new LongPollingRunnable(i));
            }
            currentLongingTaskCount = longingTaskCount;
        }
    }

LongPollingRunnable的run

這個就是整個輪詢獲取配置信息的過程，首先會遍歷所有的CacheData，找出是當前任務的加入到一個集合裏，這裏如果多的話會不會效率比較低啊，可能想辦法直接放在任務中比較好吧。然後如果是本次任務的就先檢查本地配置，如果有改變的話就要通知監聽器。然後去請求服務器獲取配置信息，如果是有在初始化的CacheData，那服務器就會立即返回，否則會被掛起，這個原因就是爲了不進行頻繁的空輪詢，又能實現動態配置，只要在掛起的時間段內有改變，就可以理解響應給客戶端。獲取完之後再檢查有沒改變，有的話也要通知，然後繼續調度當前任務。

 @Override
        public void run() {

            List<CacheData> cacheDatas = new ArrayList<CacheData>();
            //是否是在初始化的CacheData，會影響服務器是否掛起或者立即返回
            List<String> inInitializingCacheList = new ArrayList<String>();
            try {
                // check failover config
                for (CacheData cacheData : cacheMap.get().values()) {
                    if (cacheData.getTaskId() == taskId) {//屬於當前長輪詢任務的
                        cacheDatas.add(cacheData);
                        try {
                            checkLocalConfig(cacheData);
                            if (cacheData.isUseLocalConfigInfo()) {//用本地配置
                                cacheData.checkListenerMd5();//有改變的話會通知
                            }
                        } catch (Exception e) {
                            LOGGER.error("get local config info error", e);
                        }
                    }
                }
                //獲取有變化的配置列表dataid+group,訪問的url是/listener
                // check server config
                List<String> changedGroupKeys = checkUpdateDataIds(cacheDatas, inInitializingCacheList);
                LOGGER.info("get changedGroupKeys:" + changedGroupKeys);

                for (String groupKey : changedGroupKeys) {
                    String[] key = GroupKey.parseKey(groupKey);
                    String dataId = key[0];
                    String group = key[1];
                    String tenant = null;
                    if (key.length == 3) {
                        tenant = key[2];
                    }
                    try {//有更新的就獲取一次配置
                        String[] ct = getServerConfig(dataId, group, tenant, 3000L);
                        CacheData cache = cacheMap.get().get(GroupKey.getKeyTenant(dataId, group, tenant));
                        cache.setContent(ct[0]);//設置配置內容
                        if (null != ct[1]) {
                            cache.setType(ct[1]);//設置配置類型
                        }
                       ...
                    } catch (NacosException ioe) {
                        ...
                    }
                }
                for (CacheData cacheData : cacheDatas) {//不是初始化中的或者初始化集合裏存在的
                    if (!cacheData.isInitializing() || inInitializingCacheList
                        .contains(GroupKey.getKeyTenant(cacheData.dataId, cacheData.group, cacheData.tenant))) {
                        cacheData.checkListenerMd5();//檢查是否有變化，有變化就通知
                        cacheData.setInitializing(false);//請求過了後就設置爲不在初始化中，這樣就會被掛起，如果服務器配置有更新，就會立即返回，這樣就可以實現動態配置更新，又不會太多的空輪詢消耗
                    }
                }
                inInitializingCacheList.clear();

                executorService.execute(this);

            } catch (Throwable e) {

                LOGGER.error("longPolling error : ", e);
                executorService.schedule(this, taskPenaltyTime, TimeUnit.MILLISECONDS);
            }
        }
    }

checkLocalConfig檢查本地配置

如果不沒用本地文件，但是文件存在或者如果用本地文件，本地文件並有更新，就獲取內容，設置版本，設置setUseLocalConfigInfo(true)通知標記返回。如果用本地文件，但是不存在，不用設置通知，直接返回。

 //檢查配置
    private void checkLocalConfig(CacheData cacheData) {
        final String dataId = cacheData.dataId;
        final String group = cacheData.group;
        final String tenant = cacheData.tenant;
        File path = LocalConfigInfoProcessor.getFailoverFile(agent.getName(), dataId, group, tenant);
        // 不用本地配置，但是本地配置存在，獲取本地的
        // 沒有 -> 有
        if (!cacheData.isUseLocalConfigInfo() && path.exists()) {
            String content = LocalConfigInfoProcessor.getFailover(agent.getName(), dataId, group, tenant);
            String md5 = MD5.getInstance().getMD5String(content);
            cacheData.setUseLocalConfigInfo(true);//設置用本地的
            cacheData.setLocalConfigInfoVersion(path.lastModified());//設置版本
            cacheData.setContent(content);

            LOGGER.warn("[{}] [failover-change] failover file created. dataId={}, group={}, tenant={}, md5={}, content={}",
                agent.getName(), dataId, group, tenant, md5, ContentUtils.truncateContent(content));
            return;
        }
        // 用本地配置文件，但是不存在，直接返回
        // 有 -> 沒有。不通知業務監聽器，從server拿到配置後通知。
        if (cacheData.isUseLocalConfigInfo() && !path.exists()) {
            cacheData.setUseLocalConfigInfo(false);
            LOGGER.warn("[{}] [failover-change] failover file deleted. dataId={}, group={}, tenant={}", agent.getName(),
                dataId, group, tenant);
            return;
        }
        // 用本地，存在，版本有變更，更新
        // 有變更
        if (cacheData.isUseLocalConfigInfo() && path.exists()
            && cacheData.getLocalConfigInfoVersion() != path.lastModified()) {
            String content = LocalConfigInfoProcessor.getFailover(agent.getName(), dataId, group, tenant);
            String md5 = MD5.getInstance().getMD5String(content);
            cacheData.setUseLocalConfigInfo(true);
            cacheData.setLocalConfigInfoVersion(path.lastModified());
            cacheData.setContent(content);
            LOGGER.warn("[{}] [failover-change] failover file changed. dataId={}, group={}, tenant={}, md5={}, content={}",
                agent.getName(), dataId, group, tenant, md5, ContentUtils.truncateContent(content));
        }
    }

checkUpdateDataIds獲取有改變的配置文件

這個是把所有的CacheData的相關信息都連起來，一次性批量請求。但是其中有個比較重要的就是inInitializingCacheList，這個表示裏面是否有正在初始化的CacheData，如果有的話後面會設置一個標記，是的服務器不會掛起請求，會立即響應。這裏的響應只是告訴你哪些是有變化的，不會把內容給你，後面還得請求內容。

List<String> checkUpdateDataIds(List<CacheData> cacheDatas, List<String> inInitializingCacheList) throws IOException {
        StringBuilder sb = new StringBuilder();//把配置信息都連起來，一次請求
        for (CacheData cacheData : cacheDatas) {
            if (!cacheData.isUseLocalConfigInfo()) {//不用本地的
                sb.append(cacheData.dataId).append(WORD_SEPARATOR);
                sb.append(cacheData.group).append(WORD_SEPARATOR);
                if (StringUtils.isBlank(cacheData.tenant)) {
                    sb.append(cacheData.getMd5()).append(LINE_SEPARATOR);
                } else {
                    sb.append(cacheData.getMd5()).append(WORD_SEPARATOR);
                    sb.append(cacheData.getTenant()).append(LINE_SEPARATOR);
                }
                if (cacheData.isInitializing()) {
                    // cacheData 首次出現在cacheMap中&首次check更新
                    inInitializingCacheList
                        .add(GroupKey.getKeyTenant(cacheData.dataId, cacheData.group, cacheData.tenant));
                }
            }
        }
        boolean isInitializingCacheList = !inInitializingCacheList.isEmpty();//是否是初始化的獲取標記
        return checkUpdateConfigStr(sb.toString(), isInitializingCacheList);
    }

checkUpdateDataIds服務器獲取

這裏就會根據isInitializingCacheList來設置一個標記，讓服務器判斷是否要掛起，請求的url是/v1/cs/configs/listener，這裏超時增加了，默認變成了45秒，就是爲了應對掛起和檢查配置文件變更。內部怎麼請求的前面講過了，就不多說了。這裏根據情況還要設置服務器健康狀態setHealthServer，然後拿到改變的配置文件結果解析後返回。

   List<String> checkUpdateConfigStr(String probeUpdateString, boolean isInitializingCacheList) throws IOException {

        List<String> params = new ArrayList<String>(2);
        params.add(Constants.PROBE_MODIFY_REQUEST);
        params.add(probeUpdateString);

        List<String> headers = new ArrayList<String>(2);
        headers.add("Long-Pulling-Timeout");
        headers.add("" + timeout);


        if (isInitializingCacheList) {//是初始化的會設置一個請求頭標記
            headers.add("Long-Pulling-Timeout-No-Hangup");
            headers.add("true");
        }

        if (StringUtils.isBlank(probeUpdateString)) {
            return Collections.emptyList();
        }

        try {
          
            // 增加超時時間，防止被掛起，只有初始化的時候isInitializingCacheList=true不會掛起，應該是服務器看了請求頭Long-Pulling-Timeout-No-Hangup纔不會掛起
            long readTimeoutMs = timeout + (long) Math.round(timeout >> 1);//45秒
            HttpResult result = agent.httpPost(Constants.CONFIG_CONTROLLER_PATH + "/listener", headers, params,
                agent.getEncode(), readTimeoutMs);

            if (HttpURLConnection.HTTP_OK == result.code) {
                setHealthServer(true);
                return parseUpdateDataIdResponse(result.content);
            } else {
                setHealthServer(false);
                LOGGER.error("[{}] [check-update] get changed dataId error, code: {}", agent.getName(), result.code);
            }
        } catch (IOException e) {
            setHealthServer(false);
            LOGGER.error("[" + agent.getName() + "] [check-update] get changed dataId exception", e);
            throw e;
        }
        return Collections.emptyList();
    }

下篇繼續。

好了，今天就到這裏了，希望對學習理解有幫助，大神看見勿噴，僅爲自己的學習理解，能力有限，請多包涵