|
|
@@ -28,15 +28,9 @@
|
|
|
### 语言和注释
|
|
|
- 使用中文进行交流和编写文档
|
|
|
- 代码中增加中文注释
|
|
|
-- 文档使用明确关键词:'买入'改为'用户买入物品','卖出'改为'用户卖出物品'
|
|
|
|
|
|
### 命名规范
|
|
|
-- 数据库表前缀:全局'kku_',物品模块'item_',宠物模块'pet_'
|
|
|
-- Handler命名空间:'App\Module\AppGame\Handler'
|
|
|
- 枚举:遵循PSR-4标准,使用PHP enum语法,避免魔法数字
|
|
|
-- 控制器和仓库:名称与关联表名匹配
|
|
|
-- Validator类:以'Validator'结尾
|
|
|
-- Repository类:以'Repository'结尾
|
|
|
|
|
|
### 设计原则
|
|
|
- 功能拆分为独立简单静态类,避免复杂设计模式
|
|
|
@@ -51,9 +45,8 @@
|
|
|
- 在模型中定义访问器而非控制器中实现逻辑
|
|
|
- 为模型创建独立Cast类,不同模型不共用Cast类
|
|
|
- 不使用数据库迁移类,直接提供SQL语句修改数据库结构
|
|
|
-- Model类添加field start/end注释块,只保留// attrlist start/end标识符包围的$fillable定义
|
|
|
|
|
|
-### 控制器层 (Controller)
|
|
|
+### 后台控制器层 (Controller)
|
|
|
- 后端控制器继承自 `UCore\DcatAdmin\AdminController`
|
|
|
- 使用Grid/Show/Form的'make'方法实例化
|
|
|
- 使用GridHelper/ShowHelper/FormHelper/FilterHelper辅助类
|
|
|
@@ -85,12 +78,9 @@
|
|
|
- Handler类参考PesticideHandler模式:先验证再执行操作
|
|
|
- Handler类不设置异常处理,继续抛出异常交由框架处理
|
|
|
- Handler成功时使用RESPONSE_CODE常量设置响应码,不使用魔法数字0
|
|
|
-- 动作型方法使用Res对象处理返回值,不直接返回数组
|
|
|
|
|
|
## 包管理规范
|
|
|
- 始终使用包管理器进行依赖管理,不手动编辑包配置文件
|
|
|
-- Laravel项目使用 `composer require/remove` 命令
|
|
|
-- 前端依赖使用 `npm install/uninstall` 或 `yarn add/remove`
|
|
|
|
|
|
## 测试规范
|
|
|
- 在tests目录编写非模块phpunit测试
|
|
|
@@ -101,7 +91,6 @@
|
|
|
## 文档规范
|
|
|
- 自动生成目录下添加README.md声明内容自动生成不可修改
|
|
|
- README.md使用可点击目录结构,包含锚点链接和状态图标
|
|
|
-- 基于成熟模块架构设计完善文档,提炼通用开发规范和最佳实践
|
|
|
- 文档偏好包含流程图和图表以便更好地可视化
|
|
|
|
|
|
## 核心模块特殊规范
|
|
|
@@ -119,7 +108,6 @@
|
|
|
- 不需要自动解冻逻辑(由冻结发起方处理)
|
|
|
|
|
|
### Mex模块(农贸市场交易系统)
|
|
|
-- 仓库账户USER_ID=15,调控账户USER_ID=16
|
|
|
- 挂单时无价格验证,最低价和最高价仅为参考
|
|
|
- 挂单不会立即成交,所有订单先创建后由撮合任务处理成交
|
|
|
- 大额订单应该卡住小额订单(业务需求而非要避免的问题)
|
|
|
@@ -149,7 +137,5 @@
|
|
|
- 使用 `php artisan debug:reproduce-error` 命令回放错误请求进行调试验证
|
|
|
|
|
|
## 特殊注意事项
|
|
|
-- 系统使用双用户ID概念:urs_user_id作为核心用户ID对应URS系统用户,user_id作为辅助ID对应农场用户
|
|
|
-- 推荐码功能已移除
|
|
|
- 不使用数据库迁移,不注册路由(使用注解),不包含视图/前端资源/中间件/计划任务
|
|
|
- 后台管理界面使用Dcat Admin框架,不使用通用REST API
|