獲取用戶自定義常量與系統常量的區別

M66 2025-05-27

在PHP編程中，常量是一種在執行過程中其值不能被改變的標識符。 PHP中常量可分為系統預定義常量和用戶自定義常量。為了調試或分析程序，有時我們需要獲取當前所有已定義的常量，並加以分類。 get_defined_constants函數就是一個非常實用的工具，它能幫助我們獲取所有當前定義的常量及其值。

一、 get_defined_constants函數簡介

get_defined_constants是PHP內置函數，用於返回一個數組，包含所有已定義的常量及其值。其函數簽名如下：

 array get_defined_constants ([ bool $categorize = false ] )

如果傳入參數為false （默認值），返回一個扁平的一維數組，鍵是常量名，值是常量值。
如果傳入參數為true ，返回一個分組的多維數組，按照常量所屬的擴展模塊進行分類。

二、獲取所有常量示例

$constants = get_defined_constants();
print_r($constants);

上述代碼將輸出當前所有常量的名稱和值，但未進行分組，無法清楚地區分系統與用戶常量。

三、分組並提取用戶自定義常量

使用get_defined_constants(true)可以得到一個按照模塊分組的數組。其中，用戶自定義的常量通常在user分組下。

示例代碼如下：

 define('MY_SITE_URL', 'https://m66.net');
define('VERSION', '1.0.0');

$constants = get_defined_constants(true);

// 提取用戶定義的常量
$userConstants = isset($constants['user']) ? $constants['user'] : [];

echo "用戶自定義常量：\n";
foreach ($userConstants as $name => $value) {
    echo "$name => $value\n";
}

輸出示例：

 用戶自定義常量：
MY_SITE_URL => https://m66.net
VERSION => 1.0.0

四、區分系統常量與用戶常量的實踐技巧

如果需要更精細地對比哪些是用戶常量、哪些是系統常量，可以在腳本一開始獲取一份“基礎常量”，然後在定義完用戶常量之後再獲取一次所有常量，通過數組對比就能得到新增的常量。

示例如下：

 // 獲取定義用戶常量前的常量
$before = get_defined_constants();

// 定義用戶常量
define('APP_ENV', 'production');
define('BASE_URL', 'https://m66.net');

// 獲取所有常量
$after = get_defined_constants();

// 計算新增常量
$userConstants = array_diff_assoc($after, $before);

echo "新增用戶常量：\n";
foreach ($userConstants as $name => $value) {
    echo "$name => $value\n";
}

這種方式可以用於更複雜的環境中，例如在框架啟動階段追踪哪些常量是由配置文件或某些組件定義的。

五、應用場景

調試時查看所有自定義常量
自動生成文檔
分析程序初始化階段的常量加載
對比運行環境中不同模塊所定義的常量差異

六、小結

get_defined_constants是一個功能強大的函數，特別是在調試、文檔生成和運行時分析中非常有用。通過結合使用其分組功能和數組差集方法，可以有效地區分系統常量與用戶常量，提升程序的可控性和可維護性。對於希望深入理解運行環境和常量依賴關係的開發者來說，這個函數是不可或缺的工具之一。

get_defined_constants