Laravel 4 项目开发与命名规范
为了便于后期维护,现对使用
Laravel 4.2.x
的项目做出开发与命名上的约束。本文只对某些重点做出具体约束,可能存在遗漏的地方,欢迎补充说明。
自动加载
Laravel
使用 Composer
进行源码管理,自动加载推荐遵循 PSR-4
规范,可以到此查阅相关文档:
数据库命名规范
参照 Laravel
模型相关内容,我们可以看出,Laravel
倾向于使用复数名词作为表名,Laravel
框架自带了一个 User
模型操作 users
用户表。
推荐使用三个小写字母以上的字符串作为数据库表前缀,如芽丝内容管理框架就使用yascmf_
作为表前缀。
数据库表默认使用utf8_unicode_ci
作为排序规则。
数据表名与表字段推荐使用全小写英文字母,单词之间采用下划线 (_
) 作为分隔符;数据库字段应避免使用 MySQL
关键字(如desc
、 null
、 count
与 order
等 );数据库表及字段在设计时应添加与保留注释(即 COMMENT
)内容。
使用Laravel ORM
时,可能还需要添加额外的字段,如自动时间戳记录的字段 created_at
、 updated_at
与 deleted_at
等。
在 SQL
语句的编写中,凡是 SQL
语句的关键字一律大写,如:SELECT
、ORDER BY
、 GROUP BY
、 FROM
、 WHERE
、 UPDATE
、 INSERT INTO
、 SET
、 BEGIN
、 END
等。
遵守第三范式 3NF
标准的规定:
A.表内的每一个值都只能被表达一次。
B.表内的每一行都应该被唯一的标识(有唯一键)。
C.表内不应该存储依赖于其他键的非键信息。
主键(包括联合主键)与索引名应表义清晰明确,唯一索引建议带上_unique
缀名,以与其它普通索引区别。