Lodash 学习笔记（四）：flatten 数组展平

方法说明

flatten 的作用是将数组展平，但是只展平一级。

flatten([1, [2, [3, [4]], 5]])
// => [1, 2, [3, [4]], 5]

源码

function flatten(array) {
  const length = array == null ? 0 : array.length
  return length ? baseFlatten(array, 1) : []
}

首先获取数组的长度，如果数组为 null 或者 undefined，则 length 为 0。
然后判断 length 是否不为 0 。如果为 0 ，则返回空数组，否则调用 baseFlatten ，注意 baseFlatten 第二个参数 depth 为 1 ，即只展开一层。

flatten 方法依赖于 baseFlatten。下面我看再来看一下 baseFlatten 方法的源码。

baseFlatten

import isFlattenable from './isFlattenable.js'

function baseFlatten(array, depth, predicate, isStrict, result) {
  predicate || (predicate = isFlattenable)
  result || (result = [])

  if (array == null) {
    return result
  }

  for (const value of array) {
    if (depth > 0 && predicate(value)) {
      if (depth > 1) {
        baseFlatten(value, depth - 1, predicate, isStrict, result)
      } else {
        result.push(...value)
      }
    } else if (!isStrict) {
      result[result.length] = value
    }
  }
  return result
}

参数说明

/**
 * @param {Array} array 需要展平的数组
 * @param {number} depth 展平的深度
 * @param {boolean} [predicate=isFlattenable] 每次迭代时都会调用的检查函数，回调参数为每次迭代的值，默认为 isFlattenable 函数
 * @param {boolean} [isStrict] 是否严格模式，在严格模式下，迭代的值必须要经过 predicate 函数的检查才存入结果数组中
 * @param {Array} [result=[]] 结果数组
 */

baseFlatten 的源码相对来说还是比较简单：

开始时设置了一些默认值，并对需要展平的数组进行是否为空的判断，为空的话，直接返回结果。
然后使用 for...of 来迭代数组，接下来分两个分支。
- 判断 depth 是否大于 0，并且是否通过检查函数的检查。检查函数默认为 isFlattenable，用来判断是否值是否能够展开。通过检查后，当depth 大于 1 时，进行递归调用；否则将展平的结果存入 result 中。
- 当检查不通过时，就会判断 isStrict 的值，为 false 时即为非严格模式，这样就可以把不符合 predicate 的值保存在 result 中。为 true 的话，严格模式中，就会把不符合 predicate 的值进行抛弃。

isFlattenable

在 baseFlatten 中会用到 isFlattenable，这个方法是 lodash 用来判断某个值是否可以被展平的。

const spreadableSymbol = Symbol.isConcatSpreadable

function isFlattenable(value) {
  return Array.isArray(value) || isArguments(value) ||
    !!(spreadableSymbol && value && value[spreadableSymbol])
}

正常数组和类数组 arguments ，都是可以通过遍历来展平的。

同时在 ES6 中，可以设置 Symbol.isConcatSpreadable 的属性来表示该对象是否可以被展平，该属性对应的值为 true 时，该对象是可以被展平的。