/laravel-api

laravel7 框架电商 api

Primary LanguagePHP

代码格式化

  1. 代码格式化，php style code 选择laravel风格， option+command+L
  2. 优化导入，去掉不用的类和类排序，control+option+O
  3. 可以整个文件夹进行优化

编码设计规范

  1. 短函数，单函数不超过80行，最好40以内，一个函数只做好一件事，有明确的输入输出
  2. 有意义的函数命名，动宾结构，加上必要的函数注释
  3. 常量，所有字母都必须大写，词间以下划线分隔，比如：API_VERSION
  4. 属性，小写开头的驼峰式，比如：$adminUser
  5. 类函数，小写开头驼峰命名规范，比如：getUser
  6. 不允许使用拼音命名，除非专有名词，比如人民币单位yuan
  7. 尽可能使用已有的开源组件，不自己造轮子
  8. 路由规范，保留原项目的规范，使用具体的接口语义，只使用get和post，查询接口get，写接口post。
  9. 异常情况需要记录错误日志，以方便排查
  10. 响应格式规范化
Content-Type: application/json;charset=UTF-8 
{
    body 
}

body的json内容： 1.正常情况

{ 
    errno: xxx, 
    errmsg: xxx, 
    data: {} 
}

2.失败异常情况

{ 
    errno: xxx, 
    errmsg: xxx 
}

数据库规范

  • 表名、字段名全小写，下划线分隔单词，见名知意
  • 表设计默认情况存在id,add_time,update_time,deleted四个字段
  • 不使用存储过程、视图、触发器、Event

数据库只做它最擅长的存储，计算应该交给服务层

  • 禁止使用外键，如果有外键完整性约束，需要程序自行控制

外键会导致表与表之间耦合，影响sql 的性能

  • 禁止使用ENUM，可使用TINYINT代替
  • 数据库的相关操作一定不能用原生sql，要使用查询构造器进行语句的构建