beego 框架 cache 目錄是 Go 實現的一個緩存管理器,是beego框架自帶工具之一,當然,如果你只想使用 cache 而不是整個 beego 框架,可以選擇性安裝: go get github.com/astaxie/beego/cache 在我寫這篇博文時, beego 版本是 v1. ...
beego 框架 cache 目錄是 Go 實現的一個緩存管理器,是beego框架自帶工具之一,當然,如果你只想使用 cache 而不是整個 beego 框架,可以選擇性安裝:
go get github.com/astaxie/beego/cache
在我寫這篇博文時, beego 版本是 v1.11.1 , cache 支持記憶體、文件、 memcache 、 redis、ssdb 。
使用例子:
package main
import (
// 導入cache包
"github.com/astaxie/beego/cache"
"time"
)
func main() {
/*
bm, err := cache.NewCache("memcache", `{"conn":"127.0.0.1:11211"}`)//memcache
bm, err := cache.NewCache("redis", `{"conn":":6039"}`)//redis
bm, err := cache.NewCache("file", `{"CachePath":"cache","FileSuffix":".bin","DirectoryLevel":2,"EmbedExpiry":0}`)
*/
// 初始化一個記憶體的緩存管理器
bm, err := cache.NewCache("memory", `{"interval":60}`)
bm.Put("user", "張三", 10 * time.Second) //
bm.Get("user")
bm.IsExist("user")
bm.Delete("user")
}
cache 包定義了Cache介面,如下:
// Cache interface contains all behaviors for cache adapter.
// usage:
// cache.Register("file",cache.NewFileCache) // this operation is run in init method of file.go.
// c,err := cache.NewCache("file","{....}")
// c.Put("key",value, 3600 * time.Second)
// v := c.Get("key")
//
// c.Incr("counter") // now is 1
// c.Incr("counter") // now is 2
// count := c.Get("counter").(int)
type Cache interface {
// Get 函數通過鍵獲取值。
Get(key string) interface{}
// GetMulti 是 Get 的一個批處理版本。
GetMulti(keys []string) []interface{}
// Put 函數設置存入一對鍵值和到期時間。
Put(key string, val interface{}, timeout time.Duration) error
// 通過鍵刪除值.
Delete(key string) error
// 讓鍵對應的值加1.
Incr(key string) error
// 讓鍵對應的值減1.
Decr(key string) error
// 檢查一個鍵是否存在.
IsExist(key string) bool
// 清空所有緩存.
ClearAll() error
// 根據配置啟動一個gc協程。
StartAndGC(config string) error
}
cache.go文件定義了 Instance , Instance 是一個 function ,功能是創建一個Cache介面的實例。adapters是一個 map 用於註冊實現了 Cache 的適配器。Register註冊可用的適配器,如果被調用兩次或者驅動為空,將 panic 。代碼如下:
type Instance func() Cache
var adapters = make(map[string]Instance)
func Register(name string, adapter Instance) {
if adapter == nil {
panic("cache: Register adapter is nil")
}
if _, ok := adapters[name]; ok {
panic("cache: Register called twice for adapter " + name)
}
adapters[name] = adapter
}
我們來先看記憶體緩存的實現方式:
1.MemoryCache memory,go
全局變數及結構
DefaultEvery 表示在記憶體中回收過期緩存項的時間,預設為 1 分鐘。
var DefaultEvery = 60
MemoryItem 用於保存基本記憶體緩存元素.
type MemoryItem struct {
val interface{}
createdTime time.Time
lifespan time.Duration
}
MemoryCache 是一個記憶體管理適配器,它包含了一個讀寫鎖(sync.RWMutex),使得 MemoryCache 具備併發安全性。
type MemoryCache struct {
sync.RWMutex
dur time.Duration
items map[string]*MemoryItem
Every int // run an expiration check Every clock time
}
方法及函數
init function 註冊驅動名,其實就是一個map存取操作,見上面的 Register 函數。
func init() {
Register("memory", NewMemoryCache)
}
NewMemoryCache 初始化一個記憶體緩存適配器,返回 Cache 介面,NewMemoryCache 實現了 Cache 介面。
func NewMemoryCache() Cache {
cache := MemoryCache{items: make(map[string]*MemoryItem)}
return &cache
}
Get 返回一個鍵在 MemoryCache 中的值, 如果該鍵不存在或到期,返回nil。
func (bc *MemoryCache) Get(name string) interface{} {
bc.RLock()
defer bc.RUnlock()
if itm, ok := bc.items[name]; ok {
if itm.isExpire() {
return nil
}
return itm.val
}
return nil
}
GetMulti 傳入一個鍵的 slice,返回slice中存在於緩存且沒有過期的值.
func (bc *MemoryCache) GetMulti(names []string) []interface{} {
var rc []interface{}
for _, name := range names {
rc = append(rc, bc.Get(name))
}
return rc
}
Put 向 MemoryCache 中存入一個鍵名位name ,值為 item 的緩存鍵值對並設置時間為 lifespan ,如果時間為 0 ,那麼 item 將永遠存在,除非用戶主動刪除或。
func (bc *MemoryCache) Put(name string, value interface{}, lifespan time.Duration) error {
bc.Lock()
defer bc.Unlock()
bc.items[name] = &MemoryItem{
val: value,
createdTime: time.Now(),
lifespan: lifespan,
}
return nil
}
Delete 刪除 MemoryCache 中鍵名為 name 的緩存.
func (bc *MemoryCache) Delete(name string) error {
bc.Lock()
defer bc.Unlock()
if _, ok := bc.items[name]; !ok {
return errors.New("key not exist")
}
delete(bc.items, name)
if _, ok := bc.items[name]; ok {
return errors.New("delete key error")
}
return nil
}
Incr 增加鍵名為 name 緩存的值,支持類型:int,int32,int64,uint,uint32,uint64.
func (bc *MemoryCache) Incr(key string) error {
bc.RLock()
defer bc.RUnlock()
itm, ok := bc.items[key]
if !ok {
return errors.New("key not exist")
}
switch itm.val.(type) {
case int:
itm.val = itm.val.(int) + 1
case int32:
itm.val = itm.val.(int32) + 1
case int64:
itm.val = itm.val.(int64) + 1
case uint:
itm.val = itm.val.(uint) + 1
case uint32:
itm.val = itm.val.(uint32) + 1
case uint64:
itm.val = itm.val.(uint64) + 1
default:
return errors.New("item val is not (u)int (u)int32 (u)int64")
}
return nil
}
Decr 減少鍵名為 name 緩存的值,支持類型:int,int32,int64,uint,uint32,uint64,如果類型為 uint,uint32,uint64 且值為 0 時,會返回值小於0錯誤。
func (bc *MemoryCache) Decr(key string) error {
bc.RLock()
defer bc.RUnlock()
itm, ok := bc.items[key]
if !ok {
return errors.New("key not exist")
}
switch itm.val.(type) {
case int:
itm.val = itm.val.(int) - 1
case int64:
itm.val = itm.val.(int64) - 1
case int32:
itm.val = itm.val.(int32) - 1
case uint:
if itm.val.(uint) > 0 {
itm.val = itm.val.(uint) - 1
} else {
return errors.New("item val is less than 0")
}
case uint32:
if itm.val.(uint32) > 0 {
itm.val = itm.val.(uint32) - 1
} else {
return errors.New("item val is less than 0")
}
case uint64:
if itm.val.(uint64) > 0 {
itm.val = itm.val.(uint64) - 1
} else {
return errors.New("item val is less than 0")
}
default:
return errors.New("item val is not int int64 int32")
}
return nil
}
IsExist 檢查鍵為 name 的緩存是否存在.
func (bc *MemoryCache) IsExist(name string) bool {
bc.RLock()
defer bc.RUnlock()
if v, ok := bc.items[name]; ok {
return !v.isExpire()
}
return false
}
ClearAll 會清除所有緩存.
func (bc *MemoryCache) ClearAll() error {
bc.Lock()
defer bc.Unlock()
bc.items = make(map[string]*MemoryItem)
return nil
}
StartAndGC 開始周期性對緩存進行檢查,如果緩存鍵值對過期,會被刪除。
func (bc *MemoryCache) StartAndGC(config string) error {
var cf map[string]int
json.Unmarshal([]byte(config), &cf)
if _, ok := cf["interval"]; !ok {
cf = make(map[string]int)
cf["interval"] = DefaultEvery
}
dur := time.Duration(cf["interval"]) * time.Second
bc.Every = cf["interval"]
bc.dur = dur
go bc.vacuum()
return nil
}
未導出函數及方法
// 檢查是否超時.
func (bc *MemoryCache) vacuum() {
bc.RLock()
every := bc.Every
bc.RUnlock()
if every < 1 {
return
}
for {
<-time.After(bc.dur)
if bc.items == nil {
return
}
if keys := bc.expiredKeys(); len(keys) != 0 {
bc.clearItems(keys)
}
}
}
// expiredKeys 返回到期的鍵名 slice.
func (bc *MemoryCache) expiredKeys() (keys []string) {
bc.RLock()
defer bc.RUnlock()
for key, itm := range bc.items {
if itm.isExpire() {
keys = append(keys, key)
}
}
return
}
// clearItems 清空鍵名在 keys 內的緩存.
func (bc *MemoryCache) clearItems(keys []string) {
bc.Lock()
defer bc.Unlock()
for _, key := range keys {
delete(bc.items, key)
}
}
後記
file、ssdb、memcache和redis實現都相似,file以文件方式儲存每個鍵對應一個文件,文件內容為值的數據,用gob編碼持久化。