原文地址：《20 Laravel Eloquent Tips and Tricks》

永久地址： http://blog.kbiao.me/2019/01/03/20-Laravel-Eloquent-Tips-and-Tricks/

译者：KBiao

在其表面简单易用的机制背后，还有很多半隐藏的功能或者少有人知的方法来实现一些很有用的需求。在本文中，我将向您展示一些技巧。

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. XorY 方法

Eloquent有很多方法是两个方法的组合，实现 “请做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字段。

4. 带条件以及排序的关联关系模型

通常定义关系模型的方法是这样的

public function users() {
    return $this->hasMany('App\User');    
}

但你是否知道在定义关系模型的时候就已经可以增加 where 或者 orderBy 的条件了？比如说你需要定义一个特定类型的用户的关联关系并且用邮箱信息来排序，那你可以这么做：

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

5. 模型属性: 时间戳, 附加属性（appends）等

Eloquent模型有一些“参数”，会以该类的属性形式出现。最常用的可能是这些：

class User extends Model {
    protected $table = 'users';
    protected $fillable = ['email', 'password']; // 这些字段可以在模型的 create 方法中直接创建
    protected $dates = ['created_at', 'deleted_at']; // 这些字段将会转换成 Carbon类型的，可以方便的使用 Carbon 提供的时间方法
    protected $appends = ['field1', 'field2']; // 序列化时候附加的额外属性，通过模型中定义 getXXXAttribute 的方式来定义
}

可不仅仅有这些，还有：

protected $primaryKey = 'uuid'; // 模型的主键名称可以不是默认的 id
public $incrementing = false; // 甚至可以不必是自增的类型!
protected $perPage = 25; // 是的，你还定义模型集合分页参数(默认是 15)
const CREATED_AT = 'created_at';
const UPDATED_AT = 'updated_at'; // 默认的时间戳字段也是可以改变的
public $timestamps = false; // 或者完全不用他

甚至还有更多，我仅仅列出了最有意思的一部分，更多请查看默认抽象Model类的代码，并查看所有使用的trait 方法。

6. 查询多个实体对象

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. BelongsTo 关联的默认模型对象

假设有个 Post（帖子）对象属于 Author （作者）对象，在 Blade 模板中有下面的代码

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

但是如果作者被删除，或者由于某种原因没有设置呢？那么就会导致报错，可能是“property of non-object（非对象属性）”。

当然你可以用下面的代码来必变这种错误：

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

不过你可以再模型定义时候就解决这个问题：

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. 自定义属性排序

假设你有下面的一段代码：

（设定了一个在返回对象时候的附加属性 ‘full_name’参见 tips5 模型属性: 时间戳, 附加属性（appends）等）

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。

（一个是 SQL 语句，自定义属性是数据库没有的字段当然不能直接用。但是查询的返回都是一个 Collection 对象，Laravel 为集合提供了很多方便的操作方法，sortBy 就是其中一个，当然还可以用 filter 等集合操作）

12. 全局范围（global scope）内的默认排序

如果你希望User :: all（）始终按名称字段排序，该怎么办？你可以分配全局的查询作用域。让我们回到上面已经提到的boot（）方法。

protected static function boot()
{
    parent::boot();

    // 默认按照name 字段升序
    static::addGlobalScope('order', function (Builder $builder) {
        $builder->orderBy('name', 'asc');
    });
}

这里还有更多关于请求范围作用域的介绍。

13. 原生查询方法

有时我们需要在Eloquent语句中添加原生查询语句。幸运的是，它提供了这样的功能。

// 原生 where 语句
$orders = DB::table('orders')
    ->whereRaw('price > IF(state = "TX", ?, 100)', [200])
    ->get();

// 原生 having 语句
Product::groupBy('category_id')->havingRaw('COUNT(*) > 1')->get();

// 原生 orderBy 语句
User::where('created_at', '>', '2016-01-01')
  ->orderByRaw('(updated_at - created_at) desc')
  ->get();

（本质上Eloquent就是对 DB 查询对象的一个封装，所以可以用在 DB 上的原始查询方法，都可以用在继承自 Eloquent 的 model 对象上。）

14. 复制：得到一行数据的一个副本

很简单的一条，不需要太多解释。这是生成数据库条目副本的最佳手段。

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

15. 用于大表大集合的 Chunk（）方法

不完全与Eloquent相关，它更多是Collection 集合类提供的方法，但仍然很强大 —— 处理更大的数据集，你可以将它们分成几块。

不要这么做：

$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 将会创建模型的迁移（migration）文件
-c 将会创建控制器（contriller）
-r 将表用这个控制器应该是一个资源控制器（resourceful）

17. 在保存的时候重写 update_at 字段

你知道 - > save（）方法是可以接受参数的吗？因此，我们可以告诉它“忽略” updated_at默认填充当前时间戳的功能。看这个例子：

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

这里我们动态的重写的 update_at 字段，而不是预先在模型中定义。

Laravel 默认会给所有实体类配置时间戳，如果不需要一般是在模型中指定 $timestamps = false

18. update（）方法的返回值是什么？

你有没有曾想过下面这段代码返回的 result 是什么？

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

我的意思是，更新语句是在数据库中正确执行的，但 $ result 变量会包含什么？

答案是受影响的行。因此，如果您需要检查受影响的行数，则无需再调用任何其他方法 - update（）方法将为你返回这个数字。

19. 正确翻译 SQL 语句中的括号到 Eloquent 的查询

假设在你的 SQL 查询中包含了 and / or 这样的关键字，如下：

... 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]);