Skip to content

Latest commit

 

History

History
37 lines (32 loc) · 2.31 KB

standard.md

File metadata and controls

37 lines (32 loc) · 2.31 KB

开发前必读

统一调用方式

基类里统一返回处理 base_msg 方法

统一方法返回值处理 成功 ok_msg 失败 err_msg

默认接口状态值 code 0成功 1失败

例如: $result = ['code'=>$code,'msg' => $msg, 'data' => $data,'time'=>time()];

修改.env 文件 域名 表前缀 数据库连接 必须使用 内网或者127.0.0.1 root账号连接 更改Redis表前缀 防止项目受影响

上线项目必须关闭调试模式 接口文档设置访问密码

初始密码 必须为强壮密码 大小写数组特殊字符 12位以上

目录使用小写+下划线;

类库、函数文件统一以.php为后缀;

类的文件名均以命名空间定义,并且命名空间的路径和类库文件所在路径一致;

类(包含接口和Trait)文件采用驼峰法命名(首字母大写),其它文件采用小写+下划线命名;

类名(包括接口和Trait)和文件名保持一致,统一采用驼峰法命名(首字母大写);

函数和类、属性命名

类的命名采用驼峰法(首字母大写),例如 User、UserType;

函数的命名使用小写字母和下划线(小写字母开头)的方式,例如 get_client_ip;

方法的命名使用驼峰法(首字母小写),例如 getUserName;

属性的命名使用驼峰法(首字母小写),例如 tableName、instance;

特例:以双下划线__打头的函数或方法作为魔术方法,例如 __call 和 __autoload;

常量和配置

常量以大写字母和下划线命名,例如 APP_PATH;

配置参数以小写字母和下划线命名,例如 url_route_on 和url_convert;

环境变量定义使用大写字母和下划线命名,例如APP_DEBUG;

数据库规范

表和字段 必须用utf8mb4 分布式数据库需要

数据表和字段采用小写加下划线方式命名,字段名不要以下划线开头

每个表 字段必须有创建时间,状态,是否删除,表描述,表创建人

建表名称要有统一的标准,建表后写注释,表名和作者

建表中的表名(简易的表名用英文,复杂的表名用拼音来代替)

建表时开发项目为方便快速找到表统一格式为(表前缀+表项目前缀+表名) 例如:pk_wangge_user(网格成员表)