Uber Go 语言编程规范：避免调用init()方法

最新推荐文章于 2025-04-02 07:51:43 发布

DreamCatcher

最新推荐文章于 2025-04-02 07:51:43 发布

阅读量726

点赞数

分类专栏： Uber技术研究

本文链接：https://blog.csdn.net/hero_java/article/details/114602185

版权

Uber技术研究专栏收录该内容

48 篇文章

订阅专栏

尽可能的避免调用init()方法，当init()是不可避免或必需的时候，代码应该尝试做如下建议：

不管是程序的环境还是调用，必须是完全确定的。
避免依赖其他init()函数的调用顺序或副作用，虽然init()函数是顺序调用是众所周知的，但代码可能会发生变化，因此init()函数之间的关系可能会使代码变得脆弱且容易出错。
避免访问或操纵全局状态或环境状态，例如：服务器信息、环境变量、工作目录、程序参数/输入等。
避免I/O，包括文件系统、网络和系统调用。

不能满足这些需求的代码可能属于一个辅助函数，作为main()函数(或程序生命周期的其他地方)的一部分调用。特别地，如果库函数打算让其他程序使用，应该特别小心，确保完全确定性，不要执行“nit magic”。

Bad

type Foo struct {
    // ...
}

var _defaultFoo Foo

func init() {
    _defaultFoo = Foo{
        // ...
    }
}

Good

var _defaultFoo = Foo{
    // ...
}

// 或者，更好的, 为了可测性:

var _defaultFoo = defaultFoo()

func defaultFoo() Foo {
    return Foo{
        // ...
    }
}

Bad

type Config struct {
    // ...
}

var _config Config

//在init()函数中，操作环境信息，进行I/O操作
func init() {
    // Bad:  基于当前路径
    cwd, _ := os.Getwd()

    // Bad: I/O
    raw, _ := ioutil.ReadFile(
        path.Join(cwd, "config", "config.yaml"),
    )

    yaml.Unmarshal(raw, &_config)
}

Good

type Config struct {
    // ...
}

func loadConfig() Config {
    cwd, err := os.Getwd()
    // handle err

    raw, err := ioutil.ReadFile(
        path.Join(cwd, "config", "config.yaml"),
    )
    // handle err

    var config Config
    yaml.Unmarshal(raw, &config)

    return config
}

考虑到上述情况，在一些场景，init()函数可能是更可取的或者说是必要的，主要包括: