Golang实现不被复制的结构体的方法

2023-05-14 05:05:25 复制结构不被

不允许复制的结构体

sync包中的许多结构都是不允许拷贝的，比如sync.Cond,sync.WaitGroup,sync.Pool, 以及sync包中的各种锁，因为它们自身存储了一些状态(比如等待者的数量)，如果你尝试复制这些结构体:

var wg1 sync.WaitGroup
wg2 := wg1 // 将 wg1 复制一份，命名为 wg2
// ...

那么你将在你的 IDE 中看到一个醒目的警告:

assignment copies lock value to wg2: sync.WaitGroup contains sync.noCopy

IDE是如何实现这一点的呢？我们自己又能否利用这一机制来告诉别人，不要拷贝某个结构体呢？

（懒得看原理，只想知道怎么用，可以直接下划至结论部分）

实现原理

大部分编辑器/IDE都会在你的代码上运行Go vet,vet是Go官方提供的静态分析工具，我们刚刚得到的提示信息就是vet分析代码后告诉我们的。vet的实现在Go源码的cmd/vet中,里面注册了很多不同类型的分析器，其中copylock这个分析器会检查实现了Lock和Unlock方法的结构体是否被复制。

copylock Analyser在cmd/vet中注册，具体实现代码在golang.org/x/tools/go/analysis/passes/copylock/copylock.go中, 这里只摘抄部分核心代码进行解释:

var lockerType *types.Interface

func init() {
    //...
    methods := []*types.Func{
        types.NewFunc(token.NoPos, nil, "Lock", nullary),
        types.NewFunc(token.NoPos, nil, "Unlock", nullary),
    }
    // Locker 结构包括了 Lock 和 Unlock 两个方法
    lockerType = types.NewInterface(methods, nil).Complete()
}

init函数中把包级别的全局变量lockerType进行了初始化，lockerType内包含了两个方法: Lock和Unlock, 只有实现了这两个方法的结构体才是copylock Analyzer要处理的对象。

// lockPath 省略了参数部分，只保留了最核心的逻辑，
// 用来检测某个类型是否实现了Locker接口(Lock和Unlock方法)
func lockPath(...) typePath {
    // ...
    // 如果传进来的指针类型实现了Locker接口, 就返回这个类型的信息
    if types.Implements(types.NewPointer(typ), lockerType) && !types.Implements(typ, lockerType) {
        return []string{typ.String()}
    }
    // ...
}

lockPath会检测传入的参数是否实现了Lock和Unlock方法，如果是则返回类型的信息。而vet会在AST上每个需要检查的节点上调用lockPath函数(如赋值、函数调用等场景)。如果在这些会导致复制的场景中，发现了锁结构体的复制，则会报告给用户:

func run(pass *analysis.Pass) (interface{}, error) {
    // ...
    // 需要检查的节点
    switch node := node.(type) {
    // range语句
    case *ast.RangeStmt:
        checkCopyLocksRange(pass, node)
    // 函数声明
    case *ast.FuncDecl:
        checkCopyLocksFunc(pass, node.Name.Name, node.Recv, node.Type)
    // 函数字面量(匿名函数)
    case *ast.FuncLit:
        checkCopyLocksFunc(pass, "func", nil, node.Type)
    // 调用表达式（Foo(xxx)）
    case *ast.CallExpr:
        checkCopyLocksCallExpr(pass, node)
    // 赋值语句
    case *ast.AssignStmt:
        checkCopyLocksAssign(pass, node)
    // 通用声明(import/const/type/var)
    case *ast.GenDecl:
        checkCopyLocksGenDecl(pass, node)
    // 复合常量({a,b,c})
    case *ast.CompositeLit:
        checkCopyLocksCompositeLit(pass, node)
    // return语句
    case *ast.ReturnStmt:
        checkCopyLocksReturnStmt(pass, node)
    // ...
}

// checkCopyLocksAssign 检查赋值操作是否复制了一个锁
func checkCopyLocksAssign(pass *analysis.Pass, as *ast.AssignStmt) {
    for i, x := range as.Rhs {
        // 如果等号右边的结构体里有字段实现了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)
        }
    }
}

上面只列出了赋值操作的实现代码，其它类型的检查这里就不一一解释了，感兴趣的同学可以自行查看源码。

结论

只要你的IDE会帮你运行go vet(目前主流的vscode和GoLand都会自动帮你运行)，你就能通过这个机制来提醒他人，尽量避免复制结构体。

如果你的结构体也因为某些原因，不希望使用者复制，你也可以使用该机制来警告使用者:

定义一个实现了Lock和Unlock的结构体

type noCopy struct{}

func (*noCopy) Lock()   {}
func (*noCopy) Unlock() {}

将其放入你的结构体中:

// Foo 代表你不希望别人复制的结构体
type Foo struct {
    noCopy noCopy
    // ...
}

或直接让你的结构体实现Lock和Unlock方法:

type Foo struct {
    // ...
}

func (*Foo) Lock()   {}
func (*Foo) Unlock() {}

这样别人在尝试复制Foo的时候，就会得到IDE的警告信息了。

到此这篇关于Golang实现不被复制的结构体的方法的文章就介绍到这了,更多相关Golang结构体内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！

相关文章

Golang实现不被复制的结构体的方法

目录

不允许复制的结构体

实现原理

结论