GoFrame 如何优雅的缓存查询结果

4,219 阅读2分钟

前言摘要

上一篇文章为大家介绍了 GoFrame gcache使用实践 | 缓存控制 淘汰策略 ,得到了大家积极的反馈。

后续几篇文章再接再厉,仍然为大家介绍GoFrame框架缓存相关的知识点,以及自己项目使用中的一些总结思考,GoFrame框架下文简称gf。

今天重点为大家介绍:GoFrame 如何优雅的缓存查询结果

应用场景

gdb支持对查询结果的缓存处理,常用于多读少写的查询缓存场景,并支持手动的缓存清理。

需要注意的是,查询缓存仅支持链式操作,且在事务操作下不可用。

方法介绍

func (m *Model) Cache(duration time.Duration, name ... string) *Model

重要提醒:事务查询是不支持缓存的。

当duration < 0时表示清除缓存, duration=0时表示不过期, duration > 0时表示过期时间,duration过期时间单位:秒;

name表示自定义的缓存名称,便于业务层精准定位缓存项(如果业务层需要手动清理时,必须指定缓存名称)

重要概念

ORM对象默认情况下提供了缓存管理对象,该缓存对象类型为*gcache.Cache,也就意味着支持*gcache.Cache的所有特性。

我们可以通过GetCache() *gcache.Cache 接口方法获得该缓存对象,并通过返回的对象实现自定义的各种缓存操作,例如:g.DB().GetCache().Keys()

缓存适配(Redis缓存)

默认情况下ORM*gcache.Cache缓存对象提供的是单进程内存缓存,虽然性能非常高效,但是只能在单进程内使用。

如果服务采用多节点部署,多节点之间的缓存可能会产生数据不一致的情况,所有大多数场景下我们都是通过Redis服务器来实现对数据库查询数据的缓存。

优雅的切换

*gcache.Cache对象采用了适配器设计模式,可以轻松实现从单进程内存缓存切换为分布式的Redis缓存。

示例代码如下,是不是非常优雅:

adapter := adapter.NewRedis(g.Redis())
g.DB().GetCache().SetAdapter(adapter)

Redis的缓存是基于查询SQL作为键名,查询结果作为键值。

通过Cache链式方法对缓存的写入和清除都非常便捷。

使用示例

数据表结构

CREATE TABLE `user` (
  `uid` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `name` varchar(30) NOT NULL DEFAULT '' COMMENT '昵称',
  `site` varchar(255) NOT NULL DEFAULT '' COMMENT '网站',
  PRIMARY KEY (`uid`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;

示例代码

package main

import (
    "github.com/gogf/gf/database/gdb"
    "github.com/gogf/gf/frame/g"
    "time"
)

func main() {
    db := g.DB()
    // 开启调试模式,以便于记录所有执行的SQL(也可以在配置文件中设置)
    db.SetDebug(true)

    // 执行2次查询并将查询结果缓存1小时
    // 设置了缓存名称:test-user,用于下面验证更新删除缓存的操作
    for i := 0; i < 2; i++ {
        r, _ := db.Table("user").Cache(time.Hour, "test-user").Where("uid", 1).One()
        g.Log().Print(r.Map())
    }

    // 执行更新操作,并清理指定名称(test-user)的缓存
    _, err := db.Table("user").Cache(-1, "test-user").Data(gdb.Map{"name": "海贼王"}).Where("uid", 1).Update()
    if err != nil {
        g.Log().Fatal(err)
    }

    // 再次执行查询,启用查询缓存特性
    r, _ := db.Table("user").Cache(time.Hour, "test-user").Where("uid", 1).One()
    g.Log().Print(r.Map())
}

执行后输出结果为(测试表数据结构仅供示例参考):

2022-06-15 21:44:12.228 [DEBU] [1 ms] SELECT * FROM `user` WHERE uid=1 LIMIT 1
2022-06-15 21:44:12.228 {"name":"王中阳","site":"https://juejin.cn/user/2189882892232029","uid":1}
2022-06-15 21:44:12.228 {"name":"王中阳","site":"https://juejin.cn/user/2189882892232029","uid":1}
2022-06-15 21:44:12.299 [DEBU] [1 ms] UPDATE `user` SET `name`='海贼王' WHERE uid=1
2022-06-15 21:44:12.300 [DEBU] [1 ms] SELECT * FROM `user` WHERE uid=1 LIMIT 1
2022-06-15 21:44:12.300 {"name":"海贼王","site":"https://juejin.cn/user/2189882892232029","uid":1}

运行结果分析

  1. 执行两次One方法数据查询,第一次走了SQL查询,第二次直接使用到了缓存,SQL没有提交到数据库执行,因此这里只打印了一条查询SQL,并且两次查询的结果也是一致的。
  2. 注意:我们为了后续清空更新缓存,才为查询的缓存设置了一个自定义的名称test-user。如果缓存不需要清理,是可以不用设置缓存名称的。
  3. 当执行Update更新操作时,同时根据名称清空指定的缓存。
  4. 随后再执行One方法数据查询,这时重新缓存新的数据。

小技巧

为了方便展示缓存效果,我们开启了数据debug特性,当有任何的SQL操作时将会输出到终端。

当然我们也可以在配置文件中进行设置,达到全局开启debug特性的效果:

在config.toml中设置:

[database]
link = "mysql:root:xxxxxxxx@tcp(xxxxxxxx:3306)/xxxxxxx"
debug = true

总结

GoFrame的gdb对查询结果的缓存处理是不是非常的优雅。

尤其是*gcache.Cache对象采用了适配器设计模式,可以轻松实现从单应用的内存缓存,切换为分布式的Redis缓存。

小伙伴们还有哪些优雅的实践欢迎评论指教。

一起学习

公众号:程序员升级打怪之旅

微信号:wangzhongyang1993

福利🧧:点这里-->半价买掘金小册,额外领红包