常用的 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]);

我很确定还有更多隐藏的秘诀，但我希望至少上面的其中一些对你来说是新的。

推荐教程：《Laravel教程》

以上是常用的 Laravel Eloquent 必備的實用技巧的詳細內容。更多資訊請關注PHP中文網其他相關文章！