php开发规范

Posted 2022-02-13 mg007

目录

• 1、路由API
  • 1.1、请求类型对应操作
  • 1.2、URL必须是名词
  • 1.3、URL使用复数（建议）
  • 1.4、避免多级 URL
• 2、命名
• 3、大括号
• 4、数据库
• 5、代码

1、路由API

? 遵循RESTful

1.1、请求类型对应操作

? GET： 读取（Read）
POST： 新建（Create）
PUT： 更新（Update）
PATCH： 部分更新（Update）
DELETE： 删除（Delete）

1.2、URL必须是名词

? /getAllCars （×）
/createNewCar （×）
/deleteAllRedCars （×）

? 选择正确的请求类型，已经说明了操作方式，
正确应参考：

? GET： /cars - 获取car列表
POST： /car - 新建car
PUT： /car/id/1 - 更新car
DELETE：/car/id/1 - 删除car

1.3、URL使用复数（建议）

? /articles（读取所有文章），建议使用复数

1.4、避免多级 URL

? GET /authors/12/categories/2 （×）
GET /authors/12?categories=2 （√）

? 查询已发布的文章：
GET /articles/published （×）
GET /articles?published=true （√）

2、命名

? 2.1、不能使用拼音
2.2、类名，静态属性，静态方法：大驼峰
2.3、常量：全大写，下划线分割
2.4、变量，方法，函数：小驼峰

3、大括号

//类
class ClassName



//静态方法：
public static function FunClass



//方法：
public function funClass



//其它if, for, foreach等
if(条件)

4、数据库

? 数据库表名与字段名：
均使用小写字母；
对于多个单词，下划线分割

5、代码

? 5.1、涉及到多个表 更新/添加 操作时，要用事务，保证数据库操作的原子性；
5.2、Model层，只做简单的数据表的查询；
5.3、业务逻辑统一封装到业务处理层；
5.4、控制器层，只做URL路由与数据返回；