php larval开发规范,数据模型 |《 Laravel 项目开发规范 5.5》| Laravel China 社区
本文檔最新版為 7.x，舊版本可能放棄維護(hù)，推薦閱讀最新版！
放置位置
所有的數(shù)據(jù)模型文件，都 必須 存放在：app/Models/ 文件夾中。
命名空間：
namespace App\Models;
User.php
Laravel 5.1 默認(rèn)安裝會(huì)把 User 模型存放在 app/User.php，必須 移動(dòng)到 app/Models 文件夾中，并修改命名空間聲明為 App/Models，同上。
為了不破壞原有的邏輯點(diǎn)，必須 全局搜索 App/User 并替換為 App/Models/User。
使用基類
所有的 Eloquent 數(shù)據(jù)模型 都 必須 繼承統(tǒng)一的基類 App/Models/Model，此基類存放位置為 /app/Models/Model.php，內(nèi)容參考以下：
namespace App\Models;
use Illuminate\Database\Eloquent\Model as EloquentModel;
class Model extends EloquentModel
{
public function scopeRecent($query)
{
return $query->orderBy('created_at', 'desc');
}
}
以 Photo 數(shù)據(jù)模型作為例子繼承 Model 基類：
namespace App\Models;
class Photo extends Model
{
protected $fillable = ['id', 'user_id'];
public function user()
{
return $this->belongsTo(User::class);
}
}
命名規(guī)范
數(shù)據(jù)模型相關(guān)的命名規(guī)范：
數(shù)據(jù)模型類名 必須 為「單數(shù)」, 如：App\Models\Photo
類文件名 必須 為「單數(shù)」，如：app/Models/Photo.php
數(shù)據(jù)庫表名字 必須 為「復(fù)數(shù)」，多個(gè)單詞情況下使用「Snake Case」 如：photos, my_photos
數(shù)據(jù)庫表遷移名字 必須 為「復(fù)數(shù)」，如：2014_08_08_234417_create_photos_table.php
數(shù)據(jù)填充文件名 必須 為「復(fù)數(shù)」，如：PhotosTableSeeder.php
數(shù)據(jù)庫字段名 必須 為「Snake Case」，如：view_count, is_vip
數(shù)據(jù)庫表主鍵 必須 為「id」
數(shù)據(jù)庫表外鍵 必須 為「resource_id」，如：user_id, post_id
數(shù)據(jù)模型變量 必須 為「resource_id」，如：$user_id, $post_id
利用 Trait 來擴(kuò)展數(shù)據(jù)模型
有時(shí)候數(shù)據(jù)模型里的代碼會(huì)變得很臃腫，應(yīng)該 利用 Trait 來精簡邏輯代碼量，提高可讀性，類似于 Ruby China 源碼。
借鑒于 Rails 的設(shè)計(jì)理念：「Fat Models, Skinny Controllers」。
存放于文件夾：app/Models/Traits 文件夾中。
Repository
絕不 使用 Repository，因?yàn)槲覀儾皇窃趯?JAVA 代碼，太多封裝就成了「過度設(shè)計(jì)(Over Designed)」，極大降低了編碼愉悅感，使用 MVC 夠傻夠簡單。
代碼的可讀性，維護(hù)和開發(fā)的便捷性，直接關(guān)系到程序員開發(fā)時(shí)的愉悅感，直接影響到項(xiàng)目推進(jìn)效率和程序 Debug 的速度。
關(guān)于 SQL 文件
絕不 使用命令行或者 PHPMyAdmin 直接創(chuàng)建索引或表。必須 使用 數(shù)據(jù)庫遷移 去創(chuàng)建表結(jié)構(gòu)，并提交版本控制器中；
絕不 為了共享對數(shù)據(jù)庫更改就直接導(dǎo)出 SQL，所有修改都 必須 使用 數(shù)據(jù)庫遷移 ，并提交版本控制器中；
絕不 直接向數(shù)據(jù)庫手動(dòng)寫入偽造的測試數(shù)據(jù)。必須 使用 數(shù)據(jù)填充 來插入假數(shù)據(jù)，并提交版本控制器中。
全局作用域
Laravel 的 Model 全局作用域 允許我們?yōu)榻o定模型的所有查詢添加默認(rèn)的條件約束。
所有的全局作用域都 必須 統(tǒng)一使用 閉包定義全局作用域，如下：
/**
* 數(shù)據(jù)模型的啟動(dòng)方法
*
* @return void
*/
protected static function boot()
{
parent::boot();
static::addGlobalScope('age', function(Builder $builder) {
$builder->where('age', '>', 200);
});
}
總結(jié)
以上是生活随笔為你收集整理的php larval开发规范,数据模型 |《 Laravel 项目开发规范 5.5》| Laravel China 社区的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 小白鼠喝毒水问题（一分为二的思想）
- 下一篇： php7安装详解_,PHP7 redis