php 后端规范

后端框架地址:
git@gitee.com:xielisen/xcore.git
框架使用规范,内部沟通

Controller命名规范
1, 首字母大写,其余小写
2, 对应数据库名称. 不要下划线
3, 方法名 驼峰. 首字母小写
4, 通用方法名称 add, edit, detail, lists
5,
注释: 不能太多, 按功能代码块: 简单注释
空行: 不同的代码块,可空一行区分开. 不能空多行
sql: 长sql , 要sql美化
缩进: 代码块,缩进分明.
6, 变量命名
1) 简短常见, $rs, $res, $result,$info, $lists,
2) 模型 直接用函数标识, 不要中间变量
3) 前缀区分

程序流程
1: 验证参数
2: 格式化参数
3: 简单的入库, 修改和查询 直接调用db
4: 复用的, 逻辑复杂的. 一定要写model
5: 查询不要写model. 除非很多复用的地方
6: 涉及图片处理的. 注意要调用底层图片处理类

Model命名规范
1, 首字母大写, 驼峰
2, 对应数据库名称
3, 通用方法名称 add, edit, detail, lists
4, 方法的颗粒度要合适. 不能大而全, 也不能太小导致数据多次查询

程序流程
1: 参数要顾名思义
2: 尽量考虑扩展和通用
3: 涉及权限的, 一定要验证. 防止越权
4: 统一错误处理方式
5: 统一失败返回false

命名原则:
1, 简短,常用的单词
2, 类名已表达了的意思, 方法名不要重复
比如:
User类下添加用户. 命名为: add 而不能命名为addUser
3, 关键词, 可以加s 避开关键词