如何在PHPUnit中添加自定义约束？自定义比较器注册方法咨询

嘿，这个需求我之前在项目里刚实现过！要在PHPUnit里注册自定义比较器来处理接口的自定义值对比，其实分两步走就搞定了，我给你详细说说：

你需要实现PHPUnit的Comparator接口，或者更省事的是继承AbstractComparator（它已经帮你处理了很多基础逻辑）。举个例子，假设你要对比的是MyInterface接口的实例，只关心它们的getCustomIdentifier()返回值是否一致：

use PHPUnit\Framework\Comparator\AbstractComparator;
use PHPUnit\Framework\Comparator\ComparisonFailure;

class MyInterfaceComparator extends AbstractComparator
{
    // 告诉PHPUnit这个比较器能处理哪些类型
    public function accepts($expected, $actual): bool
    {
        return $expected instanceof MyInterface && $actual instanceof MyInterface;
    }

    // 实现你的自定义对比逻辑
    public function assertEquals($expected, $actual, $delta = 0.0, $canonicalize = false, $ignoreCase = false): void
    {
        // 按你的规则对比，这里只比较自定义标识符
        if ($expected->getCustomIdentifier() !== $actual->getCustomIdentifier()) {
            throw new ComparisonFailure(
                $expected,
                $actual,
                $this->exporter()->export($expected),
                $this->exporter()->export($actual),
                false,
                '两个MyInterface实例的自定义标识符不匹配'
            );
        }

        // 如果还需要保留默认的属性对比逻辑，可以调用父类方法
        // parent::assertEquals($expected, $actual, $delta, $canonicalize, $ignoreCase);
    }
}

注册分两种场景，按需选择：

场景一：仅在单个测试类中生效 #

直接在测试类的setUp()方法里注册即可，这样只会影响这个测试类的用例：

use PHPUnit\Framework\TestCase;
use PHPUnit\Framework\Comparator\ComparatorFactory;

class MyInterfaceTest extends TestCase
{
    protected function setUp(): void
    {
        parent::setUp();
        
        // 获取全局的比较器工厂实例
        $comparatorFactory = ComparatorFactory::getInstance();
        // 注册自定义比较器
        $comparatorFactory->register(new MyInterfaceComparator());
    }

    public function testInterfaceComparison()
    {
        $expected = new MyInterfaceImpl('user_123');
        $actual = new MyInterfaceImpl('user_123');
        
        // 现在调用assertEquals会自动用你的自定义比较器
        $this->assertEquals($expected, $actual);
    }
}

场景二：全局生效（所有测试用例都用） #

如果希望所有测试都能使用这个比较器，可以在PHPUnit的bootstrap文件里注册：

1. 先创建一个bootstrap.php文件，内容如下：

// bootstrap.php
require_once __DIR__ . '/path/to/MyInterfaceComparator.php';

use PHPUnit\Framework\Comparator\ComparatorFactory;

$comparatorFactory = ComparatorFactory::getInstance();
$comparatorFactory->register(new MyInterfaceComparator());

2. 然后在你的phpunit.xml（或phpunit.xml.dist）里指定这个bootstrap文件：

<phpunit bootstrap="bootstrap.php">
    <!-- 其他配置项 -->
</phpunit>

• 优先级问题：ComparatorFactory会按照注册顺序检查每个比较器的accepts()方法，第一个匹配的就会被使用。所以如果你的自定义比较器和内置比较器都能处理某类型，自定义的会先生效。
• 移除比较器：如果需要替换内置的某个比较器，可以先调用$comparatorFactory->unregister($existingComparator)，再注册你的自定义版本，但一般不需要这么做。
• 异常抛出：对比失败时一定要抛出ComparisonFailure异常，这样PHPUnit才能正确生成友好的错误提示。

内容的提问来源于stack exchange，提问作者thelastshadow