如何在 Cypress 中正确向 JSON 文件追加数据并保持合法格式-js教程-PHP中文网

如何在 Cypress 中正确向 JSON 文件追加数据并保持合法格式

本文介绍在 cypress 测试中向 json 文件安全追加对象的正确方法，避免因直接追加导致 json 格式损坏（如缺失逗号、缺少数组包裹等），强调应通过读取-修改-写入流程确保结构完整性。

本文介绍在 cypress 测试中向 json 文件安全追加对象的正确方法，避免因直接追加导致 json 格式损坏（如缺失逗号、缺少数组包裹等），强调应通过读取-修改-写入流程确保结构完整性。

在 Cypress 中，使用 cy.writeFile() 配合 { flag: 'a+' } 直接追加内容到 JSON 文件是一种常见误区。该 flag 适用于纯文本流（如日志文件），但 JSON 是结构化数据格式——直接追加对象字面量（如 {"key":"value"}）会导致文件内容变为非法 JSON，例如：

[{"FirstName":"ABC","MiddleName":"K","LastName":"edf"}]{"FirstName":"sss","MiddleName":"g","LastName":"efg"}

这显然不是有效的 JSON 数组，解析时会报错 Unexpected token {。

Json Schema Toolkit

使用 JSON Schema 验证 JSON 数据，从示例 JSON 生成 schema，并将其转换为 TypeScript 接口、Python 数据类或 Markdown 文档。

下载

✅ 正确做法是：先读取现有 JSON 数据 → 在内存中以 JavaScript 对象形式操作（如 push()）→ 再整体写回文件。该方式天然保证语法合法性，无需手动处理逗号、括号或换行。

✅ 推荐实现代码

const filePath = 'cypress/fixtures/xlsxData.json';

// 确保文件初始为合法 JSON 数组（空数组亦可）
// 若文件不存在，需先初始化；若存在，必须是数组格式
cy.readFile(filePath, { timeout: 10000 }).then((data) => {
  // data 应为数组，如 [] 或 [{...}, {...}]
  const jsonData = Array.isArray(data) ? data : [];
  const newData = {
    FirstName: F_jsonData[i][0],
    MiddleName: F_jsonData[i][1],
    LastName: F_jsonData[i][2]
  };
  jsonData.push(newData);
  cy.writeFile(filePath, jsonData); // 自动序列化为格式良好的 JSON
});

⚠️ 关键注意事项

文件初始化前提：首次运行前，请确保 xlsxData.json 存在且内容为合法 JSON 数组（如 []）。Cypress 不会自动创建结构化 JSON 文件。
错误处理建议：生产环境可增加 try/catch 或 cy.readFile(...).catch(...) 处理文件不存在或格式异常的情况。
并发安全：若多个测试并行写入同一文件，可能引发竞态条件。推荐为每个测试生成唯一文件名，或使用 cy.task() 在 Node.js 端加锁控制。
性能提示：频繁读写大 JSON 文件会影响执行效率，大量数据建议改用数据库或 CSV + 自定义解析。