目录

Go语言中的神奇函数init

前言

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

init函数的特性

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

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

init函数的执行顺序

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

下图来源于网络:

https://song-oss.oss-cn-beijing.aliyuncs.com/golang_dream/article/static/%E6%88%AA%E5%B1%8F2021-06-05%20%E4%B8%8A%E5%8D%889.55.15.png

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

  • 包加载优先级排在第一位,先层层递归进行包加载
  • 每个包中加载顺序为:const > var > init,首先进行初始化的是常量,然后是变量,最后才是init函数。针对包级别的变量初始化顺序,Go官方文档给出这样一个例子:
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
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解锁设计模式之单例模式,借用init函数的加载机制我们可以实现单例模式中的饿汉模式,具体怎么实现可以参考这篇文章,这里就不在写一遍了。

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
//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程序仅仅想要用一个packageinit执行,我们可以这样使用:import _ "test_xxxx",导入包的时候加上下划线就ok
  • 包级别的变量初始化、init函数执行,这两个操作都是在同一个goroutine中调用的,按顺序调用,一次一个包

总结

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

素质三连(分享、点赞、在看)都是笔者持续创作更多优质内容的动力!我是asong,我们下期见。

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

https://song-oss.oss-cn-beijing.aliyuncs.com/golang_dream/article/static/%E6%89%AB%E7%A0%81_%E6%90%9C%E7%B4%A2%E8%81%94%E5%90%88%E4%BC%A0%E6%92%AD%E6%A0%B7%E5%BC%8F-%E6%A0%87%E5%87%86%E8%89%B2%E7%89%88.png

推荐往期文章: