我们平时可能在应用中创建了大量的模型。这些模型的代码量总是随着大量的访问器 / 修改器、增加的 Scope
、甚至各种关联关系而扩大。例如:
// Models/Article.php
class Article extends Model
{
/**
* 状态
* @return \Illuminate\Database\Eloquent\Builder
*/
public function scopeStatus($query, $status)
{
return $query->where('status', $status);
}
/**
* 关联用户
*/
public function user()
{
return $this->belongsTo(User::class);
}
//......
//甚至访问器 / 修改器
}
// usage of the scope
Article::status($status)->get();
正如您可能想象的那样,这些方法会在一段时间后导致模型臃肿,您可以通过以下方法使模型变得更简洁。
一、扩展 Eloquent Builder
1、编写自己的 Eloquent Builder
可以创建您自己的 Eloquent Builder 并将其绑定到您的模型。这可以通过创建一个扩展 Eloquent Builder 的类来完成。首先让我们从创建一个 ArticleBuilder 开始。将它放在哪里并不重要,但我倾向于在 App 命名空间中为它创建一个目录 App\EloquentBuilders
。
<?php
declare(strict_types=1);
namespace App\EloquentBuilders;
use Illuminate\Database\Eloquent\Builder;
class ArticleBuilder extends Builder
{
public function published(): self{
return $this->whereNotNull('published_at');
}
}
如您所见,它使用与以前相同的方法,因为作用域在后台使用查询构建器!
2、注册全新的 Eloquent Builder
现在剩下的就是将我们的自定义查询构建器绑定到模型中。通过覆盖 newEloquentBuilder
方法来完成。覆盖它后,您可以删除任何旧 Scope
。您的最终结果将如下所示:
<?php
declare(strict_types=1);
namespace App\Models;
use App\EloquentBuilders\ArticleBuilder;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
class Article extends Model
{
use HasFactory;
public function newEloquentBuilder($query): Builder{
return new ArticleBuilder($query);
}
}
// usage of the scope
Article::published()->get();
二、在Eloquent 模型中使用 Trait (推荐)
例如:常见的订单模型为例,可以这样定义目录结构:
├── Order/
├── Traits/
├── Relationship/ //定义关联关系
├── OrderRelationship.php
├── Scope/ //定义Scope
├── OrderScope.php
├── Order.php //定义模型
订单模型 Order.php:
<?php
namespace App\Models\Order;
use Illuminate\Database\Eloquent\Model;
use App\Models\Order\Traits\Relationship\OrderRelationship;
use App\Models\Order\Traits\Scope\OrderScope;
class Order extends Model
{
use OrderRelationship,
OrderScope,
//......
}
// usage of the scope
Order::status($status)->get();
根据需要定义关联关系 Traits\Relationship\OrderRelationship.php
:
<?php
namespace App\Models\Order\Traits\Relationship;
use App\Models\User\User;
trait OrderRelationship
{
/**
* 用户
*/
public function user()
{
return $this->belongsTo(User::class);
}
//......
}
根据需要定义 Scope Traits\Scope\OrderScope.php
:
<?php
namespace App\Models\Order\Traits\Scope;
trait OrderScope
{
/**
* 订单状态
* @return \Illuminate\Database\Eloquent\Builder
*/
public function scopeStatus($query, $status)
{
return $query->where('status', $status);
}
//......
}
最后,功能方面没有任何改变,但您的模型变得更加简洁。
如果有好用的处理方法,请在评论中说出你的想法。