Lodash _.union 方法与单元素数组更新的正确实践

在使用 Lodash 的 _.union 方法更新数据库中的数组字段时，当尝试添加单个非数组元素到空数组时遇到的问题。核心原因是 _.union 期望其后续参数是集合（数组），而非单个非数组值。文章提供了两种解决方案：一种是针对空数组的条件处理，另一种是更通用的方法，通过确保待添加元素始终被封装在一个数组中，从而实现对单元素和多元素更新的健壮处理。

1. _.union 方法简介与应用场景

Lodash 的 _.union 方法是一个非常实用的工具函数，用于创建由所有给定数组的唯一值组成的新数组。它会按照第一个数组的顺序，然后是后续数组的顺序，来确定结果数组中元素的顺序。在后端开发中，尤其是在处理数据库中存储的数组类型字段时（例如 PostgreSQL 的 ARRAY 类型），_.union 经常被用于添加新元素并自动去重，保持数据的一致性。

例如，一个产品模型可能包含一个 variation 字段，用于存储产品的不同变体 ID：

// Sequelize 模型定义示例
variation: {
  type: DataTypes.ARRAY(DataTypes.STRING),
  defaultValue: [], // 确保新记录的默认值为一个空数组
  allowNull: true,
},

当我们需要向这个 variation 数组中添加新的变体 ID 时，自然会想到使用 _.union。

2. 遇到的问题：_.union 与单元素更新的陷阱

在实际应用中，开发者可能会遇到一个困惑：当尝试使用 _.union 将一个单个非数组元素添加到空数组时，目标数组却保持为空。但如果添加的是两个或更多元素（通常以数组形式传递），或者添加的是一个包含单个元素的数组，则一切正常。

让我们通过一个示例代码来重现这个问题：

// 原始的更新逻辑
const id = req.params.id;
const { variation } = req.body; // variation 可能是一个字符串 'id1' 或一个数组 ['id1', 'id2']

const product = await products.findOne({
  where: { product_id: id },
});

const variationArray = product.variation; // 假设 product.variation 此时为 []

let newlist = _.union(variationArray, variation); // 如果 variation 是 'id1'，newlist 仍为 []

await products.update(
  { variation: newlist },
  { where: { product_id: id } }
);

// 测试代码：
let arr = [];
let singleElement = "1";
let ok = _.union(arr, singleElement); // 结果：[]
console.log(ok);

let arr2 = [];
let singleElementInArray = ["1"];
let ok2 = _.union(arr2, singleElementInArray); // 结果：["1"]
console.log(ok2);

问题分析：

_.union 方法的签名通常是 _.union([array], [others])。它期望其后续参数（others）是数组或可迭代的集合，_.union 会从这些集合中提取元素进行合并。

LobeHub

LobeChat brings you the best user experience of ChatGPT, OLLaMA, Gemini, Claude

201

查看详情

当 variation 是一个单个字符串（例如 'id1'）时，_.union 会尝试将这个字符串作为可迭代对象处理（即遍历其字符）。但它并不会将整个字符串 'id1' 作为一个独立的元素添加到数组中。如果第一个数组 variationArray 是空的，并且 variation 是一个非数组的单值，_.union 就会返回一个空数组。

而当 variation 是一个包含单个元素的数组（例如 ['id1']）时，_.union 能够正确地从这个数组中提取 'id1' 并添加到结果中。

3. 解决方案：确保 _.union 接收数组参数

解决这个问题的核心在于，始终确保传递给 _.union 的第二个及后续参数是数组，即使它只包含一个元素。

3.1 方案一：针对空数组的条件处理（基于原答案）

一种直接的解决办法是，在数组为空时进行特殊处理，将单个元素直接封装成数组赋值；否则，再使用 _.union。

const variationArray = product.variation;
let newlist;

if (variationArray.length === 0) {
  // 如果现有数组为空，直接将单个元素封装成数组
  // 假设 variation 此时是一个字符串，如 'some_id'
  newlist = [variation];
} else {
  // 如果现有数组不为空，则使用 _.union
  // 注意：如果 variation 仍然是单个字符串，此处的 _.union 依然可能忽略它
  newlist = _.union(variationArray, variation);
}

优点： 解决了向空数组添加单个元素的问题。 局限性： 如果 variationArray 不为空，且 variation 仍然是一个非数组的单值，else 分支中的 _.union(variationArray, variation) 仍然会忽略 variation。这并不是一个完全健壮的解决方案。

3.2 方案二：更健壮的通用方法（推荐）

为了彻底解决这个问题，无论 variation 是单个元素还是一个元素数组，我们都应该在将其传递给 _.union 之前，确保它被封装在一个数组中。

// ... (之前的代码)

const id = req.params.id;
const { variation } = req.body; // variation 可能是一个字符串 'id1' 或一个数组 ['id1', 'id2']

const product = await products.findOne({
  where: { product_id: id },
});

if (!product) {
  // 处理产品未找到的情况
  return res.status(404).send('Product not found');
}

// 确保 existingVariations 始终是一个数组，即使数据库返回 null
const existingVariations = product.variation || [];

// 关键步骤：确保 elementsToUnion 始终是一个数组
const elementsToUnion = Array.isArray(variation) ? variation : [variation];

// 现在可以安全地使用 _.union
const newlist = _.union(existingVariations, elementsToUnion);

await products.update(
  { variation: newlist },
  { where: { product_id: id } }
);

// ... (响应处理)

代码解释：

1. const existingVariations = product.variation || [];：这是一个防御性编程实践。即使 Sequelize 模型中设置了 defaultValue: []，在某些极端情况下数据库字段仍可能为 null。此行代码确保 existingVariations 始终是一个可操作的数组。
2. const elementsToUnion = Array.isArray(variation) ? variation : [variation];：这是解决方案的核心。
   • Array.isArray(variation) 检查 req.body.variation 是否已经是一个数组。
   • 如果是，直接使用 variation。
   • 如果不是（即它是一个单个的非数组值，如字符串），则将其用 [variation] 封装成一个单元素数组。
3. const newlist = _.union(existingVariations, elementsToUnion);：现在，elementsToUnion 变量始终是一个数组，_.union 可以正确地从中提取元素并与 existingVariations 进行合并，无论是添加单个元素还是多个元素。

4. 最佳实践与注意事项

• API 接口规范化： 最好的做法是在 API 设计时就规范 req.body.variation 的类型。如果 variation 字段预期是一个列表，那么即使只添加一个元素，也应该要求客户端以数组形式发送，例如 {"variation": ["id1"]} 而不是 {"variation": "id1"}。这可以简化服务器端的处理逻辑。
• 输入验证： 始终对来自客户端的请求体进行严格的输入验证。使用像 Joi、`express-

以上就是Lodash _.union 方法与单元素数组更新的正确实践的详细内容，更多请关注php中文网其它相关文章！