一種介面依賴關係分層方案

1、背景

到店商詳迭代過程中，需要提供的對外能力越來越多，如預約日曆、附近門店、為你推薦等。這其中不可避免會出現多個上層能力依賴同一個底層介面的場景。最初採用的方案是對外API入口進來後獲取對應的能力，並行呼叫多項能力，由能力層呼叫對應的資料鏈路，進行業務處理。然而，隨著接入功能的增多，這種情況導致了底層資料服務的重複呼叫，如商品設定資訊，在一次API呼叫過程中重複調了3次，當流量增大或能力項愈多時，對底層服務的壓力會成倍增加。

正值618大促，各方介面的呼叫都會大幅度增加。通過梳理介面依賴關係來減少重複呼叫，對本系統而言，降低了呼叫資料介面時的執行緒佔用次數，可以有效降級CPU。對呼叫方來說，減少了呼叫次數，可減少呼叫方的資源消耗，保障底層服務的穩定性。

原始呼叫方式：

2、優化

基於上述問題，採用底層介面依賴分層呼叫的方案。梳理介面依賴關係，逐層向上呼叫，注入資料，如此將同一介面的呼叫抽取到某層，僅呼叫一次，即可在整條鏈路使用。

改進呼叫方式：

只要分層後即可在每層採用多執行緒並行的方式呼叫，因為同一層級中的介面無先後依賴關係。

3、如何分層？

接下來，如何梳理介面層級關係就至關重要。

介面梳理分層流程如下：

第一步：構建層級結構

首先獲取到能力層依賴項並遍歷，然後呼叫生成資料節點方法。方法流程如下：構建當前節點，檢測迴圈依賴（存在迴圈依賴會導致棧溢位），獲取並遍歷節點依賴項，遞迴生成子節點，存放子節點。

第二步：節點平鋪

定義Map維護平鋪結構，呼叫平鋪方法。方法流程如下：遍歷層級結構，判斷當前節點是否已存在map中，存在時與原節點比較將層級大的節點放入（去除重複項），不存在時直接放入即可。然後處理子節點，遞迴呼叫平鋪方法，處理所有節點。

第三步：分層（分組排序）

流處理平鋪結構，處理層級分組，儲存在TreeMap中維護自然排序。對應key中的資料節點Set需用多執行緒並行呼叫，以保證鏈路呼叫時間

1 首先，定義資料結構用於維護呼叫鏈路

Q1：為什麼需要定義祖先節點？

A1：為了判斷介面是否存在迴圈依賴。如果介面存在迴圈依賴而不檢測將導致呼叫棧溢位，故而在呼叫過程中要避免並檢測迴圈依賴。在遍歷子節點過程中，如果發現當前節點的祖先已經包含當前子節點，說明依賴關係出現了環路，即迴圈依賴，此時拋異常終止後續流程避免棧溢位。

public class DataNode {
    /**
     * 節點名稱
     */
    private String name;
    /**
     * 節點層級
     */
    private int level;
    /**
     * 祖先節點
     */
    private List<String> ancestors;
    /**
     * 子節點
     */
    private List<DataNode> children;
}

2 獲取能力層的介面依賴，並生成對應的資料節點

Q1：生成節點時如何維護層級？

A1：從能力層依賴開始，層級從1遞加。每獲取一次底層依賴，底層依賴所生成的節點層級即父節點層級+1。

/**
 * 構建層級結構
 *
 * @param handlers 介面依賴
 * @return 資料節點集
 */
private List<DataNode> buildLevel(Set<String> handlers) {
    List<DataNode> result = Lists.newArrayList();

    for (String next : handlers) {
        DataNode dataNode = generateNode(next, 1, null, null);
        result.add(dataNode);
    }
    return result;
}

/**
 * 生成資料節點
 *
 * @param name 節點名稱
 * @param level 節點層級
 * @param ancestors 祖先節點（除父輩）
 * @param parent 父節點
 * @return DataNode 資料節點
 */
private DataNode generateNode(String name, int level, List<String> ancestors, String parent) {
    AbstractInfraHandler abstractInfraHandler = abstractInfraHandlerMap.get(name);
    Set<String> infraDependencyHandlerNames = abstractInfraHandler.getInfraDependencyHandlerNames();
    // 根節點
    DataNode dataNode = new DataNode(name);
    dataNode.setLevel(level);
    dataNode.putAncestor(ancestors, parent);
    if (CollectionUtils.isNotEmpty(dataNode.getAncestors()) && dataNode.getAncestors().contains(name)) {
        throw new IllegalStateException("依賴關係中存在迴圈依賴，請檢查以下handler：" + JsonUtil.toJsonString(dataNode.getAncestors()));
    }
    if (CollectionUtils.isNotEmpty(infraDependencyHandlerNames)) {
        // 存在子節點，子節點層級+1
        for (String next : infraDependencyHandlerNames) {
            DataNode child = generateNode(next, level + 1, dataNode.getAncestors(), name);
            dataNode.putChild(child);
        }
    }
    return dataNode;
}

層級結構如下：

3 資料節點平鋪（遍歷出所有後代節點）

Q1：如何處理介面依賴過程中的重複項？

A1：遍歷所有的子節點，將所有子節點平鋪到一層，平鋪時如果節點已經存在，比較層級，保留層級大的即可（層級大說明依賴位於更底層，呼叫時要優先呼叫）。

/**
 * 層級結構平鋪
 *
 * @param dataNodes 資料節點
 * @param dataNodeMap 平鋪結構
 */
private void flatteningNodes(List<DataNode> dataNodes, Map<String, DataNode> dataNodeMap) {
    if (CollectionUtils.isNotEmpty(dataNodes)) {
        for (DataNode dataNode : dataNodes) {
            DataNode dataNode1 = dataNodeMap.get(dataNode.getName());
            if (Objects.nonNull(dataNode1)) {
                // 存入層級大的即可，避免重複
                if (dataNode1.getLevel() < dataNode.getLevel()) {
                    dataNodeMap.put(dataNode.getName(), dataNode);
                }
            } else {
                dataNodeMap.put(dataNode.getName(), dataNode);
            }
            // 處理子節點
            flatteningNodes(dataNode.getChildren(), dataNodeMap);
        }
    }
}

平鋪結構如下：

4 分層（分組排序）

Q1：如何分層？

A1：節點平鋪後已經去重，此時藉助TreeMap的自然排序特性將節點按照層級分組即可。

/**
 * @param dataNodeMap 平鋪結構
 * @return 分層結構
 */
private TreeMap<Integer, Set<DataNode>> processLevel(Map<String, DataNode> dataNodeMap) {
    return dataNodeMap.values().stream().collect(Collectors.groupingBy(DataNode::getLevel, TreeMap::new, Collectors.toSet()))
}

分層如下：

1.根據分層TreeMap的key倒序即為呼叫的層級順序

對應key中的資料節點Set需用多執行緒並行呼叫，以保證鏈路呼叫時間

4、分層級呼叫

梳理出呼叫關係並分層後，使用並行編排工具呼叫即可。這裡梳理的層級關係，level越大，表示越優先呼叫。

這裡以京東內部並行編排框架為例，說明呼叫流程：

/**
 * 構建編排流程
 *
 * @param infraDependencyHandlers 依賴介面
 * @param workerExecutor 並行執行緒
 * @return 執行資料
 */
public Sirector<InfraContext> buildSirector(Set<String> infraDependencyHandlers, ThreadPoolExecutor workerExecutor) {
    Sirector<InfraContext> sirector = new Sirector<>(workerExecutor);
    long start = System.currentTimeMillis();
    // 依賴順序與執行順序相反
    TreeMap<Integer, Set<DataNode>> levelNodes;
    TreeMap<Integer, Set<DataNode>> cacheLevelNodes = localCacheManager.getValue("buildSirector");
    if (Objects.nonNull(cacheLevelNodes)) {
        levelNodes = cacheLevelNodes;
    } else {
        levelNodes = getLevelNodes(infraDependencyHandlers);
        ExecutorUtil.executeVoid(asyncTpExecutor, () -> localCacheManager.putValue("buildSirector", levelNodes));
    }
    log.info("buildSirector 梳理依賴關係耗時：{}", System.currentTimeMillis() - start);
    // 最底層介面執行
    Integer firstLevel = levelNodes.lastKey();
    EventHandler[] beginHandlers = levelNodes.get(firstLevel).stream().map(node -> abstractInfraHandlerMap.get(node.getName())).toArray(EventHandler[]::new);
    EventHandlerGroup group = sirector.begin(beginHandlers);

    Integer lastLevel = levelNodes.firstKey();
    for (int i = firstLevel - 1; i >= lastLevel; i--) {
        EventHandler[] thenHandlers = levelNodes.get(i).stream().map(node -> abstractInfraHandlerMap.get(node.getName())).toArray(EventHandler[]::new);
        group.then(thenHandlers);
    }
    return sirector;
}

5、個人思考

作為接入內部RPC、Http介面實現業務處理的專案，在使用過程中要關注呼叫鏈路上的資源複用，尤其長鏈路的呼叫，要深入考慮記憶體資源的利用以及對底層服務的壓力。
要關注對外服務介面與底層資料介面的響應時差，分析呼叫邏輯與流程是否合理，是否存在優化項。
多執行緒並行呼叫多個平行資料介面時，如何使得各個執行緒的耗時方差儘可能小？

作者：京東零售王江波

來源：京東雲開發者社群