如何在 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