使用array_diff_key() 比對配置文件與默認配置

M66 2025-05-15

在開發過程中，我們經常需要將某個配置文件與默認配置進行比對，快速找出差異。例如，假設你有一個默認的配置數組和一個用戶修改後的配置文件數組，你需要快速找出哪些配置項被修改、添加或刪除。

PHP 提供了很多有用的函數來處理這種任務，其中array_diff_key()就是一個非常適合的工具。

什麼是array_diff_key() ？

array_diff_key()是PHP 內置的一個函數，用於比較兩個數組的鍵名，返回一個數組，包含在第一個數組中存在但在第二個數組中不存在的鍵值對。簡單來說，它可以幫助我們找出兩個數組中鍵名不同的部分。

示例：如何用array_diff_key()比對配置文件與默認配置

我們假設有一個默認配置數組$defaultConfig和一個用戶修改後的配置數組$userConfig ，我們希望快速找出用戶配置中與默認配置不同的部分。可以通過以下方式實現：

 <?php

// 默認配置
$defaultConfig = [
    'site_name' => 'My Website',
    'site_url' => 'https://www.example.com',
    'site_admin' => 'admin@example.com',
    'theme' => 'default',
    'timezone' => 'UTC',
];

// 用戶配置
$userConfig = [
    'site_name' => 'Custom Website',
    'site_url' => 'https://m66.net', // 修改了 URL
    'theme' => 'dark', // 修改了主題
    'timezone' => 'Asia/Shanghai',
];

// 使用 array_diff_key() 比对配置文件和默認配置
$differences = array_diff_key($userConfig, $defaultConfig);

// 輸出差異
echo "用戶配置与默認配置的差异:\n";
print_r($differences);

?>

代碼解釋

默認配置與用戶配置：我們定義了兩個數組，分別代表默認配置和用戶修改後的配置。用戶配置與默認配置的鍵名基本相同，但有一些差異（如site_url和theme ）。
array_diff_key()函數：我們使用array_diff_key()比對$userConfig和$defaultConfig ，它會返回一個新的數組，包含在$userConfig中但不在$defaultConfig中的鍵值對。
輸出差異：通過print_r()輸出差異部分，以便我們能清楚地看到用戶配置與默認配置之間的不同之處。

輸出結果

執行上面的代碼後，輸出結果將是：

 用戶配置与默認配置的差异:
Array
(
    [site_name] => Custom Website
    [site_url] => https://m66.net
    [theme] => dark
)

從結果中我們可以看到，用戶配置中與默認配置不同的部分包括：

site_name被修改為“Custom Website”
site_url被修改為“ https://m66.net”
theme被修改為“dark”

總結

通過使用array_diff_key() ，我們能夠快速找出兩個配置數組之間的差異。這個方法非常適合用來比對配置文件與默認配置，從而便於開發人員了解用戶的修改內容，快速進行調整或優化。