PHP开发内部规范有哪些
本篇内容介绍了“PHP开发内部规范有哪些”的有关知识,在实际案例的操作过程中,不少人都会遇到这样的困境,接下来就让小编带领大家学习一下如何处理这些情况吧!希望大家仔细阅读,能够学有所成!
一、PHP注意事项
URL请求地址采用”-“分割。(已执行,部分人未按标准执行)
方法名采用驼峰法。(已执行,部分人未按标准执行)
参数必须小写和下划线分割,严禁使用驼峰或者其它格式,且提交参数与返回字段名一致。 (已执行,部分人未按标准执行)
获取数据采用GET, 添加,修改必须POST 。(已执行,部分人未按标准执行)
API返回格式必须调用jsonResult基础方法。(已执行)
6、错误码必须调用ErrCode,不能直接写错误码数字。(已执行)分页采用框架自带的, 自建二维数组必须[‘data’ => $arr], 分页条目必须使用limit参数。(已执行)
接口返回备注信息(msg),必须写在config.msg文件。(新增)
redis的key必须写在config.redis_key文件。(已执行,部分人未按标准执行)
composer安装新依赖必须写doc/composer.txt文件中,并说明用途。(已执行)
新增定时任务,进程必须写doc/crontab.txt文件中,并说明用途。(已执行)
redis必须有设置过期时间。否则存mysql,再缓存(新增)
model名字与表名一致(如:表q_user MODEL:QUser )
请求外网地址,必须设置请求时长2s
redis不存储长期数据, 只用于缓存和临时数据存储(后期转移非常容易导致数据丢失)
二、mysql注意事项
新增表(负责人:刘军)
字符集utf8mb4 排序规范utf8mb4_unicode_ci(已执行,部分人未按标准执行)
数据库字段必须小写+下划线(已执行,部分人未按标准执行)
新表字段必须有status,created_at,updated_at(关联表经常漏掉三个字段)
status状态必须1启用, 0禁用
尽量不使用NULL
查询查询sql字段必须加上表名(线上已出现过问题)
严禁使用*号查询
sql语句必须写model,不能写在控制器
更新、插入、删除更新、插入、删除多条数据,非日志类型必须“采用事务”(保证一致性)
三、YAPI文档注意事项
字段说明必须与产品文档保持一致(前端反馈核对字段不清晰)
迭代版本接口需新增版本目录 (防止混乱)
接口有变更,必须同步更新接口文档
四、合并分支事项
必须以master创建分支开发,且带上自己的名字(origin/hotfix/huang/slowOpt)
发布至master,必须先合master到开发分支
“测试分支”禁止合并到“开发分支”
“预发布分支”禁止合并到“开发分支”
“PHP开发内部规范有哪些”的内容就介绍到这里了,感谢大家的阅读。如果想了解更多行业相关的知识可以关注编程网网站,小编将为大家输出更多高质量的实用文章!
免责声明:
① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。
② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341