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