k6 教程：解决 open 函数误导入导致的 TypeError 错误

本文将深入探讨在 k6 性能测试脚本中，因错误导入 `open` 函数而引发的 `typeerror: value is not an object: undefined` 错误。我们将详细解释 `open` 函数的正确使用方式及其在 k6 生命周期中的位置，并提供一套清晰的解决方案，以确保您的脚本能够顺利、高效地读取外部数据文件，避免常见的导入陷阱。

k6 中的 open 函数及其工作原理

在 k6 性能测试中，open 函数是一个非常实用的工具，它允许我们在脚本初始化阶段读取本地文件。这对于加载配置文件、测试数据或任何其他外部资源至关重要。open 函数的独特之处在于它属于 k6 的“初始化上下文”（init context），这意味着它只在脚本加载和编译时执行一次，而不是在每个虚拟用户或迭代中重复执行。

open 函数的典型用法是读取 JSON 或 CSV 文件，然后将其内容解析为 JavaScript 对象或数组，供后续的测试逻辑使用。例如，从一个 data.json 文件中读取配置：

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

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

// 使用 open 函数读取并解析 JSON 文件
const jsonData = JSON.parse(open(__ENV.resourseURL));
const baseURL = jsonData.base_url;

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

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

理解 TypeError: Value is not an object: undefined 错误

当您在 k6 脚本中遇到 TypeError: Value is not an object: undefined 这样的错误时，尤其是在尝试使用 open 函数读取文件时，通常意味着 open 函数本身没有被正确识别或调用。在 k6 中，open 函数是一个全局可用的内置函数，它不需要像 http、check 或 sleep 那样通过 import 语句从 k6 模块中导入。

错误的导入方式，例如：

import {open} from 'k6'; // 这是一个错误的导入！

会导致 k6 在尝试解析脚本时混淆。尽管 open 函数在全局范围内是可用的，但如果您尝试以模块导入的方式引入它，JavaScript 模块系统会尝试从 k6 模块中查找名为 open 的导出成员。由于 k6 模块并没有导出 open 函数，这个导入会失败，导致 open 变量在您的脚本中被赋值为 undefined。

当后续代码尝试调用这个 undefined 的 open 变量时，比如 JSON.parse(open(__ENV.resourseURL))，实际上是在尝试执行 undefined(...)，这就会触发 TypeError: Value is not an object: undefined 错误，因为 undefined 不是一个可调用的函数对象。

错误示例与分析

以下是一个导致该错误的典型 k6 脚本片段：

挖错网

一款支持文本、图片、视频纠错和AIGC检测的内容审核校对平台。

28

查看详情

import http from 'k6/http';
import { check } from 'k6';
import { sleep } from 'k6';
import {open} from 'k6'; // 错误：open 函数不应被导入

const jsonData = JSON.parse(open(__ENV.resourseURL)); // 尝试调用 undefined
const baseURL = jsonData.base_url;

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

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

当使用命令 k6 run --env resourseURL=data.json Sample.js 运行此脚本时，您会看到 TypeError: Value is not an object: undefined。这个错误明确指出问题在于 open 变量在被调用时是 undefined。

正确的解决方案

解决这个 TypeError 的方法非常直接：移除所有尝试导入 open 函数的语句。 由于 open 函数是 k6 环境的全局内置函数，它始终可用，无需显式导入。

以下是修正后的 k6 脚本示例：

import http from 'k6/http';
import { check, sleep } from 'k6'; // 可以将多个导入合并

// const open = require('k6').open; // 同样是错误的，不需要导入

const jsonData = JSON.parse(open(__ENV.resourseURL)); // 直接使用全局的 open 函数
const baseURL = jsonData.base_url;

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

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

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

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

通过移除 import {open} from 'k6'; 这一行，open 函数将正确地作为全局函数被识别和调用，从而避免 TypeError。

k6 模块导入的最佳实践

为了避免类似的导入错误，请遵循以下 k6 模块导入的最佳实践：

1. 只导入需要的功能： 仅使用 import { funcName } from 'k6'; 语句导入 k6 官方文档中明确指出需要导入的模块功能（如 http, check, sleep, group, Rate 等）。
2. 了解全局函数： 记住 open() 和 SharedArray 等是 k6 环境提供的全局函数，不需要也不应该通过 import 语句引入。
3. 合并导入： 为了代码的简洁性，可以将来自同一模块的多个功能合并到一行导入语句中，例如 import { check, sleep } from 'k6';。
4. 查阅官方文档： 当不确定某个功能是否需要导入时，始终查阅 k6 官方文档。文档会明确指出哪些功能是模块导出，哪些是全局可用的。

总结

TypeError: Value is not an object: undefined 在 k6 脚本中，当涉及到 open 函数时，几乎总是由于尝试错误地导入它所致。open 是一个全局函数，无需导入。理解 k6 的模块系统和全局函数的区别是编写健壮、无错误 k6 脚本的关键。通过遵循上述最佳实践，您可以避免这类常见的错误，并更高效地利用 k6 进行性能测试。

以上就是k6 教程：解决 open 函数误导入导致的 TypeError 错误的详细内容，更多请关注php中文网其它相关文章！