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，對做者也是一種鼓勵。