PHP 反射获取类注解 attribute,解析自定义标记做元编程

落芳君_6527

落芳君_6527

2026-10-03

136人浏览

原创

php 8.0+ 支持原生 attribute,配合 reflection 可实现元编程;通过 getattributes() 获取并用 newinstance() 实例化自定义注解类,支持类、方法、参数等多目标标记,适用于路由、权限、日志等行为增强。

php 反射获取类注解 attribute,解析自定义标记做元编程

PHP 8.0+ 支持原生 Attribute(即注解),配合反射(Reflection)可实现轻量级元编程。要获取类、方法或属性上的自定义 attribute 并解析执行逻辑,核心是使用 ReflectionClass、ReflectionMethod 等的 getAttributes() 方法。

定义自定义 Attribute 类

Attribute 必须用 #[Attribute] 标记,并指定作用域(如 Attribute::TARGET_CLASS)。它本身是一个普通类,可带构造参数:

#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
class Route
{
    public function __construct(
        public string $path,
        public string $method = 'GET'
    ) {}
}

用反射读取并匹配 Attribute

通过反射对象调用 getAttributes() 获取所有 attribute 实例,再用 isInstance() 或直接类型检查筛选目标 attribute:

btpanel phpsite 宝塔面板PHP网站
btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载
$ref = new ReflectionClass(UserController::class);
$attrs = $ref->getAttributes(Route::class);

foreach ($attrs as $attr) {
    $route = $attr->newInstance(); // 触发构造,拿到实例
    echo "Route: {$route->method} {$route->path}\n";
}
  • getAttributes() 返回 ReflectionAttribute[] 数组,不传参则返回全部,传类名则只返回该类型
  • newInstance() 安全执行构造逻辑,支持带参、默认值、类型约束
  • 若 attribute 构造失败(如类型不匹配),会抛出 Error,建议加 try-catch

在方法或参数上使用 Attribute 做行为增强

Attribute 不仅能标记类,还能标记方法、参数、属性等,适合做权限校验、日志、自动绑定等:

class Auth
{
    public function __construct(public string $role) {}
}

class AdminController
{
    #[Auth('admin')]
    public function deleteUser(int $id): void
    {
        // ...
    }
}

// 反射检查方法是否需鉴权
$method = new ReflectionMethod(AdminController::class, 'deleteUser');
$authAttr = $method->getAttributes(Auth::class)[0] ?? null;

if ($authAttr) {
    $auth = $authAttr->newInstance();
    if (!hasRole($auth->role)) {
        throw new PermissionDeniedException();
    }
}

结合注解与运行时逻辑实现简易路由分发

可基于 class 和 method 的 #[Route] 自动生成路由映射表:

  • 扫描控制器目录,用 get_declared_classes() 或 Composer autoload + 文件遍历获取候选类
  • 对每个类,检查 getAttributes(Route::class) 获取全局路径前缀
  • 遍历其 public 方法,检查方法级 #[Route],拼接完整路径
  • 注册闭包或控制器动作到路由调度器中

这种模式避免配置文件,代码即契约,适合中小型 CLI 或 API 服务快速搭建。

php免费学习视频:立即使用
踏上前端学习之旅,开启通往精通之路!从前端基础到项目实战,循序渐进,一步一个脚印,迈向巅峰!

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

9824

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

5861

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2075

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3668

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4354

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3411

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

4877

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

3802

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11802

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
《20天入门精通PHP》视频教程
《20天入门精通PHP》视频教程

共200课时 | 48.1万人学习

墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习