如何在PHPUnit 測試中使用get_defined_constants 函數進行常量快照對比？

M66 2025-06-11

在PHP 項目開發過程中，尤其是涉及大量配置常量的情況下，確保常量值在代碼執行過程中沒有被意外修改，是非常重要的一環。利用PHPUnit 進行單元測試時，常見做法是對函數輸出結果或類行為進行斷言，但對於常量的變動檢測卻不夠直觀。

本文將介紹如何使用PHP 內置的get_defined_constants函數結合PHPUnit，來實現對常量集合的“快照”保存與對比，從而方便地檢測常量在測試過程中的變化。

什麼是get_defined_constants函數？

get_defined_constants是PHP 提供的一個函數，用來返回所有當前定義的常量。它可以接受一個布爾參數，如果傳入true ，會返回按類別分組的常量數組。

示例代碼：

 $constants = get_defined_constants(true);
print_r($constants['user']);  // 只獲取用戶定義的常量

這使得我們可以獲取當前用戶定義的所有常量快照，便於後續比較。

為什麼要對常量進行快照對比？

在單元測試中，如果某段代碼錯誤地修改了常量，可能導致系統行為異常。但常量一旦定義就不能被重新定義或修改，所以這種“修改”通常表現為通過某些方式重新定義了相同名稱的常量，或由於環境變動導致預期常量缺失。

通過對測試前後的常量快照進行對比，可以及時發現意外新增、刪除或修改的常量，確保程序穩定。

實現思路

捕獲快照 在測試用例開始前，調用get_defined_constants(true)['user']保存當前用戶定義的常量數組
執行代碼 執行需要測試的代碼邏輯，可能會有新增或修改常量
再次捕獲快照 重新調用get_defined_constants(true)['user']獲取當前常量狀態
比較快照 對比兩次快照，找出新增、刪除或值不同的常量
斷言驗證 根據預期，使用PHPUnit 斷言確保常量未被意外更改

具體示例代碼

以下是一個使用PHPUnit 進行常量快照對比的示例：

 use PHPUnit\Framework\TestCase;

class ConstantSnapshotTest extends TestCase
{
    private array $initialConstants;

    protected function setUp(): void
    {
        // 記錄初始常量快照
        $this->initialConstants = get_defined_constants(true)['user'] ?? [];
    }

    public function testConstantSnapshot()
    {
        // 假設這是測試代碼塊，可能定義或修改常量
        if (!defined('MY_CONST')) {
            define('MY_CONST', 'initial_value');
        }

        // 重新獲取常量快照
        $currentConstants = get_defined_constants(true)['user'] ?? [];

        // 對比兩個快照，找出變化
        $added = array_diff_key($currentConstants, $this->initialConstants);
        $removed = array_diff_key($this->initialConstants, $currentConstants);
        $modified = [];

        foreach ($currentConstants as $key => $value) {
            if (isset($this->initialConstants[$key]) && $this->initialConstants[$key] !== $value) {
                $modified[$key] = [
                    'old' => $this->initialConstants[$key],
                    'new' => $value,
                ];
            }
        }

        // 輸出調試信息（實際測試時可以註釋或寫日誌）
        print_r([
            'added' => $added,
            'removed' => $removed,
            'modified' => $modified,
        ]);

        // 斷言沒有新增或刪除的常量
        $this->assertEmpty($added, '不應有新增常量');
        $this->assertEmpty($removed, '不應有刪除常量');

        // 斷言常量值未修改
        $this->assertEmpty($modified, '不應有修改的常量');
    }
}

注意事項

常量不可重定義
PHP 不允許同名常量重複定義，除非用特殊手段（如運行不同命名空間）。測試時應注意此限制。
環境依賴 有些常量是環境自動定義的，測試前後環境不同可能導致快照差異建議只比較用戶定義的常量部分。
性能影響 對大量常量頻繁快照對比，可能稍有性能影響，但一般可接受

結合實際項目

假設你的項目中涉及復雜配置，或者運行時會動態加載不同模塊定義常量，通過這種快照對比方式可以在CI 流程中自動檢測配置異常。

例如，在集成測試時，確保所有配置常量都符合預期，避免上線時出現配置錯亂。

小結

通過get_defined_constants函數配合PHPUnit，可以輕鬆實現常量快照對比，保證常量集合的穩定性。該方法簡單易用，適合對常量敏感的PHP 項目進行自動化測試。

如果你對常量的管理和測試有更深需求，可以進一步封裝快照對比工具，結合日誌和異常處理，提升代碼質量和項目可靠性。

get_defined_constants