如何過濾掉未使用的常量

M66 2025-05-31

在PHP 項目開發中，我們經常使用define或const來定義常量。隨著項目的不斷擴大，常量數量也會急劇增加，久而久之，一些常量可能被遺忘，不再被任何代碼引用。這些未使用的常量會增加維護成本，降低代碼的可讀性和可維護性。為了提高代碼質量，我們可以通過get_defined_constants函數結合靜態分析手段，識別並清理未被使用的常量。

什麼是get_defined_constants ？

get_defined_constants是PHP 內置函數之一，它的作用是返回當前腳本中所有已定義的常量（包括用戶自定義常量和PHP 內部常量）。該函數可以接受一個布爾參數，當參數為true時，它會返回一個按分類分組的多維數組；否則返回一個平面數組。

示例：

 print_r(get_defined_constants(true));

過濾未使用常量的原理

get_defined_constants並不能直接告訴我們某個常量有沒有被使用。但我們可以結合以下兩個步驟來間接實現這個目標：

獲取所有用戶定義的常量名。
遍歷項目代碼，檢查這些常量是否被引用。
將未被引用的常量標記為“未使用”。

示例實現

以下是一個簡單的實現思路，假設你在維護一個中小型項目：

第一步：收集所有用戶定義的常量

$allConstants = get_defined_constants(true);

$userConstants = isset($allConstants['user']) ? $allConstants['user'] : [];

第二步：遍歷項目目錄，查找常量引用

$projectDir = __DIR__ . '/src'; // 項目源碼目錄
$usedConstants = [];

$files = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($projectDir));
foreach ($files as $file) {
    if ($file->isFile() && pathinfo($file, PATHINFO_EXTENSION) === 'php') {
        $content = file_get_contents($file->getPathname());
        foreach ($userConstants as $name => $value) {
            // 簡單的字符串查找，也可以用正則匹配精度更高
            if (strpos($content, $name) !== false) {
                $usedConstants[$name] = true;
            }
        }
    }
}

第三步：篩選未使用的常量

$unusedConstants = array_diff_key($userConstants, $usedConstants);

echo "未使用的常量列表：\n";
print_r(array_keys($unusedConstants));

補充建議

對於大型項目，推薦使用正則表達式避免誤判，比如變量名類似常量名時的干擾。
建議配合代碼靜態分析工具（如PHPStan、Psalm）進行多重校驗。
在移除常量前，建議在開發環境中反複測試，避免誤刪正在被動態引用的常量。

實際應用場景

假設你的項目中定義瞭如下常量：

 define('API_URL', 'https://m66.net/api/');
define('DEBUG_MODE', true);
define('UNUSED_CONST', 12345);

經過腳本分析發現UNUSED_CONST在項目中未被引用，就可以考慮將其從代碼中移除，從而提升項目代碼整潔性。

結語

雖然PHP 沒有內建功能來直接找出未使用的常量，但通過get_defined_constants函數與簡單的代碼掃描邏輯，我們依然可以實現這一目標。對常量的合理管理，有助於提升代碼可讀性、可維護性，也體現了一個項目的成熟度與規範性。