当前位置：首页 > PHP

php实现annotation

2026-01-29 08:45:29PHP

在 PHP 中实现注解（Annotation）功能可以通过多种方式完成，以下是几种常见的方法：

使用 Doctrine Annotations 库

Doctrine Annotations 是一个流行的 PHP 库，提供了强大的注解功能。可以通过 Composer 安装：

composer require doctrine/annotations

定义注解类：

use Doctrine\Common\Annotations\Annotation;

/
 * @Annotation
 * @Target("CLASS")
 */
class MyAnnotation
{
    public $value;
}

在代码中使用注解：

/
 * @MyAnnotation("example")
 */
class MyClass
{
    // ...
}

解析注解：

use Doctrine\Common\Annotations\AnnotationReader;

$reader = new AnnotationReader();
$reflectionClass = new ReflectionClass('MyClass');
$annotation = $reader->getClassAnnotation($reflectionClass, 'MyAnnotation');
echo $annotation->value; // 输出 "example"

使用 PHP 原生 Reflection

PHP 的反射机制可以结合 DocBlock 解析实现简单的注解功能：

class MyClass
{
    /
     * @MyAnnotation("test")
     */
    public function myMethod()
    {
        // ...
    }
}

$reflectionMethod = new ReflectionMethod('MyClass', 'myMethod');
$docComment = $reflectionMethod->getDocComment();
preg_match('/@MyAnnotation\("([^"]+)"\)/', $docComment, $matches);
echo $matches[1]; // 输出 "test"

使用 Attributes（PHP 8+）

PHP 8 引入了原生属性（Attributes）功能，这是官方推荐的注解实现方式：

#[Attribute]
class MyAttribute
{
    public function __construct(public string $value)
    {
    }
}

#[MyAttribute('example')]
class MyClass
{
    // ...
}

$reflectionClass = new ReflectionClass('MyClass');
$attributes = $reflectionClass->getAttributes(MyAttribute::class);
foreach ($attributes as $attribute) {
    $instance = $attribute->newInstance();
    echo $instance->value; // 输出 "example"
}

使用第三方库如 PHP Annotate

PHP Annotate 是另一个轻量级注解库：

composer require mindplay/annotations

定义和使用：

php实现annotation

use mindplay\annotations\Annotations;

/
 * @example("sample")
 */
class MyClass
{
    // ...
}

$metadata = Annotations::ofClass('MyClass');
echo $metadata['example']; // 输出 "sample"

选择哪种方法取决于项目需求和 PHP 版本。对于新项目，推荐使用 PHP 8 的原生 Attributes；对于旧项目，Doctrine Annotations 是一个成熟的选择。