如何优雅地遍历结构不确定的多维嵌套数组(PHP递归解析API响应)

本文介绍一种基于递归函数的通用方案,替代深层嵌套 foreach 循环,高效提取 json api 响应中任意深度下同时含 `value` 和 `id` 字段的 `coldata` 条目及其紧邻的 `rows.row.coldata` 数据。

在对接财务类 API(如 QuickBooks Online 报表接口)时,常会收到结构高度嵌套但模式相对固定的 JSON 数据:Rows → Row → [Header/Summary/Rows] → … → ColData。其嵌套层级不固定(2~6 层甚至更深),且需精准捕获满足条件的节点——即 ColData 子项中同时存在 value 和 id 键的条目,并关联其下方最近一层 Rows.Row 中的 ColData 数组(即业务明细数据)。硬编码多层 foreach 不仅可读性差、易出错,更难以维护和扩展。

推荐采用递归下降 + 条件剪枝策略,核心思路如下:

  • 以 Rows.Row 为统一入口点,逐层递归处理每个 $row;
  • 对每个 $row,优先检查是否存在 Header.ColData,并遍历其中每个 ColData 项;
  • 若某 ColData 同时含 value 和 id,则立即提取该对值,并尝试获取其“下游”数据:$row['Rows']['Row'] ?? [](注意:不是无限向下找,而是取直接子级的 Rows.Row,符合题干“immediately follows”的语义);
  • 若当前 ColData 缺少任一键,则跳过该条目,继续递归当前 $row 的全部子结构(如 Rows.Row、Summary 等),确保不遗漏深层匹配项;
  • 使用 array_merge() 聚合各层结果,保持扁平化输出。

以下是优化后的生产就绪代码(含空值防护、类型提示与注释):

 trim($col['value']),
                        'id'    => trim($col['id'])
                    ];

                    // Step 3: 获取紧邻的 Rows.Row(题干要求的“immediately follows”)
                    // 注意:此处取 $row['Rows']['Row'],而非递归搜索所有后代 Rows
                    $immediateRows = $row['Rows']['Row'] ?? [];

                    // Step 4: 提取 immediateRows 中每个 Row 的 ColData(若存在)
                    $colDataList = [];
                    foreach ($immediateRows as $immediateRow) {
                        if (isset($immediateRow['ColData']) && is_array($immediateRow['ColData'])) {
                            $colDataList[] = $immediateRow['ColData'];
                        }
                    }

                    $results[] = [
                        'header' => $extracted,
                        'details' => $colDataList // 扁平化存储所有匹配的 ColData 数组
                    ];
                }
            }
        }

        // Step 5: 递归进入当前 row 的子 Rows(支持任意深度嵌套)
        // 重点:递归入口是 $row['Rows']['Row'],而非 $row 本身,避免重复处理
        if (isset($row['Rows']['Row']) && is_array($row['Rows']['Row'])) {
            $results = array_merge($results, extractHeaderIdValuePairs(['Rows' => ['Row' => $row['Rows']['Row']]]));
        }
        // 可选:也递归 Summary.Rows(若需处理 Summary 下的嵌套,但题干明确 discard Summary)
        // if (isset($row['Summary']['Rows']['Row'])) { ... }
    }

    return $results;
}

// 使用示例
$json = file_get_contents('api_response.json'); // 或来自 cURL 响应
$data = json_decode($json, true);

if (json_last_error() !== JSON_ERROR_NONE) {
    throw new InvalidArgumentException('Invalid JSON response');
}

$extracted = extractHeaderIdValuePairs($data);
print_r($extracted);

关键优势说明

  • 健壮性:所有数组访问均使用 ?? [] 或 isset() 防御,杜绝 Undefined index 错误;
  • 语义准确:“immediately follows” 严格对应 $row['Rows']['Row'],而非盲目深搜;
  • 可扩展:如需过滤 type === "Data" 的明细行,可在 details 提取阶段添加 if ($immediateRow['type'] ?? null === 'Data');
  • 性能友好:递归深度由实际数据结构决定,无冗余遍历;单次扫描完*部提取。

⚠️ 注意事项

  • 避免在递归中直接修改原始 $data,本实现全程只读;
  • 若 API 返回超大数组(如题干 25K 行),建议配合 gc_collect_cycles() 或分块处理;
  • 生产环境务必添加日志记录匹配数量与异常路径,便于调试嵌套逻辑。

通过此方案,你将彻底告别“foreach 套娃”,以清晰、可维护、符合 PSR-12 规范的方式,驾驭任意复杂度的嵌套 API 响应。