如何执行自定义注解收集器

[huanghantao]

使用的hyperf版本是v3.

我的相关目录结构如下：

app
├── Infrastructure
│   ├── Core
│   │   ├── Plugin
│   │   │   ├── PluginCollector.php
│   │   │   └── Repository
│   │   │       ├── Canary
│   │   │       │   ├── Canary.php
│   │   │       │   └── Config.php

首先定义了一个注解：

<?php

namespace App\Infrastructure\Core\Plugin;

use Hyperf\Di\Annotation\AbstractAnnotation;

#[\Attribute]
class PluginAnnotation extends AbstractAnnotation
{
    public function __construct(
        protected string $name,
    ) {
    }
}

然后使用注解：

<?php
namespace App\Infrastructure\Core\Plugin\Repository\Canary;

use App\Infrastructure\Core\Plugin\PluginAnnotation;

#[PluginAnnotation(name: 'canary')]
class Canary extends BasePlugin implements PluginInterface
{
}

然后定义了一个收集器：

<?php

namespace App\Infrastructure\Core\Plugin;

use Hyperf\Di\Annotation\AnnotationInterface;

class PluginCollector implements AnnotationInterface
{
    public function collectClass(string $className): void
    {
        var_dump('collectClass');
    }

    public function collectMethod(string $className, ?string $target): void
    {
        var_dump('collectMethod');
    }

    public function collectProperty(string $className, ?string $target): void
    {
        var_dump('collectProperty');
    }
}

然后在配置文件config/autoload/annotations.php进行配置：

<?php

declare(strict_types=1);

use App\Infrastructure\Core\Plugin\PluginCollector;

return [
    'scan' => [
        'paths' => [
            BASE_PATH . '/app',
        ],
        'ignore_annotations' => [
            'mixin',
        ],
        'class_map' => [
            Hyperf\Utils\Coroutine::class => BASE_PATH . '/app/Kernel/ClassMap/Coroutine.php',
            Hyperf\Di\Resolver\ResolverDispatcher::class => BASE_PATH . '/app/Kernel/ClassMap/ResolverDispatcher.php',
        ],
        'collectors' => [
            PluginCollector::class,
        ],
    ],
];

启动服务，但是没有执行收集器：

php bin/hyperf.php start
[INFO] HTTP Coroutine Server listening at 0.0.0.0:9764

[her-cat]

需要在 PluginAnnotation 注解中重写父类的 collectClass、collectMethod、collectProperty 方法，因为在父类中这三个方法默认使用 AnnotationCollector 收集器收集数据，而不是你定义的 PluginCollector，所以也就不会执行。

父类：

abstract class AbstractAnnotation implements AnnotationInterface, Arrayable
{
    public function collectClass(string $className): void
    {
        AnnotationCollector::collectClass($className, static::class, $this);
    }

    public function collectMethod(string $className, ?string $target): void
    {
        AnnotationCollector::collectMethod($className, $target, static::class, $this);
    }

    public function collectProperty(string $className, ?string $target): void
    {
        AnnotationCollector::collectProperty($className, $target, static::class, $this);
    }
}

将 PluginAnnotation 注解改成下面这样即可：

<?php

namespace App\Infrastructure\Core\Plugin;

use Hyperf\Di\Annotation\AbstractAnnotation;

#[\Attribute]
class PluginAnnotation extends AbstractAnnotation
{
    public function collectClass(string $className): void
    {
        PluginCollector::collectClass($className);
    }

    public function collectMethod(string $className, ?string $target): void
    {
        PluginCollector::collectMethod($className, $target);
    }

    public function collectProperty(string $className, ?string $target): void
    {
        PluginCollector::collectProperty($className, $target);
    }
}