Postman中基于条件迭代JSON响应并存储全局变量的教程

在api测试中，我们经常需要从复杂的json响应中提取特定数据，并根据某些条件将其存储为postman的环境或全局变量，以便后续请求使用。例如，一个api可能返回一个用户列表，我们需要遍历这个列表，根据用户的某个属性（如isretail）来决定存储哪个用户的id。

核心需求：遍历JSON数组并条件赋值

假设我们收到以下JSON响应：

{
    "status": 200,
    "data": {
        "users": [
            {
                "id": 95,                
                "isRetail": true
            },
            {
                "id": 118,               
                "isRetail": false
            }
        ],
        "pagination": {
            "pageNumber": 1,
            "pageSize": 25,
            "totalCount": 2,
            "totalPages": 1,
            "isFirst": true,
            "isLast": true,
            "totalCountOnPage": 2
        }
    }
}

我们的目标是：

1. 遍历data.users数组。
2. 如果isRetail为true，则将该用户的id存储到名为UserId的全局变量。
3. 如果isRetail为false，则将该用户的id存储到名为orgUserId的全局变量。

常见问题与错误分析

在实现上述逻辑时，初学者常遇到两类问题：

1. 循环边界错误 (TypeError: Cannot read properties of undefined)

原始代码中常见的错误循环条件是 for(let i= 0; i <= users_len; i++)。如果users_len是数组的长度，那么数组的有效索引是从0到users_len - 1。当i等于users_len时，尝试访问res.data.users[users_len]会导致访问一个不存在的元素，从而返回undefined。接着，试图读取undefined的isRetail属性就会引发TypeError。

正确做法： 循环条件应为 i < users_len，确保索引不会超出数组范围。

2. 布尔值类型比较错误

JSON中的isRetail是一个布尔类型的值（true或false），而不是字符串。原始代码中常见的错误是使用 if(is_retail == "true") 进行比较。JavaScript在进行==比较时会尝试类型转换，但在Postman的脚本环境中，直接比较布尔值与字符串通常不会按预期工作，或者可能引入不必要的复杂性。

正确做法： 应该直接与布尔字面量 true 或 false 进行比较，并推荐使用严格相等运算符 ===，以避免隐式类型转换带来的潜在问题。例如：if (is_retail === true)。

解决方案与优化代码

结合上述修正，以下是Postman测试脚本的正确实现：

Find JSON Path Online

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

30

查看详情

// 解析JSON响应体
const responseJson = pm.response.json();

// 确保响应结构符合预期，避免访问不存在的属性
if (responseJson && responseJson.data && Array.isArray(responseJson.data.users)) {
    const users = responseJson.data.users;
    const users_len = users.length;

    // 遍历用户数组
    for (let i = 0; i < users_len; i++) {
        // 使用const或let声明变量，提高代码可读性和作用域管理
        const currentUser = users[i];

        // 检查当前用户对象是否存在且包含isRetail属性
        if (currentUser && typeof currentUser.isRetail === 'boolean') {
            // 使用严格相等运算符(===)与布尔值进行比较
            if (currentUser.isRetail === true) {
                // 设置全局变量UserId
                pm.globals.set("UserId", currentUser.id);
                // 如果只需要第一个匹配项，可以在此处添加 break;
            } else if (currentUser.isRetail === false) {
                // 设置全局变量orgUserId
                pm.globals.set("orgUserId", currentUser.id);
                // 如果只需要第一个匹配项，可以在此处添加 break;
            }
        }
    }
} else {
    console.warn("Postman脚本警告: 响应JSON结构不符合预期或'users'数组不存在。");
}

代码详解与最佳实践

1. JSON响应解析：

   • const responseJson = pm.response.json();：这是Postman中获取当前请求响应体的标准方法，它将JSON字符串解析为JavaScript对象。使用const来声明不应被重新赋值的变量。

2. 结构健壮性检查：

   • if (responseJson && responseJson.data && Array.isArray(responseJson.data.users))：在访问深层嵌套属性之前进行检查是良好的编程习惯。这可以防止在响应结构不符合预期时（例如，API返回错误或数据缺失）脚本崩溃。Array.isArray()确保users确实是一个数组。

3. 数组遍历：

   • for (let i = 0; i < users_len; i++)：这是遍历数组的标准且安全的方式。i < users_len确保循环索引始终在数组的有效范围内。
   • const currentUser = users[i];：引入一个临时变量来引用当前迭代的数组元素，可以提高代码的可读性，避免重复访问users[i]。

4. 条件判断与类型安全：

   • if (currentUser && typeof currentUser.isRetail === 'boolean')：在进行条件判断之前，再次检查currentUser是否存在以及isRetail属性是否存在且为布尔类型，进一步增强脚本的健壮性。
   • if (currentUser.isRetail === true) 和 else if (currentUser.isRetail === false)：使用严格相等运算符===与布尔字面量true和false进行比较。这是处理布尔值的推荐方式，因为它不涉及类型转换，确保了比较的准确性。

5. 全局变量设置：

   • pm.globals.set("VariableName", value);：这是Postman API提供的方法，用于将数据存储到全局变量中。这些变量可以在后续的请求中通过{{VariableName}}引用。

6. 注意事项：

   • 变量覆盖： 在上述示例中，如果users数组中有多个isRetail: true的用户，UserId全局变量最终将存储最后一个匹配用户的ID，因为pm.globals.set会覆盖之前的值。如果需要存储所有匹配项，可能需要将它们存储为数组或使用不同的变量名（例如UserId_1, UserId_2等）。
   • 错误日志： console.warn() 或 console.error() 可以用于在Postman控制台中输出警告或错误信息，帮助调试和监控脚本执行情况。
   • 性能考量： 对于非常大的数组，可以考虑在找到第一个匹配项后使用break语句提前退出循环，以提高脚本效率（如果业务逻辑允许）。

总结

通过本教程，我们学习了如何在Postman中高效且安全地处理JSON响应，特别是涉及数组遍历、条件判断和全局变量设置的场景。关键在于理解并避免常见的循环边界错误和布尔值类型比较错误。遵循代码健壮性检查和使用严格相等运算符等最佳实践，能够编写出稳定可靠的Postman测试脚本，从而提升API测试的自动化水平和效率。

以上就是Postman中基于条件迭代JSON响应并存储全局变量的教程的详细内容，更多请关注php中文网其它相关文章！