.augment-guidelines 3.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. # Augment Guidelines for KKU Laravel Project
  2. ## 项目概述
  3. - 这是一个基于Laravel 11的农场游戏系统
  4. - 项目本地使用Docker运行
  5. - 当前项目处理维护期,不得随意对数据库的表结构进行修改,不得对涉及游戏数值的表进行修改
  6. - 优先使用UCore的基类,而不是Laravel的基类
  7. ## 工作流程规范
  8. ### 任务开始前
  9. 1. 获取当前时间:使用 `date` 命令
  10. 2. 检查git状态:`git status`
  11. ### 任务执行中
  12. 1. 使用MCP测试网页修改
  13. 2. 使用MCP执行SQL操作
  14. 3. 使用 `php artisan debug:reproduce-error` 命令进行请求(sys_request_logs表)回放
  15. 4. 编写代码时添加中文注释
  16. 5. 不能使用tinker
  17. ### 任务完成后
  18. 1. 检查git状态并提交代码:使用中文CommitMessage
  19. 2. Push代码到远程仓库
  20. 3. 创建任务记录:`./AiWork/年月/日时分-任务标题.md`
  21. ### 命名规范
  22. - 枚举:遵循PSR-4标准,使用PHP enum语法,避免魔法数字
  23. ### 设计原则
  24. - 功能拆分为独立简单静态类,避免复杂设计模式
  25. - 模块间通过Service层交互,不直接访问其他模块模型
  26. - 事件用于模块间通信,模块内部不使用事件机制
  27. ## 架构设计规范
  28. ### 模型层 (Model)
  29. - 继承自 `\UCore\ModelCore`,保持无业务逻辑
  30. - 在模型中定义访问器而非控制器中实现逻辑
  31. - 为模型创建独立Cast类,不同模型不共用Cast类
  32. - 不使用数据库迁移类,直接提供SQL语句修改数据库结构
  33. ### 后台(Admin)
  34. - 后台控制器继承自 `UCore\DcatAdmin\AdminController`
  35. - 使用Grid/Show/Form的'make'方法实例化
  36. - 使用GridHelper/ShowHelper/FormHelper/FilterHelper辅助类
  37. - 后台控制器添加路由注释,加入后台菜单适当位置
  38. - 后台列表页面来源表名列可点击跳转到对应详情页面
  39. - Repository类参考Fund模块实现,内部不包含方法,仅供后台管理数据访问
  40. - 仓库层仅供后台控制器使用
  41. ### 服务层 (Service) 和逻辑层 (Logic)
  42. - 服务层:对外Service(静态方法),内部Logic类
  43. - 服务层直接使用逻辑层和模型,仓库层仅供后台控制器使用
  44. - 服务层返回DTO对象而非Model
  45. - 逻辑层不能开启事务,需要事务进行事务开启检查,不能进行异常Try/Catch,这会导致异常被隐藏
  46. - 保持逻辑的原子性,不能让逻辑部分成功(异常被Catch导致外层无法收到错误而继续执行)
  47. ### DTO层
  48. - DTO类继承自 `UCore\Dto\BaseDto`
  49. - 使用驼峰命名公共属性
  50. ### 验证层 (Validation/Validator)
  51. - 使用Validation和Validator类处理验证逻辑,参考'docs/Validation使用示例.md'
  52. - Validation类禁止动态属性赋值,需先定义属性并声明类型
  53. ### Handler层
  54. - Handler类参考PesticideHandler模式:先验证再执行操作
  55. - Handler类不设置异常处理,继续抛出异常交由框架处理
  56. ## 包管理规范
  57. - 始终使用包管理器进行依赖管理,不手动编辑包配置文件
  58. ## 测试规范
  59. - 在tests目录编写非模块phpunit测试
  60. - 使用 `vendor/bin/phpunit` 运行测试
  61. - 测试的 Command在Test模块编写
  62. - 建议为新功能编写测试并执行验证
  63. ## 文档规范
  64. - README.md使用可点击目录结构,包含锚点链接和状态图标
  65. - 文档偏好包含流程图和图表以便更好地可视化
  66. ## 调试和错误处理
  67. - 接口数据问题时优先检查数据结构字段名匹配
  68. - 注意Logic层返回字段名与Handler中访问字段名一致
  69. - Handler处理protobuf响应时确保所有必需字段有正确数据源
  70. - 使用 `php artisan debug:reproduce-error {请求ID}` 命令回放错误请求进行调试验证,
  71. ## 特殊注意事项
  72. - 不使用数据库迁移,不注册路由(使用注解),不包含视图/前端资源/中间件/计划任务
  73. - 后台管理界面使用Dcat Admin框架,不使用通用REST API