Laravel Model 优化 - 添加属性缓存(attribute cache)

问题背景

在我们的项目中,使用到了大量的attribute函数,来改善我们在面向业务时的调用方便和代码层面的优雅,但是同样也带来的一定的问题,会产生大量的重复计算和SQL调用,在应用上的性能上造成了一击。

我们来演示一下这个过程,首先定义出一个attribute,这样我们可以方便通过的$user->posts_count,拿到用户发表的动态总数,像比原来的写法更加具有语义化,也更优雅了很多。

public function getPostsCountAttribute()
{
        return $this->posts()->count();
}

但是遇到下面这种情况,就会糟糕了很多,会产生多次的SQL查询,来造成服务端响应的缓慢

if($user->posts_count > 30){
    //处理一
}

if($user->posts_count > 50){
    //处理二
}

if($user->posts_count > 100){
    //处理三
}

if($user->posts_count > 200){
    //处理四
}

像上面这样的写法的,我们可能会造成4次SQL聚合运算,从而影响到我们的响应速度,当然我们也可以尝试改进代码规范来解决这个问题,但是仍然不能保证,这个属性被第二次、三次持续调用,那么方便、快捷的办法就是添加一层属性缓存,将获取后的值缓存到模型属性上。

属性缓存(attribute cache)

使用属性缓存的优势就是简单、快捷,无需借助第三方扩展,采用的是面向对象语言的原生优势,下面来实现一下:

在我们Larvel框架的项目中,model都是继承于Eloquent\Model这个基类,我们重新复写该基类操作比较繁琐,所以可以采用php为了实现多继承的trait来实现。

首先实现一个AttributeCacheHelper的trait

<?php

namespace App\Traits;

trait AttributeCacheHelper
{
    private $cachedAttributes = [];

    public function getCachedAttribute(string $key, callable $callable)
    {
        if (!array_key_exists($key, $this->cachedAttributes)) {
            $this->setCachedAttribute($key, call_user_func($callable));
        }

        return $this->cachedAttributes[$key];
    }

    public function setCachedAttribute(string $key, $value)
    {
        return $this->cachedAttributes[$key] = $value;
    }

    public function refresh()
    {
        unset($this->cachedAttributes);

        return parent::refresh();
    }
}

主要是实现了三个函数,get和set用于获取和设置属性缓存,refresh重写了父类的刷新函数,每次刷新后都会清理掉对象缓存。

然后我们开始重新修改一下我们的attribute,来添加对象缓存,首先是需要在Model上使用AttributeCacheHelper这个trait

public function getPostsCountAttribute()
{
    $method   = 'postsCount';
    $callable = [$this, $method];
    return $this->getCachedAttribute($method, $callable);
}

public function postsCount()
{
    return $this->posts()->count();
}

修改完成后,我们再重新应用到场景中,就算执行一万次,也只会产生1次SQL查询,极大的提高了查询效率和响应速度。

for($i=0;$i<10000;$i++){
    // 仅产生一次真实查询,其余全部读取对象缓存数据
    dump($user->posts_count);
}

最后 happy coding 。