快捷導(dǎo)航

go-cache的基本使用場(chǎng)景示例解析

更新時(shí)間：2023年04月23日 14:30:26 作者：LiP

這篇文章主要為大家介紹了go-cache的基本使用場(chǎng)景示例解析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

什么是 go-cache

go-cache 是一個(gè)輕量級(jí)的基于內(nèi)存的 K-V 儲(chǔ)存組件，內(nèi)部實(shí)現(xiàn)了一個(gè)線程安全的 map[string]interface{}，適用于單機(jī)應(yīng)用。具備如下功能：

線程安全，多 goroutine 并發(fā)安全訪問；
每個(gè) item 可以設(shè)置過期時(shí)間（或無過期時(shí)間）；
自動(dòng)定期清理過期的 item；
可以自定義清理回調(diào)函數(shù)；

這里的 item 指的是 map 里的元素。

go-cache 一般用作臨時(shí)數(shù)據(jù)緩存來使用，而不是持久性的數(shù)據(jù)存儲(chǔ)。對(duì)于某些停機(jī)后快速恢復(fù)的場(chǎng)景，go-cache支持將緩存數(shù)據(jù)保存到文件，恢復(fù)時(shí)從文件中將數(shù)據(jù)加載到內(nèi)存。

使用

導(dǎo)入

github.com/patrickmn/go-cache

快速開始

c := cache.New(10*time.Second, 30*time.Second) 
// 默認(rèn)過期時(shí)間10s；清理間隔30s，即每30s會(huì)自動(dòng)清理過期的鍵值對(duì)  

// 設(shè)置一個(gè)鍵值對(duì)，過期時(shí)間是 3s 
c.Set("a", "testa", 3*time.Second)  

// 設(shè)置一個(gè)鍵值對(duì)，采用 New() 時(shí)的默認(rèn)過期時(shí)間，即 10s 
c.Set("foo", "bar", cache.DefaultExpiration)  

// 設(shè)置一個(gè)鍵值對(duì)，沒有過期時(shí)間，不會(huì)自動(dòng)過期，需要手動(dòng)調(diào)用 Delete() 才能刪除 
c.Set("baz", 42, cache.NoExpiration)  

v, found := c.Get("a") 
fmt.Println(v, found) // testa,true  

<-time.After(5 * time.Second) // 延時(shí)5s 

v, found = c.Get("a") // nil,false  
fmt.Println(v, found)  

<-time.After(6 * time.Second) 

v, found = c.Get("foo") // nil,false  
fmt.Println(v, found) 

v, found = c.Get("baz") // 42,true  
fmt.Println(v, found)

常量與結(jié)構(gòu)體

常量

const (
    NoExpiration time.Duration = -1    // 無有效時(shí)間
    DefaultExpiration time.Duration = 0   // 表示采用默認(rèn)時(shí)間
)

這兩個(gè)參數(shù)可以用作 New() 函數(shù)的第一個(gè)入?yún)?，則默認(rèn)過期時(shí)間小于0，意味著添加鍵值對(duì)時(shí)如果采用默認(rèn)過期時(shí)間，則該鍵值對(duì)不會(huì)過期，因?yàn)?DeleteExpired() 方法會(huì)判斷 v.Expiration 是否大于 0，大于 0 時(shí)才會(huì)自動(dòng)刪除。如果想刪除需要手動(dòng) Delete() 方法。

添加鍵值對(duì)，比如執(zhí)行 Set()、Add() 等操作時(shí)，這兩個(gè)常量也可以作為參數(shù)，NoExpiration 表示沒有過期時(shí)間，DefaultExpiration 表示采用默認(rèn)的過期時(shí)間。

結(jié)構(gòu)體

主要的結(jié)構(gòu)體包括下面這些：

type Item struct {  // 鍵值對(duì)
 Object     interface{}     // 存放 K-V 的值，可以存放任何類型的值
 Expiration int64   // 鍵值對(duì)的過期時(shí)間(絕對(duì)時(shí)間)
}

type Cache struct {   // 對(duì)外使用的 Cache
 *cache  // cache 實(shí)例
}

type cache struct {
 defaultExpiration time.Duration   // 默認(rèn)的過期時(shí)間，添加一個(gè)鍵值對(duì)時(shí)如果設(shè)置默認(rèn)的過期時(shí)間（即代碼里的 DefaultExpiration）則會(huì)使用到該值
 items             map[string]Item   // 存放的鍵值對(duì)
 mu                sync.RWMutex   // 讀寫鎖
 onEvicted         func(string, interface{})  // 刪除key時(shí)的回調(diào)函數(shù)
 janitor           *janitor  // 定期清理器 定期檢查過期的 Item
}

type janitor struct { // 清理器結(jié)構(gòu)體
 Interval time.Duration // 清理時(shí)間間隔
 stop     chan bool     // 是否停止
}