Postman脚本：迭代JSON响应并根据条件动态设置全局变量

在api测试自动化中，经常需要从复杂的json响应中提取特定数据。postman提供了强大的脚本能力，允许用户通过javascript处理响应数据。本节将指导您如何遍历一个json数组，并根据数组中元素的特定属性（例如布尔值）来决定是否将其某个字段存储为postman全局变量。

场景描述

假设您从一个API端点获取到以下JSON响应，其中包含一个users数组，每个用户对象都有一个id和一个isRetail布尔属性。您的目标是遍历这个users数组：如果isRetail为true，则将其id存储到名为UserId的全局变量中；如果isRetail为false，则将其id存储到名为orgUserId的全局变量中。

{
    "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
        }
    }
}

常见问题及解决方案

在实现上述逻辑时，初学者可能会遇到一些常见的脚本错误，导致代码无法正常运行，例如 TypeError: Cannot read properties of undefined (reading 'isRetail')。这通常是由于循环边界条件不正确或数据类型比较不准确造成的。

以下是修正后的Postman测试脚本，它解决了这些常见问题：

// 解析API响应为JSON对象
const responseJson = pm.response.json();

// 确保响应中存在data.users数组
if (responseJson && responseJson.data && Array.isArray(responseJson.data.users)) {
    const usersArray = responseJson.data.users;
    const usersLength = usersArray.length;

    // 遍历users数组
    for (let i = 0; i < usersLength; i++) {
        const currentUser = usersArray[i]; // 获取当前用户对象

        // 确保当前用户对象和isRetail属性存在
        if (currentUser && typeof currentUser.isRetail === 'boolean') {
            const isRetailUser = currentUser.isRetail;

            // 根据isRetail的布尔值设置全局变量
            if (isRetailUser === true) {
                pm.globals.set("UserId", currentUser.id);
                console.log(`设置全局变量 UserId 为: ${currentUser.id}`);
            } else if (isRetailUser === false) {
                pm.globals.set("orgUserId", currentUser.id);
                console.log(`设置全局变量 orgUserId 为: ${currentUser.id}`);
            }
        } else {
            console.warn(`跳过无效的用户对象或isRetail属性在索引 ${i} 处缺失.`);
        }
    }
} else {
    console.error("API响应中缺少预期的 'data.users' 数组或其格式不正确.");
}

代码解析与关键修正点

1. 循环边界条件修正：for (let i = 0; i < usersLength; i++)

   • 问题： 原始代码中使用 i <= users_len。如果数组长度为 N，其有效索引范围是 0 到 N-1。当 i 达到 users_len 时，尝试访问 usersArray[users_len] 将导致越界，因为该索引不存在，从而返回 undefined。
   • 修正： 将循环条件改为 i < usersLength。这确保了循环只迭代到数组的最后一个有效索引 (usersLength - 1)，避免了访问 undefined 元素，从而解决了 TypeError。

2. 数据类型精确比较：if (isRetailUser === true) 和 else if (isRetailUser === false)

   

   Find JSON Path Online

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

   30

   查看详情
   • 问题： 原始代码中使用 is_retail == "true" 和 is_retail == "false"。JSON响应中的 isRetail 字段是布尔类型 (true 或 false)，而不是字符串。使用 == 运算符进行比较时，JavaScript可能会尝试进行类型转换，这虽然在某些情况下可能“碰巧”工作，但不是最佳实践，且容易出错。
   • 修正： 使用严格相等运算符 ===，并直接与布尔值 true 和 false 进行比较。=== 不会进行类型转换，要求值和类型都相同，这使得比较更加准确和可靠。

3. 变量声明规范：使用 const 和 let

   • 改进： 在循环内部，使用 const currentUser = usersArray[i]; 和 const isRetailUser = currentUser.isRetail; 来声明变量。const 用于声明一旦赋值后就不能重新赋值的变量，而 let 用于声明可能需要重新赋值的变量。这有助于提升代码的可读性和维护性，并避免潜在的变量作用域问题。

4. 健壮性增强：空值和类型检查

   • 在访问 responseJson.data.users 之前，增加了 if (responseJson && responseJson.data && Array.isArray(responseJson.data.users)) 检查，确保路径上的每个对象都存在且 users 是一个数组。
   • 在处理每个 currentUser 时，增加了 if (currentUser && typeof currentUser.isRetail === 'boolean') 检查，确保当前用户对象及其 isRetail 属性存在且类型正确，进一步提高了脚本的健壮性。

注意事项与最佳实践

• 理解JSON结构： 在编写任何解析JSON的脚本之前，务必仔细检查API响应的JSON结构。Postman的“Pretty”或“Visualize”功能可以帮助您直观地理解数据层级。
• 严格相等运算符 (===)： 始终优先使用 === 而不是 == 进行比较，以避免JavaScript的隐式类型转换可能带来的意外行为。
• 数组索引： 记住数组索引总是从 0 开始，到 length - 1 结束。在循环中，常见的错误是使用 i <= length 而不是 i < length。
• 错误处理： 编写脚本时，考虑API响应可能不包含预期数据的情况（例如，data 对象可能缺失，users 数组可能为空或不存在）。添加适当的条件检查可以使您的脚本更加健壮。
• Postman变量作用域： 熟悉 pm.globals.set()、pm.environment.set() 等函数，了解不同作用域变量的生命周期和用途。
• 调试： 使用 console.log() 在Postman控制台中输出变量值，是调试脚本的有效方法。

通过遵循这些指导原则和最佳实践，您可以在Postman中编写出高效、准确且健壮的脚本，以自动化您的API测试流程。

以上就是Postman脚本：迭代JSON响应并根据条件动态设置全局变量的详细内容，更多请关注php中文网其它相关文章！