常用的 Laravel Eloquent 必備的實用技巧

? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?

常用的 Laravel Eloquent 必備的實用技巧

eloquent orm 看起來是一個簡單的機制,但是在底層,有很多半隱藏的函數和鮮為人知的方式來實現更多功能。在這篇文章中,我將演示幾個小技巧。

1. 遞增和遞減

要代替以下實現:

$article = Article::find($article_id); $article->read_count++; $article->save();

你可以這樣做:

$article = Article::find($article_id); $article->increment('read_count');

以下這些方法也可以實現:

Article::find($article_id)->increment('read_count'); Article::find($article_id)->increment('read_count', 10); // +10 Product::find($produce_id)->decrement('stock'); // -1

2. 先執行 X 方法,X 方法執行不成功則執行 Y 方法

Eloquent 有相當一部分函數可以把兩個方法結合在一起使用, 例如 『 請先執行 X 方法, ?X 方法執行不成功則執行 Y 方法 』。

實例 1?—?findOrFail():

要替代以下代碼的實現:

$user = User::find($id); if (!$user) { abort (404); }

你可以這樣寫:

$user = User::findOrFail($id);

實例 2?—?firstOrCreate():

要替代以下代碼的實現:

$user = User::where('email', $email)->first(); if (!$user) {   User::create([     'email' => $email   ]); }

這樣寫就可以了:

$user = User::firstOrCreate(['email' => $email]);

3. 模型的 boot() 方法

在一個 Eloquent 模型中,有個神奇的地方,叫?boot(),在那里,你可以覆蓋默認的行為:

class User extends Model {     public static function boot()     {         parent::boot();         static::updating(function($model)         {             // 寫點日志啥的             // 覆蓋一些屬性,類似這樣 $model->something = transform($something);         });     } }

在創建模型對象時設置某些字段的值,大概是最受歡迎的例子之一了。 一起來看看在創建模型對象時,你想要生成?UUID 字段?該怎么做。

public static function boot() {   parent::boot();   self::creating(function ($model) {     $model->uuid = (string)Uuid::generate();   }); }

4. 帶條件與排序的關聯關系

定義關聯關系的一般方式:

public function users() {     return $this->hasMany('AppUser'); }

你知道嗎?也可以在上面的基礎上增加?where?或者?orderBy?
舉個例子,如果你想關聯某些類型的用戶,同時使用 email 字段排序,你可以這樣做:

public function approvedUsers() {     return $this->hasMany('AppUser')->where('approved', 1)->orderBy('email'); }

5. 模型特性:時間、追加等

Eloquent模型有些參數,使用類的屬性形式。最常用是:

class User extends Model {     protected $table = 'users';     protected $fillable = ['email', 'password']; // 可以被批量賦值字段,如 User::create() 新增時,可使用字段     protected $dates = ['created_at', 'deleted_at']; // 需要被Carbon維護的字段名     protected $appends = ['field1', 'field2']; // json返回時,附加的字段 }

不只這些,還有:

protected $primaryKey = 'uuid'; // 更換主鍵 public $incrementing = false; // 設置 不自增長 protected $perPage = 25; // 定義分頁每頁顯示數量(默認15) const CREATED_AT = 'created_at'; const UPDATED_AT = 'updated_at'; //重寫 時間字段名 public $timestamps = false; // 設置不需要維護時間字段

還有更多,我只列出了一些有意思的特性,具體參考文檔?abstract Model class?了解所有特性.

6. 通過 ID 查詢多條記錄

所有人都知道 ?find() ?方法,對吧?

$user = User::find(1);

我十分意外竟然很少人知道這個方法可以接受多個 ID 的數組作為參數:

$users = User::find([1,2,3]);

7. WhereX

有一種優雅的方式能將這種代碼:

$users = User::where('approved', 1)->get();

轉換成這種:

$users = User::whereApproved(1)->get();

對,你沒有看錯,使用字段名作為后綴添加到 where 后面,它就能通過魔術方法運行了。

另外,在 Eloquent 里也有些和時間相關的預定義方法:

User::whereDate('created_at', date('Y-m-d')); User::whereDay('created_at', date('d')); User::whereMonth('created_at', date('m')); User::whereYear('created_at', date('Y'));

8. 通過關系排序

一個復雜一點的「技巧」。你想對論壇話題按最新發布的帖子來排序?論壇中最新更新的主題在最前面是很常見的需求,對吧?

首先,為主題的最新帖子定義一個單獨的關系:

public function latestPost() {     return $this->hasOne(AppPost::class)->latest(); }

然后,在控制器中,我們可以實現這個「魔法」:

$users = Topic::with('latestPost')->get()->sortByDesc('latestPost.created_at');

9. Eloquent::when() — 不再使用 if-else

很多人都喜歡使用”if-else”來寫查詢條件,像這樣:

if (request('filter_by') == 'likes') {     $query->where('likes', '>', request('likes_amount', 0)); } if (request('filter_by') == 'date') {     $query->orderBy('created_at', request('ordering_rule', 'desc')); }

有一種更好的方法 — 使用 when()

$query = Author::query(); $query->when(request('filter_by') == 'likes', function ($q) {     return $q->where('likes', '>', request('likes_amount', 0)); }); $query->when(request('filter_by') == 'date', function ($q) {     return $q->orderBy('created_at', request('ordering_rule', 'desc')); });

它可能看上去不是很優雅,但它強大的功能是傳遞參數:

$query = User::query(); $query->when(request('role', false), function ($q, $role) {     return $q->where('role_id', $role); }); $authors = $query->get();

10. 一對多返回默認模型對象

假設現在有種情況是要顯示文章的作者,然后模板代碼是:

{{ $post->author->name }}

但是如果作者的信息被刪除或者因為某些原因沒有被設置。代碼會返回一個錯誤,諸如 “property of non-object”。

當然你可以這樣處理:

{{ $post->author->name ?? '' }}

你可以通過 Eloquent 關系這樣做:

public function author() {     return $this->belongsTo('AppAuthor')->withDefault(); }

在此示例中,如果文字沒有作者的信息,?author()?會返回一個空的?AppAuthor 模型對象。

再者,我們也可以給默認的模型對象里面的屬性賦默認值。

public function author() {     return $this->belongsTo('AppAuthor')->withDefault([         'name' => 'Guest Author'     ]); }

11. 通過賦值函數進行排序

想象一下你有這樣的代碼:

function getFullNameAttribute() {   return $this->attributes['first_name'] . ' ' . $this->attributes['last_name']; }

現在,你想要通過 “full_name” 進行排序? 發現是沒有效果的:

$clients = Client::orderBy('full_name')->get(); //沒有效果

解決辦法很簡單.我們需要在獲取結果后對結果進行排序.

$clients = Client::get()->sortBy('full_name'); // 成功!

注意的是方法名稱是不相同的 — 它不是orderBy,而是sortBy

12. 全局作用域下的默認排序

如果你想要?User::all()?總是按照?name?字段來排序呢? 你可以給它分配一個全局作用域。讓我們回到?boot()?這個我們在上文提到過的方法:

protected static function boot() {     parent::boot();      // 按照 name 正序排序     static::addGlobalScope('order', function (Builder $builder) {         $builder->orderBy('name', 'asc');     }); }

擴展閱讀?查詢作用域 。

13. 原生查詢方法

有時候,我們需要在 Eloquent 語句中添加原生查詢。 幸運的是,確實有這樣的方法。

// whereRaw $orders = DB::table('orders')     ->whereRaw('price > IF(state = "TX", ?, 100)', [200])     ->get();  // havingRaw Product::groupBy('category_id')->havingRaw('COUNT(*) > 1')->get();  // orderByRaw User::where('created_at', '>', '2016-01-01')   ->orderByRaw('(updated_at - created_at) desc')   ->get();

14. 復制:復制一行的副本

很簡單。說明不是很深入,下面是復制數據庫實體(一條數據)的最佳方法:

$task = Tasks::find(1); $newTask = $task->replicate(); $newTask->save();

15. Chunk() 方法之大塊數據

與 Eloquent 不完全相關,它更多的關于 Collection (集合),但是對于處理大數據集合,仍然是很有用的。你可以使用 chunk() 將這些數據分割成小數據塊

修改前:

$users = User::all(); foreach ($users as $user) {     // ...

你可以這樣做:

User::chunk(100, function ($users) {     foreach ($users as $user) {         // ...     } });

16. 創建模型時創建額外的東西

我們都知道Artisan命令:

php artisan make:model Company

但是,你知道有三個有用的標記可以為模型生成相關文件嗎?

php artisan make:model Company -mcr
  • -m 將創建一個遷移文件

  • -c 將創建一個控制器

  • -r 表示控制器應該是一個資源控制器

17. 調用 save 方法的時候指定 updated_at

你知道? ->save() 方法可以接受參數嗎? 我們可以通過傳入參數阻止它的默認行為:更新 ?updated_at ?的值為當前時間戳。

$product = Product::find($id); $product->updated_at = '2019-01-01 10:00:00'; $product->save(['timestamps' => false]);

這樣,我們成功在 ?save ?時指定了 ?updated_at ?的值。

18. update() 的結果是什么?

你是否想知道這段代碼實際上返回什么?

$result = $products->whereNull('category_id')->update(['category_id' => 2]);

我是說,更新操作是在數據庫中執行的,但 $result 會包含什么?

答案是受影響的行。 因此如果你想檢查多少行受影響, 你不需要額外調用其他任何內容 —?update()?方法會給你返回此數字。

19. 把括號轉換成 Eloquent 查詢

如果你有個 and 和 or 混合的 SQL 查詢,像這樣子的:

... WHERE (gender = 'Male' and age >= 18) or (gender = 'Female' and age >= 65)

怎么用 Eloquent 來翻譯它呢? 下面是一種錯誤的方式:

$q->where('gender', 'Male'); $q->orWhere('age', '>=', 18); $q->where('gender', 'Female'); $q->orWhere('age', '>=', 65);

順序就沒對。正確的打開方式稍微復雜點,使用閉包作為子查詢:

$q->where(function ($query) {     $query->where('gender', 'Male')         ->where('age', '>=', 18); })->orWhere(function($query) {     $query->where('gender', 'Female')         ->where('age', '>=', 65); })

20. 復數參數的 orWhere

終于,你可以傳遞陣列參數給 orWhere()。平常的方式:

$q->where('a', 1); $q->orWhere('b', 2); $q->orWhere('c', 3);

你可以這樣做:

$q->where('a', 1); $q->orWhere(['b' => 2, 'c' => 3]);

我很確定還有更多隱藏的秘訣,但我希望至少上面的其中一些對你來說是新的。

推薦教程:《Laravel教程

? 版權聲明
THE END
喜歡就支持一下吧
點贊5 分享