JavaScript 專題之陣列扁平化

冴羽發表於2017-07-21
JavaScript陣列

JavaScript 專題系列第九篇，講解如何實現陣列的扁平化，並解析 underscore 的 _.flatten 原始碼

扁平化

陣列的扁平化，就是將一個巢狀多層的陣列 array (巢狀可以是任何層數)轉換為只有一層的陣列。

舉個例子，假設有個名為 flatten 的函式可以做到陣列扁平化，效果就會如下：

var arr = [1, [2, [3, 4]]];
console.log(flatten(arr)) // [1, 2, 3, 4]複製程式碼

知道了效果是什麼樣的了，我們可以去嘗試著寫這個 flatten 函式了

遞迴

我們最一開始能想到的莫過於迴圈陣列元素，如果還是一個陣列，就遞迴呼叫該方法：

// 方法 1
var arr = [1, [2, [3, 4]]];

function flatten(arr) {
    var result = [];
    for (var i = 0, len = arr.length; i < len; i++) {
        if (Array.isArray(arr[i])) {
            result = result.concat(flatten(arr[i]))
        }
        else {
            result.push(arr[i])
        }
    }
    return result;
}


console.log(flatten(arr))複製程式碼

toString

如果陣列的元素都是數字，那麼我們可以考慮使用 toString 方法，因為：

[1, [2, [3, 4]]].toString() // "1,2,3,4"複製程式碼

呼叫 toString 方法，返回了一個逗號分隔的扁平的字串，這時候我們再 split，然後轉成數字不就可以實現扁平化了嗎？

// 方法2
var arr = [1, [2, [3, 4]]];

function flatten(arr) {
    return arr.toString().split(',').map(function(item){
        return +item
    })
}

console.log(flatten(arr))複製程式碼

然而這種方法使用的場景卻非常有限，如果陣列是 [1, '1', 2, '2'] 的話，這種方法就會產生錯誤的結果。

reduce

既然是對陣列進行處理，最終返回一個值，我們就可以考慮使用 reduce 來簡化程式碼：

// 方法3
var arr = [1, [2, [3, 4]]];

function flatten(arr) {
    return arr.reduce(function(prev, next){
        return prev.concat(Array.isArray(next) ? flatten(next) : next)
    }, [])
}

console.log(flatten(arr))複製程式碼

...

ES6 增加了擴充套件運算子，用於取出引數物件的所有可遍歷屬性，拷貝到當前物件之中：

var arr = [1, [2, [3, 4]]];
console.log([].concat(...arr)); // [1, 2, [3, 4]]複製程式碼

我們用這種方法只可以扁平一層，但是順著這個方法一直思考，我們可以寫出這樣的方法：

// 方法4
var arr = [1, [2, [3, 4]]];

function flatten(arr) {

    while (arr.some(item => Array.isArray(item))) {
        arr = [].concat(...arr);
    }

    return arr;
}

console.log(flatten(arr))複製程式碼

undercore

那麼如何寫一個抽象的扁平函式，來方便我們的開發呢，所有又到了我們抄襲 underscore 的時候了~

在這裡直接給出原始碼和註釋，但是要注意，這裡的 flatten 函式並不是最終的 _.flatten，為了方便多個 API 進行呼叫，這裡對扁平進行了更多的配置。

/**
 * 陣列扁平化
 * @param  {Array} input   要處理的陣列
 * @param  {boolean} shallow 是否只扁平一層
 * @param  {boolean} strict  是否嚴格處理元素，下面有解釋
 * @param  {Array} output  這是為了方便遞迴而傳遞的引數
 * 原始碼地址：https://github.com/jashkenas/underscore/blob/master/underscore.js#L528
 */
function flatten(input, shallow, strict, output) {

    // 遞迴使用的時候會用到output
    output = output || [];
    var idx = output.length;

    for (var i = 0, len = input.length; i < len; i++) {

        var value = input[i];
        // 如果是陣列，就進行處理
        if (Array.isArray(value)) {
            // 如果是隻扁平一層，遍歷該陣列，依此填入 output
            if (shallow) {
                var j = 0, len = value.length;
                while (j < len) output[idx++] = value[j++];
            }
            // 如果是全部扁平就遞迴，傳入已經處理的 output，遞迴中接著處理 output
            else {
                flatten(value, shallow, strict, output);
                idx = output.length;
            }
        }
        // 不是陣列，根據 strict 的值判斷是跳過不處理還是放入 output
        else if (!strict){
            output[idx++] = value;
        }
    }

    return output;

}複製程式碼

解釋下 strict，在程式碼裡我們可以看出，當遍歷陣列元素時，如果元素不是陣列，就會對 strict 取反的結果進行判斷，如果設定 strict 為 true，就會跳過不進行任何處理，這意味著可以過濾非陣列的元素，舉個例子：

var arr = [1, 2, [3, 4]];
console.log(flatten(arr, true, true)); // [3, 4]複製程式碼

那麼設定 strict 到底有什麼用呢？不急，我們先看下 shallow 和 strct 各種值對應的結果：

  • shallow true + strict false ：正常扁平一層
  • shallow false + strict false ：正常扁平所有層
  • shallow true + strict true ：去掉非陣列元素
  • shallow false + strict true ： 返回一個[]

我們看看 underscore 中哪些方法呼叫了 flatten 這個基本函式：

_.flatten

首先就是 _.flatten：

_.flatten = function(array, shallow) {
    return flatten(array, shallow, false);
};複製程式碼

在正常的扁平中，我們並不需要去掉非陣列元素。

_.union

接下來是 _.union：

該函式傳入多個陣列，然後返回傳入的陣列的並集，

舉個例子：

_.union([1, 2, 3], [101, 2, 1, 10], [2, 1]);
=> [1, 2, 3, 101, 10]複製程式碼

如果傳入的引數並不是陣列，就會將該引數跳過：

_.union([1, 2, 3], [101, 2, 1, 10], 4, 5);
=> [1, 2, 3, 101, 10]複製程式碼

為了實現這個效果，我們可以將傳入的所有陣列扁平化，然後去重，因為只能傳入陣列，這時候我們直接設定 strict 為 true，就可以跳過傳入的非陣列的元素。

// 關於 unique 可以檢視《JavaScript專題之陣列去重》[](https://github.com/mqyqingfeng/Blog/issues/27)
function unique(array) {
   return Array.from(new Set(array));
}

_.union = function() {
    return unique(flatten(arguments, true, true));
}複製程式碼

_.difference

是不是感覺折騰 strict 有點用處了，我們再看一個 _.difference：

語法為：

_.difference(array, *others)

效果是取出來自 array 陣列，並且不存在於多個 other 陣列的元素。跟 _.union 一樣，都會排除掉不是陣列的元素。

舉個例子：

_.difference([1, 2, 3, 4, 5], [5, 2, 10], [4], 3);
=> [1, 3]複製程式碼

實現方法也很簡單，扁平 others 的陣列，篩選出 array 中不在扁平化陣列中的值：

function difference(array, ...rest) {

    rest = flatten(rest, true, true);

    return array.filter(function(item){
        return rest.indexOf(item) === -1;
    })
}複製程式碼

注意，以上實現的細節並不是完全按照 underscore，具體細節的實現感興趣可以檢視原始碼。

專題系列

JavaScript專題系列目錄地址：github.com/mqyqingfeng…。

JavaScript專題系列預計寫二十篇左右，主要研究日常開發中一些功能點的實現，比如防抖、節流、去重、型別判斷、拷貝、最值、扁平、柯里、遞迴、亂序、排序等，特點是研(chao)究(xi) underscore 和 jQuery 的實現方式。

如果有錯誤或者不嚴謹的地方，請務必給予指正，十分感謝。如果喜歡或者有所啟發，歡迎 star，對作者也是一種鼓勵。

相關文章