PHP开发内部规范,欢迎提出优化建议
一、PHP 注意事项
- 1、URL 请求地址采用”-“分割。(已执行,部分人未按标准执行)
- 2、方法名采用驼峰法。(已执行,部分人未按标准执行)
- 3、参数必须小写和下划线分割,严禁使用驼峰或者其它格式,且提交参数与返回字段名一致。 (已执行,部分人未按标准执行)
- 4、获取数据采用 GET, 添加,修改必须 POST 。(已执行,部分人未按标准执行)
- 5、API 返回格式必须调用 jsonResult 基础方法。(已执行)
6、错误码必须调用 ErrCode,不能直接写错误码数字。(已执行) - 7、分页采用框架自带的, 自建二维数组必须 [‘data’ => $arr], 分页条目必须使用 limit 参数。(已执行)
- 8、接口返回备注信息(msg), 必须写在 config.msg 文件。(新增)
- 9、redis 的 key 必须写在 config.redis_key 文件。(已执行,部分人未按标准执行)
- 10、composer 安装新依赖必须写 doc/composer.txt 文件中,并说明用途。(已执行)
- 11、新增定时任务,进程必须写 doc/crontab.txt 文件中,并说明用途。(已执行)
- 12、redis 必须有设置过期时间。否则存 mysql,再缓存(新增)
- 13、model 名字与表名一致(如:表 q_user MODEL:QUser )
- 14、请求外网地址,必须设置请求时长 2s
- 15、redis 不存储长期数据, 只用于缓存和临时数据存储(后期转移非常容易导致数据丢失)
二、mysql 注意事项
新增表(负责人:刘军)
- 1、字符集 utf8mb4 排序规范 utf8mb4_unicode_ci(已执行,部分人未按标准执行)
- 2、数据库字段必须小写 + 下划线(已执行,部分人未按标准执行)
- 3、新表字段必须有 status,created_at,updated_at(关联表经常漏掉三个字段)
- 4、status 状态必须 1 启用, 0 禁用
- 5、尽量不使用 NULL
查询 - 1、查询 sql 字段必须加上表名(线上已出现过问题)
- 2、严禁使用 * 号查询
- 3、sql 语句必须写 model,不能写在控制器
更新、插入、删除 - 1、更新、插入、删除多条数据,非日志类型必须 “采用事务”(保证一致性)
三、YAPI 文档注意事项
- 1、字段说明必须与产品文档保持一致(前端反馈核对字段不清晰)
- 2、迭代版本接口需新增版本目录 (防止混乱)
- 3、接口有变更,必须同步更新接口文档
四、合并分支事项
- 1、必须以 master 创建分支开发,且带上自己的名字(origin/hotfix/huang/slowOpt)
- 2、发布至 master,必须先合 master 到开发分支
- 3、“测试分支” 禁止合并到 “开发分支”
- 4、“预发布分支” 禁止合并到 “开发分支”
本作品采用《CC 协议》,转载必须注明作者和本文链接
推荐文章: