Laravel 模型过滤（Filter）设计

抽象类不能直接通过new去实例化一个对象，要获取抽象类的对象，需要先用一个类继承抽象类，然后去实例化子类。

在我们日常代码开发中，可能最常见的功能就是列表筛选了。通过不同的参数，返回符合条件的内容。下面我分享一下自己的过滤代码设计（其实是从 Laracasts 上学来的？）。

基本实现

假设我们有一个图书的列表，想要进行筛选：

标题含有 "我们" 的
定价大于 30 元的
出版社是 "大地出版社" 的
按照 ID 进行倒序排列

针对这几个条件我们可以很快的写出下面的代码


public function index()
{
    return Book::query()
        ->where('title', 'like', '%我们%')
        ->where('price', '>=', 30)
        ->where('publisher', '大地出版社')
        ->orderBy('id', 'DESC')
        ->get();
}

优化

虽然我们实现了需求，但是如果我们增加或者减少筛选条件呢，以及在请求参数存在的时候才进行过滤呢？我们将不断的在上面的代码中更改，当条件过多的时候，我们的代码将会变成一团乱麻。

下面是我的优化方法。

BaseFilter

首先我们需要一个基础的 QueryFilter，然后我们所有的 Filter 都继承这个类。

abstract class QueryFilter
{

    protected $request;
    protected $builder;

    public function __construct(Request $request)                                                                        
    {                                                                                                                    
        $this->request = $request;                                                                                       
    }                                                                                                                    

    public function apply(Builder $builder)                                                                              
    {                                                                                                                    
        $this->builder = $builder;                                                                                       

        foreach ($this->filters() as $name => $value) {                                                                  
            if (method_exists($this, $name)) {                                                                           
                call_user_func_array([$this, $name], array_filter([$value]));                                            
        }                                                                                                            
     }                                                                                                                

        return $this->builder;                                                                                           
    }                                                                                                                    

    public function filters()
    {
        return $this->request->all();
    }
}

这个类的代码很简单，主要功能集中在 apply 函数中，我们检查每个请求参数，如果这个方法存在，那么调用对应的方法。下面结合具体的实例进行解释

BookFilter

我们的 BookFilter 代码如下：

class BookFilter extends QueryFilter
{
    public function title($title)
    {
        return $this->builder->where('title', 'like', "%{$title}%");
    }

    public function price($price)
    {
        return $this->builder->where('price', '>=', "%{$price}%");
    }

    public function publisher($publisher)
    {
        return $this->builder->where('publisher', $publisher);
    }
}

在上面的代码中，我们可以通过 URL 的参数来进行动态查询。

books?title=我们    //  查找标题含有我们的图书

books?title=我们&price=25   //  查找标题含有我们并且价格大于25元的图书

这种结构的代码将会很灵活的控制我们的过滤列表，并且我们的代码也很整洁。

完结

当然，如果我们只进行到这一步是没法进行查询的，因为我们还没有地方调用 QueryFilter 中的 apply 方法。有一个绝佳的地方可以进行调用，那就是模型中的 scope 。

注意：scopeFilter($query, QueryFilter $filters) 传参是抽象类，并使用该类调用了方法，所以实际使用时要传递实例化的继承类。

class Book extends Model
{
    public function scopeFilter($query, QueryFilter $filters)
    {
        return $filters->apply($query);
    }
}

最后，我们原来控制器的方法将改为下面的样子：

public function index(BookFilter $filters)
{
    return Book::filter($filters)->get();
}

这样我们就完成了一个比较灵活的筛选列表了。

// 假设 book 关联了author
// 这里是 Book.php
public function author()
{
    return $this->belongsTo(Author::class);
}

// 那么Filter 中的方法可以这样写
// 这里是 BookFilter.php
public function author($name)
{
    return $builder->whereHas('author' function($query) use($name) {
        return $query->where('name', 'like', "%{$name}%");
    });
}