Golang實現(xiàn)不被復(fù)制的結(jié)構(gòu)體的方法
不允許復(fù)制的結(jié)構(gòu)體
sync包中的許多結(jié)構(gòu)都是不允許拷貝的，比如sync.Cond,sync.WaitGroup,sync.Pool, 以及sync包中的各種鎖，因為它們自身存儲了一些狀態(tài)(比如等待者的數(shù)量)，如果你嘗試復(fù)制這些結(jié)構(gòu)體:
var wg1 sync.WaitGroup wg2 := wg1 // 將 wg1 復(fù)制一份，命名為 wg2 // ...
那么你將在你的 IDE 中看到一個醒目的警告:
assignment copies lock value to wg2: sync.WaitGroup contains sync.noCopy
IDE是如何實現(xiàn)這一點的呢？我們自己又能否利用這一機(jī)制來告訴別人，不要拷貝某個結(jié)構(gòu)體呢？
（懶得看原理，只想知道怎么用，可以直接下劃至結(jié)論部分）
實現(xiàn)原理
大部分編輯器/IDE都會在你的代碼上運行go vet,vet是Go官方提供的靜態(tài)分析工具，我們剛剛得到的提示信息就是vet分析代碼后告訴我們的。vet的實現(xiàn)在Go源碼的cmd/vet中,里面注冊了很多不同類型的分析器，其中copylock這個分析器會檢查實現(xiàn)了Lock和Unlock方法的結(jié)構(gòu)體是否被復(fù)制。
copylock Analyser在cmd/vet中注冊，具體實現(xiàn)代碼在golang.org/x/tools/go/analysis/passes/copylock/copylock.go中, 這里只摘抄部分核心代碼進(jìn)行解釋:
var lockerType *types.Interface
func init() {
//...
methods := []*types.Func{
types.NewFunc(token.NoPos, nil, "Lock", nullary),
types.NewFunc(token.NoPos, nil, "Unlock", nullary),
}
// Locker 結(jié)構(gòu)包括了 Lock 和 Unlock 兩個方法
lockerType = types.NewInterface(methods, nil).Complete()
}init函數(shù)中把包級別的全局變量lockerType進(jìn)行了初始化，lockerType內(nèi)包含了兩個方法: Lock和Unlock, 只有實現(xiàn)了這兩個方法的結(jié)構(gòu)體才是copylock Analyzer要處理的對象。
// lockPath 省略了參數(shù)部分，只保留了最核心的邏輯，
// 用來檢測某個類型是否實現(xiàn)了Locker接口(Lock和Unlock方法)
func lockPath(...) typePath {
// ...
// 如果傳進(jìn)來的指針類型實現(xiàn)了Locker接口, 就返回這個類型的信息
if types.Implements(types.NewPointer(typ), lockerType) && !types.Implements(typ, lockerType) {
return []string{typ.String()}
}
// ...
}lockPath會檢測傳入的參數(shù)是否實現(xiàn)了Lock和Unlock方法，如果是則返回類型的信息。而vet會在AST上每個需要檢查的節(jié)點上調(diào)用lockPath函數(shù)(如賦值、函數(shù)調(diào)用等場景)。如果在這些會導(dǎo)致復(fù)制的場景中，發(fā)現(xiàn)了鎖結(jié)構(gòu)體的復(fù)制，則會報告給用戶:
func run(pass *analysis.Pass) (interface{}, error) {
// ...
// 需要檢查的節(jié)點
switch node := node.(type) {
// range語句
case *ast.RangeStmt:
checkCopyLocksRange(pass, node)
// 函數(shù)聲明
case *ast.FuncDecl:
checkCopyLocksFunc(pass, node.Name.Name, node.Recv, node.Type)
// 函數(shù)字面量(匿名函數(shù))
case *ast.FuncLit:
checkCopyLocksFunc(pass, "func", nil, node.Type)
// 調(diào)用表達(dá)式（Foo(xxx)）
case *ast.CallExpr:
checkCopyLocksCallExpr(pass, node)
// 賦值語句
case *ast.AssignStmt:
checkCopyLocksAssign(pass, node)
// 通用聲明(import/const/type/var)
case *ast.GenDecl:
checkCopyLocksGenDecl(pass, node)
// 復(fù)合常量({a,b,c})
case *ast.CompositeLit:
checkCopyLocksCompositeLit(pass, node)
// return語句
case *ast.ReturnStmt:
checkCopyLocksReturnStmt(pass, node)
// ...
}
// checkCopyLocksAssign 檢查賦值操作是否復(fù)制了一個鎖
func checkCopyLocksAssign(pass *analysis.Pass, as *ast.AssignStmt) {
for i, x := range as.Rhs {
// 如果等號右邊的結(jié)構(gòu)體里有字段實現(xiàn)了Lock/Unlock的話,就輸出警告信息
if path := lockPathRhs(pass, x); path != nil {
pass.ReportRangef(x, "assignment copies lock value to %v: %v", analysisutil.Format(pass.Fset, as.Lhs[i]), path)
}
}
}上面只列出了賦值操作的實現(xiàn)代碼，其它類型的檢查這里就不一一解釋了，感興趣的同學(xué)可以自行查看源碼。
結(jié)論
只要你的IDE會幫你運行go vet(目前主流的VSCode和GoLand都會自動幫你運行)，你就能通過這個機(jī)制來提醒他人，盡量避免復(fù)制結(jié)構(gòu)體。
如果你的結(jié)構(gòu)體也因為某些原因，不希望使用者復(fù)制，你也可以使用該機(jī)制來警告使用者:
定義一個實現(xiàn)了Lock和Unlock的結(jié)構(gòu)體
type noCopy struct{}
func (*noCopy) Lock() {}
func (*noCopy) Unlock() {}
將其放入你的結(jié)構(gòu)體中:
// Foo 代表你不希望別人復(fù)制的結(jié)構(gòu)體
type Foo struct {
noCopy noCopy
// ...
}或直接讓你的結(jié)構(gòu)體實現(xiàn)Lock和Unlock方法:
type Foo struct {
// ...
}
func (*Foo) Lock() {}
func (*Foo) Unlock() {}
這樣別人在嘗試復(fù)制Foo的時候，就會得到IDE的警告信息了。
到此這篇關(guān)于Golang實現(xiàn)不被復(fù)制的結(jié)構(gòu)體的方法的文章就介紹到這了,更多相關(guān)Golang結(jié)構(gòu)體內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
切片可以看成是數(shù)組的引用，切片的長度是它所包含的元素個數(shù)。切片的容量是從它的第一個元素到其底層數(shù)組元素末尾的個數(shù)。本文將通過示例詳細(xì)講講Go語言中切片的長度與容量的區(qū)別，需要的可以參考一下2022-11-11
緩存的大小是有限的,當(dāng)添加數(shù)據(jù)發(fā)現(xiàn)剩余緩存不夠時,需要淘汰緩存中的部分?jǐn)?shù)據(jù),本文主要介紹了Go語言實現(xiàn)lru淘汰策略和超時過期,感興趣的可以了解一下2024-02-02
這篇文章主要簡單介紹了Go語言中字符串和數(shù)組的使用方法和申明方式,需要的朋友可以參考下2015-01-01
這篇文章主要介紹了利用go語言判斷是否是完全二叉樹，當(dāng)一個節(jié)點存在右子節(jié)點但是不存在左子節(jié)點這顆樹視為非完全二叉樹，通過利用GO語言判斷來判斷出否是完全二叉樹，詳細(xì)內(nèi)容參考如下2022-05-05
Golang實現(xiàn)內(nèi)網(wǎng)穿透詳解
這篇文章主要為大家詳細(xì)介紹了Golang實現(xiàn)內(nèi)網(wǎng)穿透的相關(guān)知識,包括原理和代碼實現(xiàn),文中的示例代碼講解詳細(xì),有需要的小伙伴可以參考一下2024-11-11
這篇文章主要介紹了使用Golang如何實現(xiàn)簡易的令牌桶算法問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-07-07
Go語言追求簡潔優(yōu)雅，所以，Go語言不支持傳統(tǒng)的 try…catch…finally 這種異常，下面這篇文章主要給大家介紹了關(guān)于golang的異常處理機(jī)制，需要的朋友可以參考借鑒，下面來一起看看吧。2017-07-07
Go語言操作數(shù)據(jù)庫及其常規(guī)操作的示例代碼
這篇文章主要介紹了Go語言操作數(shù)據(jù)庫及其常規(guī)操作的示例代碼，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-04-04
如何解析golang中Context在HTTP服務(wù)中的角色
這篇文章主要介紹了如何解析golang中Context在HTTP服務(wù)中的角色問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-03-03
這篇文章主要介紹了Go語言中普通函數(shù)與方法的區(qū)別,以實例形式對比分析了普通函數(shù)與方法使用時的區(qū)別與相關(guān)技巧,需要的朋友可以參考下2015-02-02