Go init() 函数

在 Go 程序启动时,有时我们需要在正式运行主逻辑之前先完成一些准备工作,比如加载配置文件、读取系统设置或注册数据库驱动。这就好比一家餐厅正式开门迎客之前,后厨需要先自动把火点着、把食材备好。

除了作为主入口的 main() 函数之外,Go 语言还提供了一个特殊的 init() 函数。其中,init 是英文 “initialize(初始化)” 的缩写。它不需要我们手动调用,程序启动后会自动在 main() 之前运行。

init() 函数的基本用法

在 Go 语言中,定义 init() 函数的写法跟定义无参普通函数一样,但它有着严格的语法限制。

语法:

func init() {
    // 初始化代码
}

说明:

init() 函数和 main() 函数在形式上非常相似,小伙伴们在使用时需要注意以下 3 点:

  • init() 函数没有任何参数,也没有任何返回值。
  • init() 函数由系统自动触发执行,不能在代码中手动调用。
  • main() 函数只能在 package main 中定义一个,而 init() 函数可以在任意包中定义多个。

示例 1:自动执行 init() 函数

package main

import "fmt"

func init() {
    fmt.Println("1. init() 自动执行:正在加载配置...")
}

func main() {
    fmt.Println("2. main() 开始执行")
}

运行结果如下。

1. init() 自动执行:正在加载配置...
2. main() 开始执行

分析:

从运行结果可以看出,虽然我们在 main() 函数里没有调用 init(),但系统在程序启动时还是先执行了 init() 里的输出语句,随后才进入 main() 函数。

需要注意的是,init() 函数只能由系统自动触发,千万不要在 main() 或其他函数里手动调用它。下面这种写法就是错误的。

func main() {
    init()
}

如果在代码中手动调用 init(),编译器会直接报错 undefined: init,意思是找不到可调用的普通函数 init。同样地,如果给 init() 加上参数或返回值,编译时也会直接报错。

单文件内的初始化顺序

既然 init() 函数是在 main() 函数之前自动执行的,如果当前源文件中还定义了包级别的全局变量,它们之间到底谁先执行呢?

在同一个 .go 源文件中,Go 语言固定按照以下 3 步先后顺序完成启动:

  • 初始化包级别的常量和全局变量。
  • 自动执行 init() 初始化函数。
  • 进入 main() 主函数执行主逻辑。

我们通过一个例子来验证这 3 个阶段的执行顺序。

示例 2:验证单文件内的执行顺序

package main

import "fmt"

func getNum() int {
    fmt.Println("第 1 步:初始化全局变量")
    return 100
}

// 定义包级全局变量
var globalNum = getNum()

func init() {
    fmt.Println("第 2 步:执行 init() 函数,globalNum =", globalNum)
    globalNum = 200
}

func main() {
    fmt.Println("第 3 步:执行 main() 函数,globalNum =", globalNum)
}

运行结果如下。

第 1 步:初始化全局变量
第 2 步:执行 init() 函数,globalNum = 100
第 3 步:执行 main() 函数,globalNum = 200

分析:

在这个例子中,我们特意让全局变量 globalNum 通过调用 getNum() 来赋初值,方便直观看到它的初始化时机。程序启动后最先执行 var globalNum = getNum(),打印第 1 步提示并将 globalNum 设为 100。

等全局变量准备就绪后,系统会自动执行 init() 函数。此时读取到的 globalNum 已经是 100,随后我们在 init() 内部将它修改成了 200。

最后进入 main() 函数时,打印出来的就是修改后的 200。正因为包级变量总是在 init() 之前初始化完毕,所以我们可以在 init() 里放心地读取或修改这些全局变量。

定义多个 init() 函数

在 Go 语言中,普通函数是不允许重名的。如果在同一个包里写两个同名的普通函数,编译器会报重复定义错误。但 init() 函数是一个特例:不仅同一个包的不同文件里可以各自写 init() 函数,就连同一个 .go 源文件里也允许定义多个 init() 函数。

示例 3:定义多个 init() 函数

package main

import "fmt"

func init() {
    fmt.Println("执行第 1 个 init() 函数")
}

func init() {
    fmt.Println("执行第 2 个 init() 函数")
}

func main() {
    fmt.Println("执行 main() 函数")
}

运行结果如下。

执行第 1 个 init() 函数
执行第 2 个 init() 函数
执行 main() 函数

分析:

当同一个 .go 源文件中包含多个 init() 函数时,系统会按照它们在代码中 “从上到下” 的编写顺序依次执行,全部执行完之后再进入 main() 函数。小伙伴们可以把上面两个 init() 函数的上下位置对调一下试试,看看输出结果是不是也跟着反过来了。

提示: 如果同一个包下有多个源文件且各自写了 init(),系统通常会按文件名的字母顺序依次执行。不过在日常写项目时,我们不要依赖文件间的先后顺序来安排逻辑,而且建议每个源文件最多只写一个 init(),也不要在里面塞入过于复杂的业务代码。

跨包导入时的执行顺序

如果 main 包通过 import 导入了其他包,而其他包里面也有全局变量和 init() 函数,执行顺序又是怎样的呢?

其实规则非常直观:因为 main 包依赖被导入的包,所以系统一定会 “先把被导入的包初始化完毕,最后再初始化 main 包”。

假设当前项目中有一个被导入的自定义包 db,关于子包的具体目录写法后面章节会详细介绍。我们先来看看被导入的 db/db.go 文件结构:

// db/db.go
package db

var DriverName = "mysql"    // (1) 初始化 db 全局变量

func init() {
    // (2) 执行 db 的 init()
}

接着,主入口文件 main.go 导入了上面的 db 包:

// main.go
package main

import "myproject/db"

var AppName = "shop"    // (3) 初始化 main 全局变量

func init() {
    // (4) 执行 main 的 init()
}

func main() {
    // (5) 最后执行 main()
}

把上面这两个文件连起来看,程序启动时的完整初始化顺序如下图所示。

Go 跨包全局变量与 init() 函数的执行顺序

也就是说,系统会依次执行:db 包全局变量 → db 包的 init() → main 包全局变量 → main 包的 init() → main() 函数。

另外还要留意一点:哪怕同一个包在项目中被多个文件重复导入,这个包里的 init() 函数在整个程序运行期间也 “只会执行一次”,不会因为多写了几次 import 就重复初始化。

弄清楚跨包执行顺序后,大家再回想一下上一节学过的匿名导入,就很容易明白它的用途了。有时我们导入数据库驱动等外部包,只是为了让它在启动时自动执行 init() 完成注册,并不需要直接调用包里的函数。这时写成 import _ "包路径" 就非常合适。

注意: 在跨包导入时,Go 语言严格禁止两个包之间互相导入。小伙伴们千万不要让包 A 导入包 B,同时又让包 B 导入包 A。否则编译器会直接报 import cycle not allowed 错误,提示不允许循环导入。

上一篇:

下一篇:

给站长反馈

绿叶网正在不断完善中,小伙伴们如果发现任何问题,还望多多给站长反馈,谢谢!

邮箱:lvyenet@vip.qq.com

「绿叶网」服务号
绿叶网服务号放大
关注服务号,微信也能看教程。
绿叶网服务号