『恳请大神赐教』借鉴于 Rails 设计理念「Fat Models, Skinny Controllers」肥 Model 瘦 Controllers 的原则,对搜索部分的代码优化,不知道对不对,欢迎大神指正

写在前面

因为之前多个搜索条件都是拼接在控制器中的,所以感觉很是繁杂,再阅读了『Laravel 项目开发规范』之后,感觉之前的分层设计有点『Over Designed』过度设计,想要优化之前的代码,于是先去除分层,然后再从代码上去做优化,在经过多次实现之后,得出了这样一个『Trait』,自己钻研,也不知道对不对,发出来让诸位大神指导一二。
希望各位大神不吝赐教,发表个人见解。

先说优点

  1. 控制器精简
  2. 控制器更专注于调用Model提供的方法(或服务),而无需编写重复where、like、in、between查询。
  3. 对于Model只需要在创建之初,设置可以where、like、in、between查询的属性即可,使用filter自动完成搜索

再谈缺点

  1. 在Model中使用Request是否符合规范,不得而知。

我的代码

Model(可以将其封装为Trait,不过笔者先实验出来,还没来得及封装Trait)

<?php

namespace App\Models;

use App\Models\Traits\ScopeTrait;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;
use Request;

class Question extends Model
{
    use SoftDeletes;
    use ScopeTrait;
    /**
     * 受保护的字段
     *
     * @var array
     */
    protected $guarded = ['id'];
    /**
     * 需要被转换成日期的属性。
     *
     * @var array
     */
    protected $dates = ['deleted_at'];
    /**
     * @var array 可where参数
     */
    public $searchable = ['id', 'star', 'type'];
    /**
     * @var array 可whereBetween参数
     */
    public $betweenSearchable = ['created_at', 'updated_at', 'deleted_at'];
    /**
     * @var array 可like参数
     */
    public $likeSearchable = ['title'];
    /**
     * @var array 可whereIn参数
     */
    public $inSearchable = [];

    /**
     * 与选项的关系
     */
    public function options()
    {
        return $this->hasMany(QuestionOption::class, 'question_id', 'id');
    }

    /**
     * 与标签的关系
     */
    public function labels()
    {
        return $this->belongsToMany(Label::class, 'question_labels');
    }

    /**
     * 问题 与 所有人的关系
     */
    public function possessors()
    {
        return $this->hasMany(QuestionPossessor::class, 'question_id', 'id');
    }

    /**
     * 搜索参数限制
     */
    public function setSearch()
    {
        $query = Request::input();
        return collect($query)->filter(function ($val, $key) {
            return in_array($key, $this->searchable) && ($val || (int)$val === 0);
        })->toArray();
    }

    /**
     * 搜索参数限制
     */
    public function setBetween()
    {
        $query = Request::input();

        return collect($query)->filter(function ($val, $key) {
            return in_array($key, $this->betweenSearchable) && is_array($val) && count($val) === 2;
        })->toArray();
    }

    /**
     * 搜索参数限制
     */
    public function setLike()
    {
        $query = Request::input();

        return collect($query)->filter(function ($val, $key) {
            return in_array($key, $this->likeSearchable) && is_string($val) && $val;
        })->toArray();
    }

    /**
     * 搜索参数限制
     */
    public function setWhereIn()
    {
        $query = Request::input();

        return collect($query)->filter(function ($val, $key) {
            return in_array($key, $this->inSearchable) && is_array($val) && count($val) >= 1;
        })->toArray();
    }

    /**
     * 过滤
     *
     * @param $query
     * @param array $excepts 用于控制查询条件,比如:['where', 'like', 'in', 'between'],去除在数组中所有查询
     * @return $this
     */
    public function scopeFilter($query, $excepts = [])
    {
        // 控制查询
        $search = !isset($excepts['where']) ? $this->setSearch() : false;
        $like = !isset($excepts['like']) ? $this->setLike() : false;
        $in = !isset($excepts['in']) ? $this->setWhereIn() : false;
        $between = !isset($excepts['between']) ? $this->setBetween() : false;

        // 使用when代替if else语句
        $query->when($search, function ($query) use ($search) {
            foreach ($search as $key => $val) {
                $query->where($key, $val);
            }

        })->when($like, function ($query) use ($like) {
            foreach ($like as $key => $val) {
                $query->where($key, 'like', '%' . $val . '%');
            }
        })->when($in, function ($query) use ($in) {
            foreach ($in as $key => $val) {
                $query->whereIn($key, $val);
            }
        })->when($between, function ($query) use ($between) {
            foreach ($between as $key => $val) {
                $query->whereBetween($key, $val);
            }
        });

        return $query;
    }

我的控制器

<?php

namespace App\Http\Controllers;

use App\Http\Requests\QuestionRequest;
use App\Models\Question;
use Auth;
use DB;
use Illuminate\Http\Request;

class QuestionController extends Controller
{
    /**
     * 列表
     *
     * @param Request $request
     * @param Question $question
     * @return \Illuminate\Http\Response
     */
    public function index(Request $request)
    {
        // 设置前可控分页(10,25,50,100)
        $size = $request->size ?? 10;

        $labelIds = $request->filled('label_id') ? $request->label_id : false;
        // 使用定义的filter
        $data = Question::filter()
            // 如果存在关联查询,则执行此步骤
            ->when($labelIds, function ($query) use ($labelIds) {
                $query->whereHas('labels', function ($query) use ($labelIds) {
                    $query->whereIn('label_id', $labelIds);
                });
            })
            // 加载题目属性信息
            ->with('labels')->paginate();

        // todo (presenter or transformer)数据转换
        $data = $data;

        return response()->json($data);
    }
}
本作品采用《CC 协议》,转载必须注明作者和本文链接
《L04 微信小程序从零到发布》
从小程序个人账户申请开始,带你一步步进行开发一个微信小程序,直到提交微信控制台上线发布。
《L05 电商实战》
从零开发一个电商项目,功能包括电商后台、商品 & SKU 管理、购物车、订单管理、支付宝支付、微信支付、订单退款流程、优惠券等
讨论数量: 0
(= ̄ω ̄=)··· 暂无内容!

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!