模拟 API 请求前后参数对比

M66 2025-05-17

在开发 API 时，可能会有需求来对比请求的参数与预期的参数，查看它们是否发生了变化。PHP 提供的 array_diff_assoc 函数可以帮助我们实现这一点。这个函数用于比较两个数组的键值对，返回它们之间不同的部分。接下来，我们将介绍如何利用这个函数来模拟 API 请求前后参数的对比。

1. array_diff_assoc 函数的基本用法

首先，我们需要了解 array_diff_assoc 函数的基本使用方法。该函数用于比较两个数组，返回一个数组，包含第一个数组中存在但第二个数组中没有的键值对。

函数原型：

array_diff_assoc(array $array1, array $array2): array

$array1：第一个数组（需要被对比的数组）。
$array2：第二个数组（要与第一个数组进行对比的数组）。

该函数比较的是数组的键名和键值，返回第一个数组中有的键值对，但第二个数组中没有或者值不同的部分。

2. 模拟 API 请求前后参数对比

假设我们要模拟 API 请求前后的参数对比，通常可以通过 array_diff_assoc 来帮助我们找出请求参数与预期参数的差异。例如：

场景：

我们有一个 API 请求，用户提交了参数，我们希望对比提交的参数与期望的参数，看看用户是否提交了额外的参数或修改了某些参数的值。

示例代码：

<?php
// 模拟请求前的参数
$expectedParams = [
    'user_id' => 123,
    'name' => 'John Doe',
    'email' => 'john.doe@m66.net',
    'phone' => '123-456-7890'
];

// 模拟用户提交的参数
$submittedParams = [
    'user_id' => 123,
    'name' => 'John Doe',
    'email' => 'john.doe@m66.net',
    'phone' => '987-654-3210',  // 手机号不同
    'address' => '123 Main St'  // 提交了额外的参数
];

// 使用 array_diff_assoc 对比两个数组
$diff = array_diff_assoc($submittedParams, $expectedParams);

// 输出对比结果
if (!empty($diff)) {
    echo "请求参数与预期参数的差异如下：\n";
    print_r($diff);
} else {
    echo "请求参数与预期参数一致。\n";
}
?>

代码解释：

$expectedParams：这是我们期望的请求参数，包含 user_id、name、email 和 phone 四个字段。
$submittedParams：这是用户提交的请求参数，除了正常的四个字段外，还提交了一个额外的 address 字段，并且修改了 phone 字段。
使用 array_diff_assoc 比较 submittedParams 和 expectedParams，并找出它们之间的差异。
如果有差异，使用 print_r 输出差异部分；如果没有差异，输出一致的消息。

输出：

请求参数与预期参数的差异如下：
Array
(
    [phone] => 987-654-3210
    [address] => 123 Main St
)

如上所示，输出结果显示了用户请求中的差异。phone 参数被修改了，而 address 是多余的一个参数。

3. 进阶用法

有时我们可能不仅仅需要对比两个数组的差异，还需要进行更复杂的检查。例如，我们可能需要查看是否有特定参数缺失，或者某些关键字段是否符合特定的格式。为了增强功能，您可以结合其他 PHP 函数进行处理。

例子：缺失参数检查

<?php
$missingParams = array_diff_key($expectedParams, $submittedParams);
if (!empty($missingParams)) {
    echo "缺少以下参数：\n";
    print_r($missingParams);
} else {
    echo "所有预期参数都已提交。\n";
}
?>

在这个例子中，array_diff_key 用于对比键名，找出哪些预期的参数在请求中缺失。