如何用PHP8属性实现PHPUnit测试与外部数据提供者分离？

问题核心 #

你遇到的问题有两个关键点：

1. PHPUnit默认的#[DataProvider]仅支持引用当前测试类内的方法，没有内置的DataProviderExternal属性
2. 你的数据提供者返回格式不符合PHPUnit要求——必须返回二维数组（每个子数组对应一组测试参数）

分步解决 #

1. 修正数据提供者的返回格式 #

PHPUnit要求数据提供者返回二维数组，每个子数组包含一组测试方法需要的参数。修改你的RouterDataProvider：

class RouterDataProvider
{
    public static function registerGetRouteData(): array
    {
        $route = new Route('/', ['IndexController', 'index']);
        
        // 返回二维数组，每个子数组是一组测试参数
        return [
            // 可选：给测试用例命名，方便识别结果
            '基础GET路由注册' => [
                $route,
                [
                    'GET' => [
                        '/' => $route,
                    ],
                    'POST' => []
                ]
            ]
        ];
    }
}

2. 选择外部数据提供者的调用方式 #

方式一：测试类内写代理方法（简单推荐）

在测试类中创建一个静态代理方法，调用外部数据提供者的方法，然后用PHPUnit默认的#[DataProvider]引用这个代理方法：

use PHPUnit\Framework\TestCase;

class RouterTest extends TestCase
{
    private Router $router;

    protected function setUp(): void
    {
        $this->router = new Router();
    }

    #[Test]
    #[DataProvider('registerGetRouteDataProvider')]
    public function itRegistersGetRoute(Route $route, array $expectedResult)
    {
        $this->router->get($route);
        $this->assertEquals($expectedResult, $this->router->getRoutes());
    }

    // 代理方法，转发到外部数据提供者
    public static function registerGetRouteDataProvider(): array
    {
        return RouterDataProvider::registerGetRouteData();
    }
}

方式二：自定义属性与PHPUnit扩展（复杂但更优雅）

如果你想保留#[DataProviderExternal]属性的写法，需要自定义属性类和PHPUnit扩展来解析它：

步骤1：创建自定义属性类

#[Attribute(Attribute::TARGET_METHOD)]
class DataProviderExternal
{
    public function __construct(
        public string $class,
        public string $method
    ) {}
}

步骤2：实现PHPUnit扩展

use PHPUnit\Runner\Extension\Extension;
use PHPUnit\Runner\Extension\Facade;
use PHPUnit\Runner\Extension\ParameterCollection;
use PHPUnit\Framework\Test;
use PHPUnit\Framework\TestCase;
use ReflectionMethod;
use PHPUnit\Framework\TestSuite;

class ExternalDataProviderExtension implements Extension
{
    public function bootstrap(Facade $facade, ParameterCollection $parameters): void
    {
        $facade->registerBeforeTestSuiteHook(function (TestSuite $suite): void {
            foreach ($suite->tests() as $test) {
                if (!$test instanceof TestCase) {
                    continue;
                }

                $testMethodName = $test->getName();
                $reflectionMethod = new ReflectionMethod($test, $testMethodName);
                $attributes = $reflectionMethod->getAttributes(DataProviderExternal::class);

                foreach ($attributes as $attribute) {
                    /** @var DataProviderExternal $attr */
                    $attr = $attribute->newInstance();
                    $providerClass = $attr->class;
                    $providerMethod = $attr->method;

                    if (!class_exists($providerClass) || !method_exists($providerClass, $providerMethod)) {
                        throw new \RuntimeException("外部数据提供者 {$providerClass}::{$providerMethod} 不存在");
                    }

                    // 获取数据并生成测试用例
                    $data = $providerClass::$providerMethod();
                    foreach ($data as $caseName => $params) {
                        $newTest = clone $test;
                        $newTest->setName($testMethodName . ' with data set ' . $caseName);
                        $newTest->setDependencies($test->dependencies());
                        // 注入参数
                        $reflection = new ReflectionClass($newTest);
                        $property = $reflection->getProperty('data');
                        $property->setValue($newTest, $params);
                        $suite->addTest($newTest);
                    }

                    // 移除原测试用例，避免重复执行
                    $suite->removeTest($test);
                }
            }
        });
    }
}

步骤3：在phpunit.xml中注册扩展

<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd">
    <extensions>
        <extension class="ExternalDataProviderExtension"/>
    </extensions>
</phpunit>

这样你就可以继续使用#[DataProviderExternal(RouterDataProvider::class, 'registerGetRouteData')]的写法了。

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