当前位置：首页 > PHP

php实现annotation

2026-02-14 06:54:59PHP

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

使用Reflection和DocBlock解析

PHP原生支持通过反射（Reflection）获取类、方法或属性的文档注释（DocBlock），再通过正则表达式或第三方库解析注解内容。

/
 * @Route("/api/user", methods={"GET"})
 */
class UserController {
    /
     * @Cache(ttl=3600)
     */
    public function getUser($id) {}
}

通过反射获取注解：

$reflectionClass = new ReflectionClass('UserController');
$docComment = $reflectionClass->getDocComment();
// 使用正则解析@Route注解
preg_match('/@Route\("([^"]+)", methods={([^}]+)}\)/', $docComment, $matches);

使用Doctrine Annotations库

Doctrine提供的Annotations库是PHP中最成熟的注解解决方案之一。

安装依赖：

composer require doctrine/annotations

定义注解类：

use Doctrine\Common\Annotations\Annotation;

/
 * @Annotation
 * @Target("CLASS")
 */
class Route {
    public $path;
    public $methods = [];
}

使用注解：

/
 * @Route(path="/api/user", methods={"GET"})
 */
class UserController {}

解析注解：

use Doctrine\Common\Annotations\AnnotationReader;

$reader = new AnnotationReader();
$class = new ReflectionClass('UserController');
$routeAnnotation = $reader->getClassAnnotation($class, Route::class);

使用PHP 8原生Attributes

PHP 8引入了原生Attributes功能，语法更简洁且性能更高。

定义Attribute：

#[Attribute(Attribute::TARGET_CLASS)]
class Route {
    public function __construct(
        public string $path,
        public array $methods = []
    ) {}
}

使用Attribute：

#[Route(path: "/api/user", methods: ["GET"])]
class UserController {}

通过反射读取：

$reflectionClass = new ReflectionClass('UserController');
$attributes = $reflectionClass->getAttributes(Route::class);
$route = $attributes[0]->newInstance();

自定义注解处理器

可以结合以上方法构建完整的注解处理流程：

定义注解类（使用Doctrine风格或PHP 8 Attributes）
通过反射获取目标类/方法/属性
使用注解阅读器解析注解
根据注解内容执行相应逻辑（如路由注册、缓存设置等）

// 示例：自动注册路由
foreach ($controllers as $controllerClass) {
    $reflection = new ReflectionClass($controllerClass);
    $route = $reader->getClassAnnotation($reflection, Route::class);
    if ($route) {
        $router->addRoute($route->path, [$controllerClass, 'handle']);
    }
}