在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()是一個非常實用的工具。