Laravel命名规范速查表
Laravel命名规范速查表
对象 | 规则 | 写法 |
---|---|---|
控制器 | 单数大驼峰命名 | UserAddressController |
路由URI | 复数脊柱命名 | users/audit-log |
路由命名 | 带点符号的蛇形命名 | users.show_active |
路由参数 | 单数蛇形命名 | ?page=1&per_page=2 |
模型 | 单数大驼峰命名 | UserAddress |
数据表 | 复数蛇形命名 | user_addresses |
数据表字段 | 单数蛇形命名并且不要带自身表名 | should_display_on_index |
关联表 | 单数按字母顺序排列模型 | article_user |
hasOne或belongsTo关系 | 单数小驼峰命名 | articleComment |
所有其他关系 | 复数小驼峰命名 | articleComments |
外键 | 单数模型名称带id后缀的蛇形命名 | article_id |
迁移 | 复数蛇形命名 | 2017_01_01_000000_create_articles_table |
视图 | 单数脊柱命名 | user-address.blade.php |
配置和语言文件索引 | 蛇形命名 | google_calendar.php |
测试类 | 单数驼峰命名 | testGuestCannotSeeArticle |
Interface | 形容词或名词后带Interface的大驼峰命名 | AuthenticationInterface |
Trait | 形容词 | Notifiable |
常量 | 大写蛇形命名 | PHP_OS |
方法 | 小驼峰命名 | getAll |
参照链接:
大驼峰,小驼峰,蛇形,脊柱等命名形式和结构自行百度或者google
本作品采用《CC 协议》,转载必须注明作者和本文链接
关于变量:PSR规范中没有特别约定,Laravel最佳实践约定:变量是小驼峰,URL参数是单数蛇形,模型字段是单数蛇形,集合是复数小驼峰,对象是单数小驼峰;那么在项目中是统一采用单复数形式的小驼峰呢,还是把接受URL参数和数据库字段的变量定义为单数蛇形,把对象定义为单数小驼峰,集合定义为复数小驼峰,这样在定义变量时又陷入了复杂……
2 3 不认同,后面没怎么看
第一个就不赞同,例如:
User
控制器,他不是一个人的控制器,应该使用复数UsersController