讲师中心 微信公众号
AI工具推荐 视频效率加速

解决注解不生效:Hyperf annotations.php 扫描配置【排错指南】

老芳君_2973

老芳君_2973

发布时间:2026-08-08 14:43:00

|

602人浏览过

|

来源于php中文网

原创

Hyperf注解失效主因是路径未配置和缓存未生成:scan.paths未包含自定义目录导致文件不被扫描;SCAN_CACHEABLE=true时需手动执行di:init-proxy生成缓存,否则注解不生效。

解决注解不生效:hyperf annotations.php 扫描配置【排错指南】

scan.paths 漏目录 = 注解根本没被读到

Hyperf 默认只扫描 BASE_PATH . '/app',你把控制器放在 app/Http/Controller、服务类放在 Domain/User、或者模块在 MyApp,只要没显式加进 config/autoload/annotations.php 的 scan.paths,框架连文件名都不会打开——更别说解析注解了。

检查点:

  • 路径必须用正斜杠,app\Controller(Windows 风格反斜杠)是错的,app/Controller 也不行,必须写成 BASE_PATH . '/app/Controller'
  • 自定义目录(如 MyApp、Modules)要同步改两处:composer.json 的 autoload.psr-4 + annotations.php 的 scan.paths
  • 确认目录真实存在:ls -l app/Controller(注意大小写、末尾 s 是否漏了)

PHP 8 Attributes 写法错一点就静默失效

Hyperf 3.0+ 彻底弃用 /** @Controller */ 这类 Doctrine 注释,也完全不识别属性类型提示(如 public UserService $userService;)。错写成注释、漏写 #[Attribute]、作用域不对,都会导致路由 404 或注入为 null,且无任何日志。

正确写法要点:

立即学习“PHP免费学习笔记(深入)”;

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

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

下载
  • #[Controller] 和 #[GetMapping] 必须在同一类中,且类名需符合 PSR-4(如 HelloController.php → App\Controller\HelloController)
  • 属性注入必须显式写 #[Inject]:#[Inject] public UserService $userService;,不能只靠类型提示
  • 构造函数注入支持命名参数:public function __construct(#[Inject] UserService $service) { }
  • 自定义注解类必须继承 #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)],不能只写 #[Attribute]

SCAN_CACHEABLE 开着但缓存没生成 = 白配置

SCAN_CACHEABLE=true 不是“自动缓存开关”,它只是个条件判断:只有当 runtime/container/annotation/ 下存在合法 PHP 缓存文件时,才会跳过扫描。这些文件不会自己生成,必须手动触发。

关键操作:

  • 首次部署或改完 scan.paths 后,必须运行:php bin/hyperf.php di:init-proxy
  • Docker 构建时,runtime/container/ 不能被 .dockerignore 过滤,也不能在 ENTRYPOINT 里删掉再重跑
  • 开发环境建议关掉缓存:'cacheable' => false,否则改了注解不重启服务就无效
  • 即使缓存已存在,只要 config/autoload/annotations.php 中 'scan' => ['enable' => true],Hyperf 仍会先尝试扫描——这步多余且可能报路径不可读警告

AnnotationCollector 拿不到注解?先看注解类有没有被扫描

自定义注解类(比如权限注解 #[Permission])如果放在 App\Annotation 以外的路径,或者没加进 scan.paths,AnnotationCollector::getAnnotationsByMethod() 就永远返回空数组——不是代码写错了,是注解类压根没被加载。

排查步骤:

  • 注解类必须放在 scan.paths 包含的目录下(如 app/Annotations),并在 annotations.php 中注册该路径
  • 注解类顶部必须有 use Attribute;,且声明 #[Attribute(Attribute::TARGET_METHOD)]
  • 别把注解类和控制器混放——比如放在 App\Controller 下,框架扫描时可能因命名空间不匹配直接跳过
  • 运行 composer dump-autoload -o 确保类能被自动加载,否则 di:init-proxy 阶段连类都找不到

注解扫描是个两级生效过程:Composer autoloader 要能加载类,Hyperf 的 Finder 才会去读文件内容;两者缺一,注解就等于不存在。最常被忽略的是路径拼接错误和缓存未生成这两步,而不是语法本身。

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

相关专题

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

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

11424

2023.09.01

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

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

6601

2023.10.11

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

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

2175

2023.10.11

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

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

4188

2023.10.23

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

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

4894

2023.10.23

html怎么上传
html怎么上传

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

3831

2023.11.03

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

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

5537

2023.11.09

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

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

4342

2023.11.13

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

40

2026.10.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn