Laravel 【Fat Models, Skinny 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);
    }
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,290评论 6 491
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,107评论 2 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,872评论 0 347
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,415评论 1 283
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,453评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,784评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,927评论 3 406
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,691评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,137评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,472评论 2 326
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,622评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,289评论 4 329
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,887评论 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,741评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,977评论 1 265
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,316评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,490评论 2 348

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,756评论 25 707
  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 12,059评论 4 62
  • 春天 还记得昨天晚上睡觉前你说不开心吗?你原以为写完作业,有一个半小时的看书时间,结果只剩半小时,看得意犹未...
    擎天柱_6e9a阅读 70评论 0 0
  • 曾经的梦想是那么的美好,但是自己为曾经的梦想付出的代价也许比我们的梦想还要有成就感,为梦而生,为梦自豪。
    香烟的记忆阅读 174评论 0 1
  • 公元前11世纪初期,第二十一王朝(公元前1071——941年)法老在名义上是全埃及的最高统治者,但以底比斯为中心的...
    丽克阅读 518评论 0 0