3分钟短文：Laravel模型作用域，为你“节省”更多代码

引言

原则上代码写一次，处处是引用，不需要大量的冗余代码，这是一种趋势，也是提高代码健壮性的努力方向。

laravel模型为我们提供了一层数据库操作层，将数据交互独立出来。

但是久而久之，随着项目的需求不断扩大，最常用的查询操作，同样会有大量的冗余代码。

img

本文就来讲讲，连模型的自我瘦身，缩减模型的代码。

全局作用域

假设有些数据库查询操作，无论是在控制器内，或者在模板文件内，或者命令行方法内，都有重复的使用需求，要是在模型内有一个公用的方法，默认就加上这些筛选条件，就可以显著减少代码量了。

比如有一个查询条件：

$publishedEvents = Event::where('published', '=', 1)->get();

上述代码最后生成的SQL语句如下：

SELECT * FROM events WHERE `published` = 1;

如果条件 published = 1 在默认的情况下需要开启，我们可以使用laravel模型的 全局作用域 方式为所有查询追加上这个条件。

在模型文件 Event 内头部引入下述类：

use IlluminateDatabaseEloquentModel;
use IlluminateDatabaseEloquentBuilder;

在模型类内部，手动实现 boot 方法：

protected static function boot()
{
    parent::boot();
    static::addGlobalScope('published', function (Builder $builder) {
    	$builder->where('published', '=', 1);
    });
}

这样SQL语句 where published = 1 就会追加到所有的模型查询方法内，只要是创建生成了 QueryBuilder 对象的，都会附加上此约束语句。

那有些读者可能要问了：“如果我不想要这个约束语句，岂不是连模型也永不了了？”

那哪儿能呢！不过就是QueryBuilder的一个属性数组的一个元素而已，手动移除就行了，这样特例问题就解决了。

$events = Event::withoutGlobalScopes()->get();

看到了吧，追加上很简单，移除更简单。

本地作用域

接上一节的 withoutGlobalScope 要每次手动屏蔽的方式不同，有时候使用有局限的作用域更能解决问题。所以，本地作用域 应运而生，专门用于某个模型文件的方法，手动调用的时候就起作用，不调用就不会主动追加。

而声明一个本地作用域，只要遵循laravel的语法规定即可，如下示例：

public function scopePublished($query)
{
	return $query->where('published', 1);
}

只需要声明一个以 scope 为首的小驼峰命名的函数方法即可，并返回一个 QueryBuilder 对象实例。调用的时候要手动追加上：

$events = Event::published()->get();

其中 published()方法就是映射到 scopePublished 方法。

上面的演示代码，没有接收用户输入，下面演示一下带参的传递方式。比如有这样一个查询需求：

$events = Event::where('zip', $zipCode)->get();

使用本地作用域实现出来：

public function scopeZip($query, $zip)
{
	return $query->where('zip', $zip);
}

按照位置传入即可。使用的使用，直接传入：

$zip = '43016';
$events = Event::zip($zip)->get();

这样就完成了本地作用域的使用，是不是很直观。

既然本地作用域返回的是 QueryBuilder 实例，那么自然就可以链式调用本地作用域的方法，和 QueryBuilder 的方法。我们再声明一个本地作用域方法：

public function scopeAttendees($query, $maximum)
{
	return $query->where('max_attendees', $maximum);
}

现在把上述两个方法串联使用：

$events = Event::zip(43016)->attendees(2)->get();

生成的SQL语句也符合预期：

SELECT * FROM events WHERE zip = '43016' and max_attendees = '2';

写在最后

本期我们又旧事重提，把laravel模型的作用域设计方法拿出来温习了一下。讲述了两个方法：

全局作用域：全局起作用，需要手动移除；
本地作用域：只有手动调用起作用，可链式使用；

这样的设计模式可以很大程度上节约查询代码，但是对于维护，需要同等熟悉的开发者彼此遵循开发规范，写出可维护的代码。

Happy coding :-)