模擬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用於對比鍵名，找出哪些預期的參數在請求中缺失。