在Laravel的Model层做数据缓存的实现


Posted in PHP onSeptember 26, 2019

您在此之前可能就已经缓存过模型数据,但是我将向您展示一个使用动态记录模型的更精细的Laravel模型缓存技术,这是我一开始在 RailsCasts学习到的技术。

使用模型的唯一缓存键,您可以缓存模型(或关联模型)更新时自动更新(以及缓存失效)的模型上的属性和关联,一个好处是访问缓存的数据比在控制器中缓存的数据更具可复用性,因为它在模型上而不是在单个控制器方法中。

这是这个技术的要点:

假设你有很多个 Comment 的 Article 模型,给定下面的Laravel blade 模板,你就可以像下面这样访问 /article/:id 路由时得到评论的数量:

<h3>$article->comments->count() {{ str_plural('Comment', $article->comments->count())</h3>

您可以在控制器中缓存评论的计数,但是当您有多个需要缓存的一次性查询和数据时,控制器会变得非常臃肿难看。使用控制器,访问缓存的数据也不是很方便。

我们可以构建一个模板,它仅在文章更新时访问数据库,并且访问该模型的所有代码都可以获取缓存值:

<h3>$article->cached_comments_count {{ str_plural('Comment', $article->cached_comments_count)</h3>

通过使用模型访问器,我们可以缓存基于最后一次文章更新的评论计数值。

因此,在评论新增或删除时我们该怎么更新文章的 updated_at 列值呢?

先进入 touch 方法看看。

模型的触发

可以通过使用模型的 touch() 方法来更新文章的 updated_at 列值:

$ php artisan tinker

>>> $article = \App\Article::first();
=> App\Article {#746
   id: 1,
   title: "Hello World",
   body: "The Body",
   created_at: "2018-01-11 05:16:51",
   updated_at: "2018-01-11 05:51:07",
  }
>>> $article->updated_at->timestamp
=> 1515649867
>>> $article->touch();
=> true
>>> $article->updated_at->timestamp
=> 1515650910

我们可以用更新的 timestamp 值使缓存失效。不过在新增或删除一个评论时,我们怎么触发修改文章的 updated_at 字段呢?

碰巧 Eloquent 模型中有一个属性就叫 $touches 。下面是我们的评论模型的大概样子:

<?php

namespace App;

use App\Article;
use Illuminate\Database\Eloquent\Model;

class Comment extends Model
{
  protected $guarded = [];

  protected $touches = ['article'];

  public function article()
  {
    return $this->belongsTo(Article::class);
  }
}

这里的 $touches 属性是个数组,包含了在评论的创建、保存和删除时会引起“触发”的关联信息。

缓存的属性

我们先回到 $article->cached_comments_count 访问器。该方法的实现可能象 App\Article 模型中的样子:

public function getCachedCommentsCountAttribute()
{
  return Cache::remember($this->cacheKey() . ':comments_count', 15, function () {
    return $this->comments->count();
  });
}

我们使用唯一键值的 cacheKey() 方法缓存模型 15 分钟,然后简单地在闭包方法中返回评论计数值。

注意,我们也用到了 Cache::rememberForever() 方法,靠着缓存机制的垃圾回收策略以删除过期的键值。我设置了一个定时器,以便在每隔 15 分钟的缓存刷新间隔里,缓存可在该时间的多数范围内有最高的命中率。

cacheKey() 方法要用到模型的唯一键值,并且在模型更新时对应缓存失效。下面是我的 cacheKey 实现代码:

public function cacheKey()
{
  return sprintf(
    "%s/%s-%s",
    $this->getTable(),
    $this->getKey(),
    $this->updated_at->timestamp
  );
}

模型的 cacheKey() 方法示例输出结果可能返回下面的字串信息:

articles/1-1515650910

这个键值是由表名、模型id值及当前 updated_at 的 timestamp 值组成。一旦我们触发这个模型,timestamp 值就会更新,并且我们的模型缓存就会相应地失效。

以下是 Article 模型的完整代码:

<?php

namespace App;

use App\Comment;
use Illuminate\Support\Facades\Cache;
use Illuminate\Database\Eloquent\Model;

class Article extends Model
{
  public function cacheKey()
  {
    return sprintf(
      "%s/%s-%s",
      $this->getTable(),
      $this->getKey(),
      $this->updated_at->timestamp
    );
  }

  public function comments()
  {
    return $this->hasMany(Comment::class);
  }

  public function getCachedCommentsCountAttribute()
  {
    return Cache::remember($this->cacheKey() . ':comments_count', 15, function () {
      return $this->comments->count();
    });
  }
}

然后是关联的 Comment 模型:

<?php

namespace App;

use App\Article;
use Illuminate\Database\Eloquent\Model;

class Comment extends Model
{
  protected $guarded = [];

  protected $touches = ['article'];

  public function article()
  {
    return $this->belongsTo(Article::class);
  }
}

接下来做什么?

我已经向你展示了如何缓存一个简单的评论计数,但是如何缓存所有的评论呢?

public function getCachedCommentsAttribute()
{
  return Cache::remember($this->cacheKey() . ':comments', 15, function () {
    return $this->comments;
  });
}

你也可以选择将评论转换为数组替代序列化模型,只允许在前端对数据进行简单的数组访问:

public function getCachedCommentsAttribute()
{
  return Cache::remember($this->cacheKey() . ':comments', 15, function () {
    return $this->comments->toArray();
  });
}

最后,  我在 Article 模型中定义了cacheKey()方法,但是你可能想要通过一个名为 ProvidesModelCacheKey的trait来定义这个方法以便你可以在复合模型中使用或者在一个基础模型中定义所有模型扩展的方法。 你甚至可能想要为实现cacheKey() 方法的模型使用使用契约(接口)。

我希望你已经发现这个简单的技术是十分有用的!

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

PHP 相关文章推荐
php读取数据库信息的几种方法
May 24 PHP
php 字符串替换的方法
Jan 10 PHP
php笔记之:初探PHPcms模块开发介绍
Apr 26 PHP
基于PHP遍历数组的方法汇总分析
Jun 08 PHP
ThinkPHP3.1新特性之字段合法性检测详解
Jun 19 PHP
PHP解析目录路径的3个函数总结
Nov 18 PHP
PHP实现的比较完善的购物车类
Dec 02 PHP
浅析PHP中Session可能会引起并发问题
Jul 23 PHP
PHP访问数据库集群的方法小结
Mar 14 PHP
Yii2实现上下联动下拉框功能的方法
Aug 10 PHP
Linux平台PHP5.4设置FPM线程数量的方法
Nov 09 PHP
PHP迭代器和迭代的实现与使用方法分析
Apr 19 PHP
PHP的静态方法与普通方法用法实例分析
Sep 26 #PHP
tp5框架无刷新分页实现方法分析
Sep 26 #PHP
php判断目录存在的简单方法
Sep 26 #PHP
php 策略模式原理与应用深入理解
Sep 25 #PHP
php策略模式简单示例分析【区别于工厂模式】
Sep 25 #PHP
PHP 观察者模式深入理解与应用分析
Sep 25 #PHP
php模式设计之观察者模式应用实例分析
Sep 25 #PHP
You might like
超级简单的发送邮件程序
2006/10/09 PHP
基于HBase Thrift接口的一些使用问题及相关注意事项的详解
2013/06/03 PHP
2014年10个最佳的PHP图像操作库
2014/07/14 PHP
Laravel框架实现定时发布任务的方法
2018/08/16 PHP
自己的js工具_Form 封装
2009/08/21 Javascript
JavaScript面向对象程序设计三 原型模式(上)
2011/12/21 Javascript
js Math 对象的方法
2013/09/01 Javascript
jquery将一个表单序列化为一个对象的方法
2014/01/03 Javascript
js实现身份证号码验证的简单实例
2014/02/19 Javascript
JavaScript从数组中删除指定值元素的方法
2015/03/18 Javascript
JavaScript的Polymer框架中dom-repeat与VM的相关操作
2015/07/29 Javascript
jQuery实现带遮罩层效果的blockUI弹出层示例【附demo源码下载】
2016/09/14 Javascript
Angular2开发——组件规划篇
2017/03/28 Javascript
BootStrap Table前台和后台分页对JSON格式的要求
2017/06/28 Javascript
JavaScript中this函数使用实例解析
2020/02/21 Javascript
解决vue项目,npm run build后,报路径错的问题
2020/08/13 Javascript
Vant Weapp组件踩坑:picker的初始赋值解决
2020/11/12 Javascript
python进阶教程之词典、字典、dict
2014/08/29 Python
Python中关于字符串对象的一些基础知识
2015/04/08 Python
Python中绑定与未绑定的类方法用法分析
2016/04/29 Python
Python切片操作实例分析
2018/03/16 Python
python numpy 显示图像阵列的实例
2018/07/02 Python
python主线程与子线程的结束顺序实例解析
2019/12/17 Python
jupyter notebook中美观显示矩阵实例
2020/04/17 Python
Django中文件上传和文件访问微项目的方法
2020/04/27 Python
利用CSS3的checked伪类实现OL的隐藏显示的方法
2010/12/18 HTML / CSS
html5 application cache遇到的严重问题
2012/12/26 HTML / CSS
英国最大的电子零件及配件零售商:Partmaster
2017/04/24 全球购物
男女时尚与复古风格在线购物:RoseGal(全球免费送货)
2017/07/19 全球购物
澳大利亚最受欢迎的美发用品目的地:AMR
2019/08/28 全球购物
简单的辞职信范文
2014/01/18 职场文书
人力资源管理专业自荐书范文
2014/02/10 职场文书
预防艾滋病宣传活动总结
2015/05/09 职场文书
pytorch 带batch的tensor类型图像显示操作
2021/05/20 Python
一看就懂的MySQL的聚簇索引及聚簇索引是如何长高的
2021/05/25 MySQL
Java中生成微信小程序太阳码的实现方案
2022/06/01 Java/Android