首页 » PHP教程 » php开辟规范文档技巧_PHP内部开拓规范

php开辟规范文档技巧_PHP内部开拓规范

访客 2024-11-12 0

扫一扫用手机浏览

文章目录 [+]

一、PHP 把稳事变

1、URL 要求地址采取”-“分割。
(已实行,部分人未按标准实行)

php开辟规范文档技巧_PHP内部开拓规范

2、方法名采取驼峰法。
(已实行,部分人未按标准实行)

php开辟规范文档技巧_PHP内部开拓规范
(图片来自网络侵删)

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、“预发布分支” 禁止合并到 “开拓分支”

标签:

相关文章

台州网站SEO运营,步骤布局与优化方法介绍

在互联网信息爆炸的今天,网站SEO(搜索引擎优化)已经成为企业提升网络曝光度和竞争力的重要手段。作为浙江省重要的沿海城市,台州拥有...

PHP教程 2025-03-31 阅读1 评论0