以下常用方法列表,文档更新可能滞后于代码新特性,更多的方法及示例请参考代码文档: https://pkg.go.dev/github.com/gogf/gf/v2/os/gcache
Set
- 说明:使用
key-value
键值对设置缓存,键值可以是任意类型。 - 格式:
Set(ctx context.Context, key interface{}, value interface{}, duration time.Duration) error
- 示例:将
slice
切片设置到键名k1
的缓存中。
func ExampleCache_Set() {
c := gcache.New()
c.Set(ctx, "k1", g.Slice{1, 2, 3, 4, 5, 6, 7, 8, 9}, 0)
fmt.Println(c.Get(ctx, "k1"))
// Output:
// [1,2,3,4,5,6,7,8,9] <nil>
}
SetAdapter
- 说明:
SetAdapter
更改此缓存对象的底层适配器。请注意,此设置函数不是并发安全的。 - 格式:
SetAdapter(adapter Adapter)
- 示例:可以自己根据需要实现任意缓存适配器,实现接口方法即可。
func ExampleCache_SetAdapters() {
c := gcache.New()
adapter := gcache.New()
c.SetAdapter(adapter)
c.Set(ctx, "k1", g.Slice{1, 2, 3, 4, 5, 6, 7, 8, 9}, 0)
fmt.Println(c.Get(ctx, "k1"))
// Output:
// [1,2,3,4,5,6,7,8,9] <nil>
}
SetIfNotExist
- 说明: 当指定
key
的键值不存在时设置其对应的键值value
并返回true
,否则什么都不做并返回false
。 - 格式:
SetIfNotExist(ctx context.Context, key interface{}, value interface{}, duration time.Duration) (ok bool, err error)
- 示例:通过
SetIfNotExist
直接判断写入
,并设置过期时间。
func ExampleCache_SetIfNotExist() {
c := gcache.New()
// Write when the key name does not exist, and set the expiration time to 1000 milliseconds
k1, err := c.SetIfNotExist(ctx, "k1", "v1", 1000*time.Millisecond)
fmt.Println(k1, err)
// Returns false when the key name already exists
k2, err := c.SetIfNotExist(ctx, "k1", "v2", 1000*time.Millisecond)
fmt.Println(k2, err)
// Print the current list of key values
keys1, _ := c.Keys(ctx)
fmt.Println(keys1)
// It does not expire if `duration` == 0. It deletes the `key` if `duration` < 0 or given `value` is nil.
c.SetIfNotExist(ctx, "k1", 0, -10000)
// Wait 1 second for K1: V1 to expire automatically
time.Sleep(1200 * time.Millisecond)
// Print the current key value pair again and find that K1: V1 has expired
keys2, _ := c.Keys(ctx)
fmt.Println(keys2)
// Output:
// true <nil>
// false <nil>
// [k1]
// [<nil>]
}
SetMap
- 说明: 批量设置键值对,输入参数类型为
map[interface{}]interface{}
。 - 格式:
SetMap(ctx context.Context, data map[interface{}]interface{}, duration time.Duration) error
- 示例:
func ExampleCache_SetMap() {
c := gcache.New()
// map[interface{}]interface{}
data := g.MapAnyAny{
"k1": "v1",
"k2": "v2",
"k3": "v3",
}
c.SetMap(ctx, data, 1000*time.Millisecond)
// Gets the specified key value
v1, _ := c.Get(ctx, "k1")
v2, _ := c.Get(ctx, "k2")
v3, _ := c.Get(ctx, "k3")
fmt.Println(v1, v2, v3)
// Output:
// v1 v2 v3
}
Size
- 说明:
Size
返回缓存中的项数
。 - 格式:
Size(ctx context.Context) (size int, err error)
- 示例:
func ExampleCache_Size() {
c := gcache.New()
// Add 10 elements without expiration
for i := 0; i < 10; i++ {
c.Set(ctx, i, i, 0)
}
// Size returns the number of items in the cache.
n, _ := c.Size(ctx)
fmt.Println(n)
// Output:
// 10
}
Update
- 说明:
Update
更新key
的对应的键值,但不更 改其过期时间
,并返回旧值。如果缓存中不存在key
,则返回的exist
值为false
。 - 格式:
Update(ctx context.Context, key interface{}, value interface{}) (oldValue *gvar.Var, exist bool, err error)
- 示例:通过
SetMap
添加多个缓存,通过Update
指定key
修改value
。
func ExampleCache_Update() {
c := gcache.New()
c.SetMap(ctx, g.MapAnyAny{"k1": "v1", "k2": "v2", "k3": "v3"}, 0)
k1, _ := c.Get(ctx, "k1")
fmt.Println(k1)
k2, _ := c.Get(ctx, "k2")
fmt.Println(k2)
k3, _ := c.Get(ctx, "k3")
fmt.Println(k3)
re, exist, _ := c.Update(ctx, "k1", "v11")
fmt.Println(re, exist)
re1, exist1, _ := c.Update(ctx, "k4", "v44")
fmt.Println(re1, exist1)
kup1, _ := c.Get(ctx, "k1")
fmt.Println(kup1)
kup2, _ := c.Get(ctx, "k2")
fmt.Println(kup2)
kup3, _ := c.Get(ctx, "k3")
fmt.Println(kup3)
// Output:
// v1
// v2
// v3
// v1 true
// false
// v11
// v2
// v3
}
UpdateExpire
- 说明:
UpdateExpire
更新key
的过期时间并返回旧的过期时间值
。如果缓存中不存在key
,则返回-1
。 - 格式:
UpdateExpire(ctx context.Context, key interface{}, duration time.Duration) (oldDuration time.Duration, err error)
- 示例:通过
UpdateExpire
更新key
的过期时间并打印查看。
func ExampleCache_UpdateExpire() {
c := gcache.New()
c.Set(ctx, "k1", "v1", 1000*time.Millisecond)
expire, _ := c.GetExpire(ctx, "k1")
fmt.Println(expire)
c.UpdateExpire(ctx, "k1", 500*time.Millisecond)
expire1, _ := c.GetExpire(ctx, "k1")
fmt.Println(expire1)
// Output:
// 1s
// 500ms
}
Values
- 说明: 通过
Values
获取缓存中的所有值,以切片方式返回。 - 格式:
Values(ctx context.Context) (values []interface{}, err error)
- 示例:通过
UpdateExpire
更新key
的过期时间并打印查看。
func ExampleCache_Values() {
c := gcache.New()
c.Set(ctx, "k1", g.Map{"k1": "v1", "k2": "v2"}, 0)
// Values returns all values in the cache as slice.
data, _ := c.Values(ctx)
fmt.Println(data)
// May Output:
// [map[k1:v1 k2:v2]]
}
Close
- 说明: 关闭缓存,让
GC
回收资源,默认情况下可不关闭
。 - 格式:
Close(ctx context.Context) error