在 API 参数校验中使用 array_diff_ukey()

M66 2025-06-06

在开发 API 时，我们通常需要进行参数校验，以确保客户端发送的请求参数符合预期的结构和格式。PHP 提供了许多内置函数来帮助我们实现这些任务，其中 array_diff_ukey() 函数在参数校验中可以发挥非常高效的作用。

array_diff_ukey() 是一个比较两个数组的函数，但它与 array_diff() 的不同之处在于，array_diff_ukey() 是通过数组的键来进行比较的。它接收两个数组，并返回一个包含所有键不相等的元素的数组，这在校验参数时尤为有用，尤其是在检查某些 API 请求中是否包含了不必要的参数时。

array_diff_ukey() 的基本用法

array_diff_ukey() 函数的基本语法如下：

array_diff_ukey(array $array1, array $array2, callable $key_compare_func): array

$array1 和 $array2：要比较的两个数组。
$key_compare_func：一个回调函数，用于比较两个数组的键。

在 API 参数校验中的应用

在 API 参数校验中，通常我们需要检查客户端发送的请求中是否包含了我们期望的参数，同时排除掉不必要的或多余的参数。我们可以使用 array_diff_ukey() 来完成这一任务。

假设我们有一个 API 请求的参数数组，客户端发送了一个带有额外参数的请求，我们需要从中剔除掉这些无关的参数，只保留我们关心的参数。

示例 1：基本参数校验

假设我们期望客户端请求包含以下参数：

$requiredParams = ['name', 'age', 'email'];

客户端发送的请求参数数组如下：

$requestParams = [
    'name' => 'John',
    'age' => 30,
    'email' => 'john@example.com',
    'extra_param' => 'value',
];

我们希望从 $requestParams 中剔除掉 extra_param，这时可以使用 array_diff_ukey() 来进行校验：

// 定义一个回调函数，比较键是否在 $requiredParams 中
$keyCompareFunc = function ($key1, $key2) use ($requiredParams) {
    return in_array($key1, $requiredParams) ? 0 : 1; // 只保留需要的参数
};

// 使用 array_diff_ukey() 进行过滤
$filteredParams = array_diff_ukey($requestParams, array_flip($requiredParams), $keyCompareFunc);

print_r($filteredParams);

输出结果会是：

Array
(
    [name] => John
    [age] => 30
    [email] => john@example.com
)

如上所示，extra_param 被成功地剔除出请求参数数组。

示例 2：更复杂的校验

有时，我们不仅仅需要排除额外的参数，还需要进行更复杂的校验，例如，校验某些参数的值是否符合预期类型。我们可以结合 array_diff_ukey() 和其他校验逻辑来实现这一目标。

假设我们期望参数 age 为一个整数，email 为有效的电子邮件地址。我们可以在过滤参数后继续进行这些类型校验：

// 定义一个回调函数，进行类型校验
$keyCompareFunc = function ($key1, $key2) use ($requiredParams) {
    return in_array($key1, $requiredParams) ? 0 : 1; // 只保留需要的参数
};

// 过滤掉不需要的参数
$filteredParams = array_diff_ukey($requestParams, array_flip($requiredParams), $keyCompareFunc);

// 类型校验
if (isset($filteredParams['age']) && !is_int($filteredParams['age'])) {
    echo 'Age must be an integer';
}

if (isset($filteredParams['email']) && !filter_var($filteredParams['email'], FILTER_VALIDATE_EMAIL)) {
    echo 'Invalid email format';
}

print_r($filteredParams);

在这个例子中，首先我们过滤了不必要的参数，然后对 age 和 email 进行类型校验。

结语

通过合理利用 array_diff_ukey() 函数，我们可以高效地对 API 请求中的参数进行校验和过滤。它不仅可以帮助我们剔除不必要的参数，还可以在复杂的校验逻辑中发挥重要作用。对于那些需要严格控制请求参数的 API，array_diff_ukey() 是一个非常实用的工具。

array_diff_ukey