Eloquent ORM 模型中添加自定义值

我们都知道通过Laravel中数据库查询出来的模型对象都是基于数据库字段,今天给大家展示一个 Laravel Eloquent ORM 模型特性-附加值不存在于数据表中。

举个简单的栗子,一篇文章(posts表)对应有很多评论(comments表),我们获取文章的同时需要获取评论数量。通常的做法就是根据 ORM 的关联关系,获取评论数量:$post->comments()->count()

如果获取的是一个文章列表,那么最直接的办法就是 froeach 查询出来的文章,然后每篇文章获取评论数量;另外一种做法就是用 with 然后在闭包里面实现评论数量,至于怎么实现,我就不详细介绍了。Laravel 提供了一种更优雅的方式。

关联关系

class Post extends Model
{
    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = ['title', 'text'];

    /**
     * 文章对应多条评论
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function comments()
    {
        return $this->hasMany(Comment::class);
    }
}

上面代码没有什么特殊的,只是先声明一下关联关系,接下来会使用。接下来创建一个访问器,如果你还不清楚访问器是什么,建议你看一下Laravel官方文档:https://learnku.com/docs/laravel/5.3/eloquent-muta...

创建访问器

public function getCountCommentsAttribute()
{
    return $this->comments()->count();
}

这里的 getCountCommentsAttribute 方法名中 getAttribute 是固定写法,真正在模型中的名称是由 CountComments 决定,命名一般是驼峰写法,一个单词时在 ORM 模型中就是那个单词的小写,如果像 CountComments 这种方式在 ORM 模型会转化为 count_comments

创建访问器后,我们获取数据的时候 ORM 模型中并没有这个属性,因为Laravel并不会默认加上访问器的属性。

添加属性到ORM模型中

我们现在要做的很简单,我们想要在 ORM模型中获取到 count_comments 。只用简单的在 $appends 数组中添加属性名。

protected $appends = ['count_comments'];

OK,That was all!

简单的测试截图:

http://cache.iwanli.me/iwanli/image/QQ%E6%88%AA%E5%9B%BE20161228135846.jpg

查询出来的ORM中可以看到 appends 里面添加了 count_comments 属性。把这个 ORM 模型进行 toArray() 的时候机构就更加清晰了:

更多用法和扩展根据大家需要来就行了,这里只做一个抛砖引玉。这个知识点看到国外文章,需要翻墙,我就不贴出来了。

本帖已被设为精华帖!
本帖由 Summer 于 7年前 加精
《L05 电商实战》
从零开发一个电商项目,功能包括电商后台、商品 & SKU 管理、购物车、订单管理、支付宝支付、微信支付、订单退款流程、优惠券等
《L03 构架 API 服务器》
你将学到如 RESTFul 设计风格、PostMan 的使用、OAuth 流程,JWT 概念及使用 和 API 开发相关的进阶知识。
讨论数量: 9

为什么不在文章表加一个字段,评论数量。你这样子性能呢?一个文章列表,如果每一个文章有10万条评论。

7年前 评论

@dope2008 我这只是一个简单的例子,没有考虑任何东西。只是为了演示一下Laravel模型的自定义~~

7年前 评论

@lx1036 这个只能是数据库中已经存在的字段进行访问器的修改,日过定义的属性不存在数据库中的对应字段,查询出来是不会有人和效果的,必须要加到 $appends 数组中才行

7年前 评论

非常好的分享。方便的对数据内容进行调整更改等进行 append。

但是要注意,绝对绝对不要在 append 里面添加一些耗时的操作或者需要资源的操作,比如数据库查询。否则无论何时,需不需要这个查询都会进行查询的。严重浪费资源。

文中的例子建议使用 group by 进行统计操作。例子不太好,看过的人可能就会去在 append 里面添加数据库查询了 :smile:

7年前 评论

@zhuzhichao 恩 是有点不恰当 :smile:

7年前 评论

我擦,今天刚好有这个需求,但是看了文档,好像只有对已有字段的访问器,,,结果自己写了个__get(),,,,

6年前 评论

老哥为什么我append 属性字段之后,在with关联查寻该表的时候该添加的属性并没有被添加进来呢

2年前 评论

请问一下,这个怎么在查询列表时手动选择添加自定义属性,而不是配置在你模型上的append属性上全部拿过来

2年前 评论

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