详解Golang中gcache模块的基本使用

时间:2022-11-03 王中阳Go 人气:0

gcache提供统一的缓存管理模块，提供了开发者可自定义灵活接入的缓存适配接口，并默认提供了高速内存缓存适配实现。

先说结论

这篇文章通过结合商业项目的使用场景，为大家介绍了gcache的基本使用、缓存控制以及淘汰策略。

使用gcache做缓存处理，简单方便易上手！

优势

gcache模块默认提供的是一个高速的内存缓存，操作效率非常高效，CPU性能损耗在ns纳秒级别。使用简单易上手，非常适合单机应用使用。

基本使用

我们可以通过gcache.New()创建一个缓存对象

也可以直接使用gcache包方法，使用方式都是一样的。

下面代码段介绍了gcache的基本使用：

package main

import (
   "fmt"
   "github.com/gogf/gf/os/gcache"
   "github.com/gogf/gf/os/gtime"
)

func main() {
   // 创建一个缓存对象，
   c := gcache.New()
   // 设置缓存，不过期
   _ = c.Set("k1", "v1", 0)

   // 获取缓存
   v, _ := c.Get("k1")
   fmt.Println("k1对应的值：", v) //v1

   // 获取缓存大小
   n, _ := c.Size()
   fmt.Println("缓存大小：", n) //1

   // 缓存中是否存在指定键名
   b, _ := c.Contains("k1")
   fmt.Println("是否存在k1：", b)         //true
   isContains, _ := c.Contains("k2") //false
   fmt.Println("是否存在k2：", isContains)

   // 删除并返回被删除的键值
   fmt.Println(c.Remove("k1")) //v1

   // 关闭缓存对象，让GC回收资源
   _ = c.Close()

   // 当然也可以便捷地直接使用gcache包方法，使用方式和上面的一样
   _ = gcache.Set("k2", "v2", gtime.M*30) //半小时后到期
   k2Value, _ := gcache.Get("k2")
   fmt.Println("k2对应的值：", k2Value) //v2
}

打印结果

缓存控制

下面介绍一些特殊场景的用法：

当键名不存在时写入：SetIfNotExist

根据键名取不到值时写入：GetOrSet

package main

import (
   "fmt"
   "github.com/gogf/gf/os/gcache"
   "time"
)

func main() {
   // 当键名不存在时写入，设置过期时间1秒
   _, _ = gcache.SetIfNotExist("k1", "v1", time.Second)

   // 打印当前的键名列表
   keys, _ := gcache.Keys()
   fmt.Println("打印当前的键名列表：", keys) //[k1]

   // 打印当前的键值列表
   values, _ := gcache.Values()
   fmt.Println("打印当前的键值列表:", values) //[v1]

   // 获取指定键值，如果不存在时写入，并返回键值；第三个参数设置为0表示永不过期
   v, _ := gcache.GetOrSet("k2", "v2", 0)
   fmt.Println("写入的键值：", v) //v2

   // 打印当前的键值对
   dataMap, _ := gcache.Data()
   fmt.Println("打印当前的键值对:", dataMap) // map[k1:v1 k2:v2]

   // 等待1秒，以便k1:v1自动过期
   time.Sleep(time.Second)

   // 再次打印当前的键值对，发现k1:v1已经过期，只剩下k2:v2
   data2, _ := gcache.Data()
   fmt.Println("等待一秒后，打印当前的键值对:", data2) // map[k2:v2]
}

打印结果

缓存淘汰策略

之前做项目的时候也有这么设计过，现在gcache天然支持缓存淘汰策略

实战举例

给大家举个项目中的栗子：

比如我有一个新闻网站，为了保证新闻详情页的加载速度，会把新闻详情页做缓存处理（内容缓存，评论点赞等动态获取。）

一般来说新产生的新闻热度和访问量会更高，需要做缓存，而陈旧的新闻因为热度不再，访问量较低就从缓存中释放了。

解决上面的问题一般有2种思路：

设置缓存时间是一个解决思路
另外的思路就是设置缓存的淘汰策略。

比如：我一共允许缓存1万个缓存详情页，当超过1万个时，会淘汰掉最早缓存的数据，实现动态且稳定的缓存策略。

gcache天然支持这种缓存淘汰策略

代码示例

下面举个简单的栗子：

package main

import (
   "fmt"
   "github.com/gogf/gf/os/gcache"
   "time"
)

func main() {
   // 设置LRU淘汰数量
   c := gcache.New(2)

   // 添加10个元素，不过期
   for i := 0; i < 10; i++ {
      _ = c.Set(i, i, 0)
   }
   n, _ := c.Size()
   fmt.Println("缓存大小：", n)
   keys, _ := c.Keys()
   fmt.Println("缓存键值：", keys)

   // 读取键名1，保证该键名是优先保留
   v, _ := c.Get(1)
   fmt.Println("读取键名1的值：", v)

   // 等待一定时间后(默认1秒检查一次)，
   // 元素会被按照从旧到新的顺序进行淘汰
   for i := 0; i < 10; i++ {
      time.Sleep(2 * time.Second)
      n, _ = c.Size()
      fmt.Println("缓存大小：", n)
      keys, _ = c.Keys()
      fmt.Println("缓存键值：", keys)
   }
}

打印结果

小技巧

GetOrSetFunc的使用

GetOrSetFunc获取一个缓存值，当缓存不存在时执行指定的f func() (interface{}, error)，缓存该f方法的结果值，并返回该结果。

总结

这篇文章通过结合商业项目的使用场景，为大家介绍了gcache的基本使用、缓存控制以及淘汰策略。

单机项目可以使用gcache做缓存处理，简单方便易上手；

加载全部内容