k6 脚本中正确加载本地 JSON 数据：避免 SyntaxError

本文旨在解决 k6 性能测试脚本中加载本地 JSON 文件时常见的 `SyntaxError`。当尝试使用 Node.js 的 `require()` 语法导入 JSON 数据时，k6 的 Goja JavaScript 运行时会报错。正确的做法是利用 k6 内置的 `open()` 函数在初始化阶段安全有效地读取本地文件，从而确保测试脚本的顺利执行和数据的有效利用。

在进行性能测试时，我们经常需要从外部文件加载数据，例如 API 端点、用户凭证或请求体等。对于 k6 脚本而言，加载本地 JSON 文件是一种常见的需求。然而，不正确的数据加载方式可能会导致脚本执行失败，其中最典型的错误便是 SyntaxError: Unexpected Token, expected ;。

理解 k6 的 JavaScript 运行时环境

k6 使用 Goja 作为其 JavaScript 引擎，这是一个用 Go 语言实现的 JavaScript 运行时。与 Node.js 不同，Goja 并不原生支持 Node.js 的模块系统，包括 require() 函数。因此，当您尝试在 k6 脚本中使用 require('./data.json') 这样的语法时，k6 无法正确解析该语句，并将其视为语法错误，通常会指向 JSON 文件内容的开头。

错误的加载方式示例

考虑以下 k6 脚本和 data.json 文件：

data.json:

{
  "base_url": "https://gorest.co.in/public/v2/users"
}

k6 脚本 (错误示例):

import http from 'k6/http';
import { check, sleep } from 'k6';

// 错误的加载方式，会导致 SyntaxError
const dataset = JSON.parse(JSON.stringify(require("./data.json")));

export let options = {
  vus: 10,
  duration: '1m',
};

export default function () {
  let response = http.get(dataset.base_url);
  check(response, { 'Status is 200': (r) => r.status === 200 });
  sleep(1);
}

当执行上述脚本时，您会遇到类似以下的错误信息：

SyntaxError: Getting Unexpected Token, expected ;

错误通常会指向 data.json 文件的第一个字符，这正是因为 k6 运行时无法识别 require 语句。

正确的解决方案：使用 open() 函数

k6 提供了一个内置的 open() 函数，用于在脚本的初始化（init）阶段读取本地文件。open() 函数会返回文件的内容作为字符串，然后您可以将其解析为 JSON 对象。

Find JSON Path Online

Easily find JSON paths within JSON objects using our intuitive Json Path Finder

30

查看详情

k6 脚本 (正确示例):

import http from 'k6/http';
import { check, sleep } from 'k6';

// 使用 k6 的 open() 函数正确加载本地 JSON 文件
const dataset = JSON.parse(open('./data.json'));

export const options = {
  vus: 10, // 模拟的虚拟用户数量
  duration: '1m', // 测试持续时间
};

export default function () {
    // 发送 HTTP GET 请求
    let response = http.get(dataset.base_url);

    // 断言响应状态码为 200
    check(response, { 'Status is 200': (r) => r.status === 200 });

    // 在下一次迭代前暂停 1 秒
    sleep(1);
}

open() 函数详解：

• 用途： open(filePath) 函数用于读取指定路径的本地文件内容。
• 返回类型： 它返回文件内容的字符串表示。
• 执行上下文： open() 只能在 k6 脚本的初始化阶段（即 export const options 和 export default function 之外的顶层作用域）调用。这是因为文件读取操作应该在测试开始前完成，以避免在 VUs 运行时重复读取文件，影响性能。
• 文件路径： 路径可以是相对路径（相对于 k6 脚本文件）或绝对路径。

通过将 require("./data.json") 替换为 open('./data.json')，我们利用了 k6 自身提供的文件读取机制，从而避免了 SyntaxError 并成功加载了数据。

高级数据加载策略

对于更复杂或更庞大的数据集，k6 提供了更高效的数据加载和管理方式：

1. 使用 SharedArray 处理大型数据集

如果您的 data.json 文件非常大，或者包含需要被所有虚拟用户（VUs）共享的复杂数据结构，推荐使用 SharedArray。SharedArray 允许您将数据加载一次，并在所有 VUs 之间高效共享，避免了每个 VU 独立加载数据的开销。

SharedArray 示例:

import { SharedArray } from 'k6/data';

const rawData = open('./large_data.json');
const mySharedData = new SharedArray('my data', function () {
  return JSON.parse(rawData);
});

export default function () {
  // 在这里使用 mySharedData
  const item = mySharedData[Math.floor(Math.random() * mySharedData.length)];
  // ...
}

2. 数据参数化

数据参数化是性能测试中的一个核心概念，它允许您使用不同的输入数据来模拟真实用户行为。除了简单的 JSON 文件，k6 还支持从 CSV 文件或其他自定义数据源加载数据。结合 SharedArray，您可以实现灵活且高效的数据驱动测试。

总结

在 k6 性能测试脚本中加载本地 JSON 文件时，务必记住 k6 的 JavaScript 运行时与 Node.js 环境有所不同。避免使用 require()，而应采用 k6 提供的 open() 函数来读取文件内容，并结合 JSON.parse() 进行解析。对于大型或复杂的数据集，SharedArray 提供了更优的性能和管理方式。理解并正确运用这些数据加载机制，是编写高效、稳定的 k6 性能测试脚本的关键。

以上就是k6 脚本中正确加载本地 JSON 数据：避免 SyntaxError的详细内容，更多请关注php中文网其它相关文章！