快捷導(dǎo)航

golang使用sync.Once實現(xiàn)懶加載的用法和坑點詳解

更新時間：2023年11月05日 13:55:16 作者：utmhikari

這篇文章主要為大家詳細(xì)介紹了golang使用sync.Once實現(xiàn)懶加載的用法和坑點,文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下

在使用Golang做后端開發(fā)的工程中，我們通常需要聲明一些一些配置類或服務(wù)單例等在業(yè)務(wù)邏輯層面較為底層的實例。為了節(jié)省內(nèi)存或是冷啟動開銷，我們通常采用lazy-load懶加載的方式去初始化這些實例。初始化單例這個行為是一個非常經(jīng)典的并發(fā)處理的案例，比如在java當(dāng)中，我們可能用到建立雙重鎖+volatile的方式保證初始化邏輯只被訪問一次，并且所有線程最終都可以讀取到初始化完成的實例產(chǎn)物。這段經(jīng)典的代碼可以按如下的方式編寫：

public class Singleton {
    private volatile static Singleton uniqueSingleton;
 
    private Singleton() {
    }
 
    public Singleton getInstance() {
        if (null == uniqueSingleton) {
            synchronized (Singleton.class) {
                if (null == uniqueSingleton) {
                    uniqueSingleton = new Singleton();
                }
            }
        }
        return uniqueSingleton;
    }
}

但在Golang里面，實現(xiàn)懶加載的方式可以簡單的多，用內(nèi)置的sync.Once就能滿足。假設(shè)我們有一個user單例，需要被1000個線程讀取并打印，就可以這樣子寫：

type User struct {
    Name string `json:"name"`
    Age  int    `json:"age"`
}

var user *User
var userOnce sync.Once

func initUser() {
    user = &User{}
    cfgStr := `{"name":"foobar","age":18}`
    if err := json.Unmarshal([]byte(cfgStr), user); err != nil {
        panic("load user err: " + err.Error())
    }
}

func getUser() *User {
    userOnce.Do(initUser)
    return user
}

func TestSyncOnce(t *testing.T) {
    var wg sync.WaitGroup
    for i := 1; i < 1000; i++ {
        wg.Add(1)
        go func(n int) {
            defer wg.Done()
            curUser := getUser()
            t.Logf("[%d] got user: %+v", n, curUser)
        }(i)
    }
    wg.Wait()
}

這段代碼里，首先是通過var userOnce sync.Once聲明了一個sync.Once實例，然后在getUser當(dāng)中，我們聲明了userOnce.Do(initUser)這個操作。假設(shè)一個goroutine最先到達(dá)這個操作，就會上鎖并執(zhí)行initUser，其它goroutine到達(dá)之后，得等第一個goroutine執(zhí)行完initUser之后，才會繼續(xù)return user。這樣，就能一來保證initUser只會執(zhí)行一次，二來所有g(shù)oroutine都能夠最終讀到初始化完成的user單例。

sync.Once的工作機理也很簡單，通過一個鎖和一個flag就能夠?qū)崿F(xiàn)：

func (o *Once) Do(f func()) {
	if atomic.LoadUint32(&o.done) == 0 { // 如果是1表示已經(jīng)完成了，跳過
		o.doSlow(f)
	}
}

func (o *Once) doSlow(f func()) {
	o.m.Lock() // 只有1個goroutine能拿到鎖，其它的等待
	defer o.m.Unlock()
	if o.done == 0 { // 如果還是0表示第一個來的，不是0就表示已經(jīng)有g(shù)oroutine做完了
		defer atomic.StoreUint32(&o.done, 1)
		f()
	}
}

最后也需要注意，sync.Once使用上面有一個坑點，不能也不需要像java一樣為單例提前做nil判斷。比如下面一段代碼是有問題的：

func initUser() {
    user = &User{} // 先給一個zero-value實例
    cfgStr := `{"name":"foobar","age":18}` // 然后加載json內(nèi)容，完成初始化
    if err := json.Unmarshal([]byte(cfgStr), user); err != nil {
        panic("load user err: " + err.Error())
    }
}

func getUser() *User {
    if user == nil {
        userOnce.Do(initUser)
    }
    return user
}

由于Golang沒有volatile關(guān)鍵字，不能控制單例在內(nèi)存的可見性，那么多goroutine并發(fā)時，就有可能出現(xiàn)這樣的執(zhí)行時序：

goroutine-A過了getUser的user == nil判斷，進入到了initUser邏輯，走到了cfgStr := XXX一行
此時切換到goroutine-B，因為goroutine-A在initUser已經(jīng)走過了user = &User{}一行，所以跳過了user == nil判斷，直接返回沒有完全初始化的user實例，然后一直往下運行，就沒切回給goroutine-A

這樣的結(jié)果，就導(dǎo)致有g(shù)oroutine拿到未初始化完成的實例往后運行，后面就出問題了。所以實戰(zhàn)當(dāng)中需要留意，用sync.Once時，不能也不需要加這些nil判斷，就能滿足懶加載單例/配置之類的邏輯。

到此這篇關(guān)于golang使用sync.Once實現(xiàn)懶加載的用法和坑點詳解的文章就介紹到這了,更多相關(guān)go sync.Once懶加載內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: