神奇的init函数

迷南。 2022-10-05 07:55 227阅读 0赞

## 前言 ##

> 哈喽，兄弟们，我是`asong`。今天与大家聊一聊`Go`语言中的神奇函数`init`，为什么叫他神奇函数呢？因为该函数可以在所有程序执行开始前被调用，并且每个包下可以有多个`init`函数。这个函数使用起来比较简单，但是你们知道他的执行顺序是怎样的嘛？本文我们就一起来解密。

## `init`函数的特性 ##

先简单介绍一下`init`函数的基本特性：

*  `init`函数先于`main`函数自动执行
 *  每个包中可以有多个`init`函数，每个包中的源文件中也可以有多个`init`函数
 *  `init`函数没有输入参数、返回值，也未声明，所以无法引用
 *  不同包的`init`函数按照包导入的依赖关系决定执行顺序
 *  无论包被导入多少次，`init`函数只会被调用一次，也就是只执行一次

## `init`函数的执行顺序 ##

我在刚学习`init`函数时就对他的执行顺序很好奇，在谷歌上搜了几篇文章，他们都有一样的图：

下图来源于网络：

![de67600f97783656e33d30051d99f044.png][] 截屏2021-06-05 上午9.55.15

这张图片很清晰的反应了`init`函数的加载顺序：

*  包加载优先级排在第一位，先层层递归进行包加载
 *  每个包中加载顺序为：`const` > `var` > `init`，首先进行初始化的是常量，然后是变量，最后才是`init`函数。针对包级别的变量初始化顺序，`Go`官方文档给出这样一个例子：

var (
     a = c + b  // == 9
     b = f()    // == 4
     c = f()    // == 5
     d = 3      // == 5 after initialization has finished
    )
    
    func f() int {
     d++
     return d
    }

变量的初始化按出现的顺序从前往后进行，假若某个变量需要依赖其他变量，则被依赖的变量先初始化。所以这个例子中，初始化顺序是 `d` \-> `b` \-> `c` \-> `a`。

上图只是表达了`init`函数大概的加载顺序，有些细节我们还是不知道的，比如：当前包下有多个`init`函数，按照什么顺序执行，当前源文件下有多个`init`函数，这又按照什么顺序执行呢？本来想写个例子挨个验证一下的，后来一看`Go`官方文档中都有说明，也就没有必要再写一个例子啦，直接说结论吧：

*  如果当前包下有多个`init`函数，首先按照源文件名的字典序从前往后执行。
 *  若一个文件中出现多个`init`函数，则按照出现顺序从前往后执行。

前面说的有点乱，对`init`函数的加载顺序做一个小结：

> 从当前包开始，如果当前包包含多个依赖包，则先初始化依赖包，层层递归初始化各个包，在每一个包中，按照源文件的字典序从前往后执行，每一个源文件中，优先初始化常量、变量，最后初始化`init`函数，当出现多个`init`函数时，则按照顺序从前往后依次执行，每一个包完成加载后，递归返回，最后在初始化当前包！

## `init`函数的使用场景 ##

还记得我之前的这篇文章吗：[go解锁设计模式之单例模式][go]，借用`init`函数的加载机制我们可以实现单例模式中的饿汉模式，具体怎么实现可以参考这篇文章，这里就不在写一遍了。

`init`函数的使用场景还是挺多的，比如进行服务注册、进行数据库或各种中间件的初始化连接等。`Go`的标准库中也有许多地方使用到了`init`函数，比如我们经常使用的`pprof`工具，他就使用到了`init`函数，在`init`函数里面进行路由注册：

//go/1.15.7/libexec/src/cmd/trace/pprof.go
    func init() {
     http.HandleFunc("/io", serveSVGProfile(pprofByGoroutine(computePprofIO)))
     http.HandleFunc("/block", serveSVGProfile(pprofByGoroutine(computePprofBlock)))
     http.HandleFunc("/syscall", serveSVGProfile(pprofByGoroutine(computePprofSyscall)))
     http.HandleFunc("/sched", serveSVGProfile(pprofByGoroutine(computePprofSched)))
    
     http.HandleFunc("/regionio", serveSVGProfile(pprofByRegion(computePprofIO)))
     http.HandleFunc("/regionblock", serveSVGProfile(pprofByRegion(computePprofBlock)))
     http.HandleFunc("/regionsyscall", serveSVGProfile(pprofByRegion(computePprofSyscall)))
     http.HandleFunc("/regionsched", serveSVGProfile(pprofByRegion(computePprofSched)))
    }

这里就不扩展太多了，更多标准库中的使用方法大家可以自己去探索一下。

在这最后总结一下使用`init`要注意的问题吧：

*  编程时不要依赖`init`的顺序
 *  一个源文件下可以有多个`init`函数，代码比较长时可以考虑分多个`init`函数
 *  复杂逻辑不建议使用`init`函数，会增加代码的复杂性，可读性也会下降
 *  在`init`函数中也可以启动`goroutine`，也就是在初始化的同时启动新的`goroutine`，这并不会影响初始化顺序
 *  `init`函数不应该依赖任何在`main`函数里创建的变量，因为`init`函数的执行是在`main`函数之前的
 *  `init`函数在代码中不能被显示的调用，不能被引用（赋值给函数变量），否则会出现编译错误。
 *  导入包不要出现循环依赖，这样会导致程序编译失败
 *  `Go`程序仅仅想要用一个`package`的`init`执行，我们可以这样使用：`import _ "test_xxxx"`，导入包的时候加上下划线就`ok`了
 *  包级别的变量初始化、`init`函数执行，这两个操作都是在同一个`goroutine`中调用的，按顺序调用，一次一个包

## 总结 ##

好啦，这篇文章到这里就结束了，本身`init`函数就很好理解，写这篇文章的目的就是让大家了解他的执行顺序，这样在日常开发中才不会写出`bug`。希望本文对大家有所帮助，我们下期见！

**素质三连（分享、点赞、在看）都是笔者持续创作更多优质内容的动力！我是`asong`，我们下期见。**

**创建了一个Golang学习交流群，欢迎各位大佬们踊跃入群，我们一起学习交流。入群方式：关注公众号获取。更多学习资料请到公众号领取。**

![fe7f0a013389faf73f0bdc7515e80f00.png][]

推荐往期文章：

*  [Go语言如何实现可重入锁？][Go]
 *  [Go语言中new和make你使用哪个来分配内存？][Go_new_make]
 *  [源码剖析panic与recover，看不懂你打我好了！][panic_recover]
 *  [空结构体引发的大型打脸现场][Link 1]
 *  [Leaf—Segment分布式ID生成系统（Golang实现版本）][Leaf_Segment_ID_Golang]
 *  [面试官：两个nil比较结果是什么？][nil]
 *  [面试官：你能用Go写段代码判断当前系统的存储方式吗?][Go 1]
 *  [如何平滑切换线上Elasticsearch索引][Elasticsearch]

[de67600f97783656e33d30051d99f044.png]: /images/20221005/d3d10e27e530479b91a88afa11d248cb.png
[go]: https://mp.weixin.qq.com/s?__biz=MzIzMDU0MTA3Nw%3D%3D&idx=2&mid=2247483947&scene=21&sn=32442f6f855162c2185a10e4329c74fa#wechat_redirect
[fe7f0a013389faf73f0bdc7515e80f00.png]: /images/20221005/77e27a91d3c04c82ae355a7ae6209bb6.png
[Go]: https://mp.weixin.qq.com/s?__biz=MzIzMDU0MTA3Nw%3D%3D&idx=1&mid=2247484865&scene=21&sn=2a1a03f1c3de524a342a35c6d03faf86#wechat_redirect
[Go_new_make]: https://mp.weixin.qq.com/s?__biz=MzIzMDU0MTA3Nw%3D%3D&idx=1&mid=2247484765&scene=21&sn=a04aec50b62d8c181ab4721b7029d17b#wechat_redirect
[panic_recover]: https://mp.weixin.qq.com/s?__biz=MzIzMDU0MTA3Nw%3D%3D&idx=1&mid=2247484460&scene=21&sn=0838818da3a456f409f70dd321ffa2e6#wechat_redirect
[Link 1]: https://mp.weixin.qq.com/s?__biz=MzIzMDU0MTA3Nw%3D%3D&idx=1&mid=2247484616&scene=21&sn=48ca0a39b351a7a66cc96b9827801e29#wechat_redirect
[Leaf_Segment_ID_Golang]: https://mp.weixin.qq.com/s?__biz=MzIzMDU0MTA3Nw%3D%3D&idx=1&mid=2247484313&scene=21&sn=6859d5eec70a1b3844f3bd2fc430742c#wechat_redirect
[nil]: https://mp.weixin.qq.com/s?__biz=MzIzMDU0MTA3Nw%3D%3D&idx=1&mid=2247484732&scene=21&sn=c2b5c4efdf9e7e8bc5c8d00962af961f#wechat_redirect
[Go 1]: https://mp.weixin.qq.com/s?__biz=MzIzMDU0MTA3Nw%3D%3D&idx=1&mid=2247484641&scene=21&sn=fe09b9f0f0c29d6af6e398c420ef656c#wechat_redirect
[Elasticsearch]: https://mp.weixin.qq.com/s?__biz=MzIzMDU0MTA3Nw%3D%3D&idx=1&mid=2247484667&scene=21&sn=747e6d775f807920f939737f5a0f08a6#wechat_redirect