mafeifan 的编程技术分享

Eloquent ORM 看起来像一个简单的机制，但在幕后，有很多半隐藏的功能和不太知名的方法来实现更多。在本文中，我将向您展示一些技巧。

# 1. Increments and Decrements

文章阅读量增加 1：

$article = Article::find($articleid);
$article->readcount++;
$article->save();

1
2
3

你可以这样做：

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

1
2

也可以这些做：

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

1
2
3

# 2. XorY methods

Eloquent有很多功能，结合了两种方法，比如“请做X，否则做Y”。

findOrFail() :

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

等价于：

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

1
2
3
4

firstOrCreate() :

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

等价于：

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

1
2
3
4

# 3. 模型 boot() 方法

在Eloquent模型中有一个名为boot（）的方法，您可以在其中覆盖默认行为：

 class User extends Model
 {
     public static function boot()
     {
         parent::boot();
         static::updating(function ($model) 
         {
             // do some logging
         });
     }
 }

1
2
3
4
5
6
7
8
9
10
11

可能最常见的例子之一是在创建模型对象时设置一些字段值。假设你想在那一刻生成UUID字段。

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

1
2
3
4
5
6
7
8

# 4. Relationship with conditions and ordering

这是定义关系的典型方法：

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

1
2
3
4

但是你知道吗，此时我们已经可以添加where或orderBy了！例如，如果您想要某种类型的用户（也是通过电子邮件订购）的特定关系，您可以这样做：

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

1
2
3
4

# 5. 模型属性：timestamps, appends等。

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

(opens new window)

更多请查看默认abstract Model class (opens new window)的代码，并查看所有使用的特征。

# 6. find()

大家都知道**find()**方法可以这样用：

$user = User::find(1);

其实**find()**还可以传递一个数组作为参数：

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

# 7. whereX

有一种优雅的方式可以解决这个问题：

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

等价于：

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

# 8. Order by relationship

一个更复杂的“技巧”。如果您有论坛主题但想通过最新帖子订购，该怎么办？顶部有最新更新主题的论坛中非常常见的要求，对吧？

首先，描述关于该主题的最新帖子的单独关系：

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

1
2
3
4

然后，在我们的控制器中，我们可以这样做：

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

# 9. Eloquent::when() – no more if-else’s

我们中的许多人用 “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'));
}

1
2
3
4
5
6
7

但有更好的方法 - 使用 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'));
});

1
2
3
4
5
6
7
8
9

它可能不会感觉更短或更优雅，但最强大的是传递参数：

$query = User::query();

$query->when(request('role', false), function ($q) use ($role) { 
    return $q->where('role_id', $role);
});

$authors = $query->get();

1
2
3
4
5
6
7

# 10. BelongsTo Default Models

假设你有Post属于Author，然后是Blade代码：

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

但是如果作者被删除，或者由于某种原因没有设置呢？您将收到错误，例如“property of non-object”。当然，您可以像这样阻止它：

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

但你可以在Eloquent关系层面上做到这一点：

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

1
2
3
4

在此示例中，如果没有作者附加到帖子，则 author（）关系将返回空的 App \ Author 模型。此外，我们可以将默认属性值分配给该默认模型。

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

1
2
3
4
5
6

# 11. 赋值函数排序

假设有这么一段代码：

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

1
2
3
4

如果你想按照 full_name 进行排序，下面这句代码将不起作用:

    $clients = Client::orderBy('full_name')->get();   // doesn't work

解决办法很简单，我们只需要在获取集合之后利用 sortBy 对集合进行排序即可：

    $clients = Client::get()->sortBy('full_name');   // works

# 12. 全局范围内默认排序

如果你希望所有用户总是按照 name 字段排序，你可以在全局范围内做一个声明，让我们回到上面已经提到的boot（）方法。

    protected static function boot()
    {
        parent::boot();
        // order by name ASC
        static::addGlobalScope('order', function (Builder $builder) {
            $builder->orderBy('name', 'asc);
        });
    }

1
2
3
4
5
6
7
8

# 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', '>', '2018-11-11')
        ->orderByRaw('(updated_at - created_at) desc')
        ->get();

1
2
3
4
5
6
7
8
9
10

# 14. Replicate: 制作一行的副本

快速复制数据的最佳方法:

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

1
2
3

复制并修改其中的一部分数据:

$article = Article::find(1)->replicate();
$article->title = 'Laravel 复制数据并修改标题';
$article->save();
dd(Article::all()->toArray());

1
2
3
4

复制模型及关系:

$article = Article::with('tags')->find(1);
$clone = $article->replicate();
// 复制关系
$clone->push();

foreach($article->tags as $tag)
{
    $clone->tags()->attach($tag);
}

1
2
3
4
5
6
7
8
9

# 15. chunk() 方法批量处理大数据量

不完全与Eloquent相关，它更多关于Collection，但仍然很强大 - 处理更大的数据集，你可以将它们分成几块。一般情况下数据量不太大的情况下会像下面这样遍历

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

1
2
3
4

数据太大就能显示 chunk() 的神威了

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

1
2
3
4
5

# 16. 命令行创建模型的同时，创建迁移文件和控制器

laravel创建模型的命令大家都很熟悉：

php artisan make:model Company

不过你应该了解另外几个很常用的参数：

php artisan make:model Company -m

php artisan make:model Company -mc

php artisan make:model Company -mcr

php artisan make:model Company -mcrf

-m 表示创建模型对应的迁移文件 -c 表示创建模型对应的控制器 -r 表示创建的控制器属于资源控制器 -f 表示创建模型对应的工厂文件

实际上上述几个情况，也可以通过 -a 来实现

php artisan make:model Company -a

# 17. 保存数据的同时覆盖 updated_at 的默认更新时间

其实 ->save() 方法是可以接受额外参数的，因此，我们可以告诉它“忽略”updated_at默认功能以填充当前时间戳。

$product = Product::find(1);
$product->updated_at = '2018-11-11 11:11:11';
$product->save(['timestamps' => false]);

1
2
3

可以看到，我们用我们预先定义的版本覆盖默认的updated_at。

# 18. update() 方法的执行结果

你有没有想过这段代码究竟返回了什么？

$result = $product->whereNull('category_id')->update(['category_id' => 1]);

更新是在数据库中执行的，但$ result会包含什么？答案是受影响的行。因此，如果您需要检查受影响的行数，则无需再调用任何其他内容 - update（）方法将为您返回此数字。

# 19. 将and 或者 or转换为Eloquent查询

在你的查询中肯定会遇到 and 或者 or 的情况，就像这样：

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

那么怎么转换成Eloquent查询呢？先来看一个错误的例子：

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

1
2
3
4

正确的方法有点复杂，使用闭包函数作为子查询：

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

1
2
3
4
5

# 20. orWhere() 有多个参数的情况

通常情况下遇到这种查询：

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

1
2
3

这种情况下可以传递一个数组作为 orWhere() 的参数：

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

1
2

# 21. 重新加载新模型

使用 fresh() 从数据库加载一个全新的模型实例。

$user = App\User::first();
$user->name;               // John
// 用户记录通过另一个线程更新了。 例如： 'name' 改成了 // Peter。
$updatedUser = $user->fresh(); 
$updatedUser->name;       // Peter
$user->name;              // John

1
2
3
4
5
6

# 22. 重新加载现有模型

你可以使用 refresh() 从数据库中的新值来重新加载现有模型。

$user = App\User::first();
$user->name;               // John
// 用户记录通过另一个线程更新了。 例如： 'name' 改成了 // Peter。
$user->refresh(); 
$user->name;              // Peter

1
2
3
4
5

# 23. 保存模型及其关系数据

$employee = Employee::first();
$employee->name = 'New Name';
$employee->address->city = 'New York';
$employee->push();

1
2
3
4

save 只会保存 employee 表中的 name 字段，而不保存 address 表中的 city 字段。push 方法将保存两者。

# 参考

https://learnku.com/articles/19876#1face4

https://learnku.com/laravel/t/65470

← 模型常用属性关联查询指定表的字段 →

# 1. Increments and Decrements

# 2. XorY methods

# 3. 模型 boot() 方法

# 4. Relationship with conditions and ordering

# 5. 模型属性：timestamps, appends等。

# 6. find()

# 7. whereX

# 8. Order by relationship

# 9. Eloquent::when() – no more if-else’s

# 10. BelongsTo Default Models

# 11. 赋值函数排序

# 12. 全局范围内默认排序

# 13. 原始查询方法

# 14. Replicate: 制作一行的副本

# 15. chunk() 方法批量处理大数据量

# 16. 命令行创建模型的同时，创建迁移文件和控制器

# 17. 保存数据的同时 覆盖 updated_at 的默认更新时间

# 18. update() 方法的执行结果

# 19. 将and 或者 or转换为Eloquent查询

# 20. orWhere() 有多个参数的情况

# 21. 重新加载新模型

# 22. 重新加载现有模型

# 23. 保存模型及其关系数据

# 参考

# 17. 保存数据的同时覆盖 updated_at 的默认更新时间