[备忘]项目开发约定总结

* 1、代码要规范,禁止拼音、极简缩写，无意义词组
* 2、业务逻辑代码必须放在业务逻辑层logic
* 3、数据查询必须放在模型层，禁止在控制器或其它地方书写sql
* 4、除统计或必要查询外，一般不用联合查询
* 5、尽量多写注释，方便下次维护回忆代码初衷
* 6、禁止在sql中使用大量sql函数，必须使用时除外 eg：now()等函数禁用
* 7、业务函数可放在common公共函数文件，纯工具函数放在Tools.php类中
* 8、数据库表名必须使用有意思的单词且表名必须注释其作用，甚至可写出其在何种业务场景下使用
* 9、索引不是越多越好，慎用
* 10、绝对禁止多if条件嵌套，应不超过2层，特殊情况下除外，也应当少用
* 11、可在代码开始前，将可能的错误return出去(接收方可能是js，或api)
* 12、项目尽可能设计为AOP模式，尽可能不依赖其它模块
* 13、项目结构应层次分明，每层分工完成不同功能
* 14、所有函数或方法应尽可能单一化，增强可维护性
* 15、尽可能在代码中（或其它方法）循环处理数据，避免在数据库中做大量操作，减少数据库压力
* 16、所有使用到联合查询的地方必须用原生查询 Db::query(sql_str)

 

 

end