Yii编码规范

PHP一直被认为很草根,我是从java转到php,明白PHP规范相当重要,项目最后失控多半是因为没有严格执行规范,为帮助团队少走弯路,YII这个框架非常优秀,本人很喜欢这个框架,整理一些Yii开发规范供大家参考

命名采用驼峰式:
文件名即类名 类名称: 驼峰式 首字母大字 class PointController 
class PointRatioController 公共成员方法: 驼峰式 首字母小写 
public function getPointById() 私有成员方法: 驼峰式 首字母小写 
private function _getPointById() 公共成员变量: public $users public $userName 私有成员变量: private $_user private $_userName 常量: 所有字母大写,单词间用下划线分隔 const POS_HEAD = 0;

MVC模式: 

controller:
    action尽量不要出现sql查询(写进model或者封装到service类库),某个action很复杂首先应该考虑怎么拆分功能,又臭又长的action惹人厌    
    protected目录下增加service文件夹用来放业务封装类库,并在配置文件增加该文件夹自动import选项

view:
    能不用模板就不用模板,PHP本身就是一种很好的模板
    公共头部尾部等模板文件夹用"_include"方式命名

model: 与数据持久层的交互 
必要方法: 
    model();      // 静态方法 返回模型的实例 
    tableName(); // 返回数据库表名 
    rules();      // 表单的各种验证规则(用户名,email) 
    relations();  // 表关系配置(n:1 or 1:1 or n:n) 
    attributeLabels();  // 表字段国际化处理

数据库设计:
多数Web 应用是由数据库驱动的。
数据库表名和列名都使用小写命名。
名字中的单词应使用下划线分割 (例如 product_order)。
对于表名,你既可以使用单数也可以使用复数。但不要同时使用两者。为简单起见,我们推荐使用单数名字。
表名可以使用一个通用前缀,例如 tbl_ 。这样当应用所使用的表和另一个应用说使用的表共存于同一个数据库中时就特别有用。 这两个应用的表可以通过使用不同的表前缀很容易地区别开。 

代码编写规范
1.保持良好的PHP代码书写规范,合理使用缩进,保持代码美观,多余的var_dump/echo上线之后要记得删除
2.使用赋值符时变量名、赋值符、值之间以空格分隔 
3.多使用配置文件,避免硬编码  
4.多采用设计模式(工厂模式,单例模式等)
5.使用注释 
    a) 对类名进行注释 
    b) 方法名进行注释(包括每个方法的参数与返回值)
    c) 对常量进行注释 
    d) 对成员属性进行注释(public $userName; // 用户名)
    e) 配置文件进行注释
7.尽量封装逻辑代码,尽量减少单个action体积;尽量不要在action里面写数据库查询,应该封装到service类库
8.尽量让每个类做自己的事,每个函数做一件事

发布日期:
分类:Yii