如何过滤掉未使用的常量

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 函数与简单的代码扫描逻辑，我们依然可以实现这一目标。对常量的合理管理，有助于提升代码可读性、可维护性，也体现了一个项目的成熟度与规范性。