20 個 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('App\User');
}

你知道嗎？也能夠在上面的基礎上增長 where 或者 orderBy?\
舉個例子，若是你想關聯某些類型的用戶，同時使用 email 字段排序，你能夠這樣作：

public function approvedUsers() {
    return $this->hasMany('App\User')->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(\App\Post::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('App\Author')->withDefault();
}

在此示例中，若是文字沒有做者的信息， author() 會返回一個空的 App\Author 模型對象。

再者，咱們也能夠給默認的模型對象裏面的屬性賦默認值。

public function author()
{
    return $this->belongsTo('App\Author')->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]);

• • • • *

我很肯定還有更多隱藏的祕訣，但我但願至少上面的其中一些對你來講是新的。

更多現代化 PHP 知識，請前往 Laravel / PHP 知識社區