如何在Hyperf 3.0中定义一个带参数的自定义注解_通过构造函数接收Attribute参数

胖枫君_5965

胖枫君_5965

2026-05-20

670人浏览

原创

hyperf 3.0 自定义注解必须使用#[attribute]声明,基于 php 8.1+ 原生 attributes,不再支持旧版@annotation风格;需指定作用域(如attribute::target_method)、通过构造函数参数接收值,并在aop切面中用getattributes()和newinstance()安全读取。

如何在hyperf 3.0中定义一个带参数的自定义注解_通过构造函数接收attribute参数

Hyperf 3.0 中自定义注解必须用 #[Attribute] 声明

Hyperf 3.0 基于 PHP 8.1+ 的原生 Attributes,不再支持旧版 @Annotation 风格。如果你沿用 Hyperf 2.x 的写法(比如继承 AbstractAnnotation),运行时会直接报错:Attribute class not found 或触发 ReflectionException。

正确做法是:定义一个普通类,加上 #[Attribute],并指定作用域(如 Attribute::TARGET_METHOD)。构造函数参数即为注解的“属性”,无需额外解析逻辑。

  • #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS)] —— 明确声明可用位置,否则默认只允许用于类
  • 构造函数参数自动映射为注解调用时的命名参数,例如 #[MyAnnotation(name: "foo", enabled: true)]
  • 参数类型必须可被 PHP 反射识别(string、int、bool、array、enum,或带 #[Serializable] 的类)

如何接收并验证构造函数参数

Hyperf 不干涉注解类本身的逻辑,所以参数校验、默认值、类型转换全靠你手动处理。别指望框架自动帮你做 isset 或 filter_var。

推荐在构造函数里做最小必要校验:

Hyperframes Creative
Hyperframes Creative

HyperFrames视频非动画创意指导,包括设计规范(frame.md/design.md)处理、配色、字体设计、旁白及节奏规划等。

下载
  • 必填参数用类型声明 + ?? 提供默认值,例如 public function __construct(public string $name, public bool $enabled = true)
  • 避免在构造函数里抛异常(PHP 层面限制),改用 assert() 或记录 warning(尤其当参数来自用户输入时)
  • 若需复杂校验(如正则、长度),建议封装到 getter 方法中,比如 public function getValidatedName(): string { assert(strlen($this->name) name; }

在 AOP 切面中读取带参注解的值

Hyperf 的 Aspect 通过 ReflectionMethod 拿注解实例,再调用其属性或方法。注意:不能直接用 $method->getAttributes(MyAnnotation::class)[0]->name 就完事——得先检查数组非空,且确保返回的是你期望的注解类。

典型安全读取方式:

#[Aspect]
class MyAspect
{
    #[PointExecution("App\Controller\*->*()")]
    public function process(ProceedingJoinPoint $proceedingJoinPoint): mixed
    {
        $method = $proceedingJoinPoint->getMethod();
        $attrs = $method->getAttributes(MyAnnotation::class);
        if (!$attrs) {
            return $proceedingJoinPoint->process();
        }
        $annotation = $attrs[0]->newInstance(); // 注意:这里触发构造函数重执行(若含副作用要小心)
        $name = $annotation->name;
        $enabled = $annotation->enabled;

        if ($enabled) {
            // 执行逻辑...
        }

        return $proceedingJoinPoint->process();
    }
}
  • newInstance() 是关键:它用当前注解声明时传入的参数重新实例化对象,不是从容器拿单例
  • 如果注解类构造函数有副作用(如写日志、发 HTTP 请求),每次切面匹配都会触发,容易被忽略
  • 不建议在 newInstance() 后再做耗时操作,AOP 本身已影响性能

常见错误:参数名拼错、类型不匹配、未启用 Attribute 支持

最常卡住的地方其实是 PHP 配置和 IDE 提示断层:

  • PHP 版本低于 8.1?Attribute 类根本不存在,报错 Class "Attribute" not found
  • 注解类没加 #[Attribute],却在代码里写了 #[MyAnnotation(...)] → 运行时报 Unknown attribute
  • 参数名大小写不一致,比如声明 public string $userName,但调用写成 #[MyAnnotation(username: "a")] → 参数被忽略,值为 null 或默认值
  • IDE(如 PhpStorm)可能不识别自定义 Attribute,导致无补全、无跳转,但这不影响运行,别因此怀疑写法

Hyperf 3.0 的注解本质就是 PHP 原生 Attribute,没有魔法。参数是否生效,只取决于反射能否拿到实例、构造函数能否接受传入值、以及你的切面有没有正确调用 newInstance()。其余都是 PHP 语言层的事。

相关专题

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

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

2023.09.01

10104

6

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

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

2023.10.11

5981

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

3748

4

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

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

2023.10.23

4454

6

html怎么上传
html怎么上传

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

2023.11.03

3491

9

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

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

2023.11.09

4977

8

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

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

2023.11.13

3902

8

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

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

2023.11.27

11862

4

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Hyperf官方中文手册(3.1)
Hyperf官方中文手册(3.1)

共0课时 | 0人学习

Swoole系列-从0到1-新手进阶
Swoole系列-从0到1-新手进阶

共29课时 | 2.3万人学习