屎山警告！Pipeline竟优雅的处理了Laravel多条件查询

原标题：Laravel Eloquent Query Filter using Pipeline
原文链接：hafiqiqmal93.medium.com/laravel-el...

pipeline是Laravel 特别有用的特性之一。 pipeline也是 Laravel 中最常用的组件之一，例如中间件。

One of the features of Laravel which surely useful is the pipeline. Pipelines is one of the most used components in the Laravel for example middleware.

基本上，通过管道，我们可以通过任务堆栈传递对象，并通过回调获得结果。

Basically, with a pipeline we can pass an object through a stack of tasks and get the result via a callback.

管道用于查询过滤的好处是我们可以将成吨的屎山减少到几行。 没用管道之前，我们通常会写一个控制器，获取用户模型的 Eloquent 实例，并根据查询字符串拼接一些条件。

The benefit of pipeline for query filtering is that we can reduce tons of lines to several lines. Being unaware of the pipelines, we would usually set up a controller, get an instance of Eloquent of User model, and apply some condition based on query string.

让我们看看下面的屎山查询大法。

Let’s see below queries.

$query = User::query();
if ($request->username) {
    $query->where('username', 'LIKE', "%$request->username%");
}
if ($request->email) {
    $query->where('email', 'LIKE', "%$request->email%");
}
if ($request->address) {
    $query->where('address', 'LIKE', "%$request->address%");
}
if ($request->occupation) {
    $query->where('occupation', 'LIKE', "%$request->occupation%");
}
return $query->get();

缺点很明显，过滤条件像屎山一样不断的堆加，出现大量重复的代码。 另外，代码的可维护性就有点脑壳疼了。

The drawback is that, it’s obviously that filters conditions will continue to grow as well as duplication of the same filter for other query. In other hand, the maintainability of the code kind of headache.

来看看管道优雅的处理方式
There is where Pipeline become a hero 😎

return User::query()->filter([ 
    UsernameFilter::class,
    EmailFilter::class,
    AddressFilter::class,
    OccupationFilter::class
])->get();

简单而简短吧？看看下面的步骤

Simple and short right? But before that,

1. 创建一个名为“Filterable”的trait类并写一个scope方法

1. Create a trait named Filterable and create a scope

class Filterable
{ 
       public function scopeFilter($query, array $through)
       {        
            return app(Pipeline::class)
                   ->send($query)            
                   ->through($through)            
                   ->thenReturn();    
       }
}

然后，你就可以愉快的在任意Model中复用它，如User模型

Then, use it in any model that you prefer, for example User model

class User 
{
    use Filterable; 
}

2.创建一个Filter，例如UsernameFilter

2. Create a filter for example UsernameFilter

class UsernameFilter 
{
    public function handle($query, $next)
    {        
        if (request()->mobile_phone) {           
           $query->where('username', request()->mobile_phone);      
        }         
        return $next($query);  
    }
}

食用方法：

The usage is just like this

User::query()->filter([UsernameFilter::class])->get();

或者

OR

你还可以通过传递属性的方式来使用管道。

If you want for more accessibility to the pipeline, you can also pass an attribute.

class StringFilter 
{
    public function handle($query, $next, $column) {
        if (request()->{$column}) {           
            $query->where($column, 'LIKE', request()->{$column});      
        } 
        return $next($query); 
    }
}

像下面这样用

The usage is just like this

User::query()->filter([
   'StringFilter:username',
   'StringFilter:email',
])->get();

搞定，优雅吧！😎

Done. Simple and clean 😎

For your references:
hafiqiqmal93.medium.com/laravel-el...
www.hackdoor.io/articles/discoveri...
gist.github.com/afiqiqmal/ef19a4ea...