Go main() 函数

在前面的章节中,我们编写每一个可运行的示例时,都会写上 func main()。在 Go 语言中,main() 函数是一个非常特殊的函数,它是整个程序的唯一执行入口。

无论一个项目里包含多少个源文件和自定义函数,程序启动时总是从 main() 函数开始执行。

main() 函数的语法规则

在 Go 语言中,func main() 的定义格式是完全固定的,函数名后面的小括号内外都必须保持为空。

语法:

package main

func main() {
    // 程序入口代码
}

说明:

编写 main() 函数时,我们需要遵守以下 3 条规则:

  • 必须位于 main 包下:func main() 只有写在 package main 声明的源文件中,才会被识别为程序入口。如果错写成其他包名,运行时会直接报 cannot run non-main package(无法运行非 main 包)错误。
  • 不能接收任何参数:main() 函数名后面的小括号 () 必须为空,不能在里面声明任何形参。
  • 不能声明返回值:main() 的小括号后面不能写返回值类型,函数体内也不能返回具体数值。如果只是想提前结束 main() 函数,可以使用不带返回值的 return 语句,也就是单独写一个 return。

另外,同一个 main 包中只能定义一个 main() 函数。很多初学者在本地练习时,会把 demo1.go 和 demo2.go 放在同一个文件夹里,且都写了 func main()。这时执行 go run . 就会报 main redeclared in this block(main 函数重复声明)错误。

遇到这种情况很好解决:要么在运行时明确指定单个文件名,例如执行 go run demo1.go;要么把不同的练习程序放进各自独立的子文件夹里。

如果小伙伴们之前学过 C 语言或 Java,可能会习惯在 main() 小括号里写参数,或者在末尾写 return 0。但在 Go 语言中这些写法都不允许,我们固定写成 func main() 就可以了。

main() 函数的执行流程与退出

下面我们结合具体代码,看看程序的启动执行顺序以及中途退出的方式。

示例 1:程序的执行顺序

package main

import "fmt"

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

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

func main() {
    fmt.Println("1. 程序从 main 函数开始执行")
    step1()
    step2()
    fmt.Println("4. main 函数执行结束,程序退出")
}

运行结果如下。

1. 程序从 main 函数开始执行
2. 执行 step1 函数
3. 执行 step2 函数
4. main 函数执行结束,程序退出

分析:

从运行结果可以看出,虽然 step1() 和 step2() 定义在 main() 上方,但程序启动时并不会先运行它们,而是直接从 func main() 的第 1 行开始往下执行。

在 main() 函数内部,我们按顺序调用了 step1() 和 step2()。当 main() 函数最后一行代码执行完毕后,整个 Go 程序也就正常结束了。

如果我们尝试像其他语言那样给 main() 函数加上参数或返回值类型,会发生什么情况呢?下面我们来看一个报错示例。

示例 2:错误的 main() 写法

package main

import "fmt"

func main(args []string) int {
    fmt.Println("Hello, Go!")
    return 0
}

运行结果如下。

(报错)func main must have no arguments and no return values

分析:

编译时程序直接报错了,这句英文报错的意思是 “main 函数不能有任何参数和返回值”。因此平时编写主入口函数时,我们固定保持 func main() { ... } 的形式即可。

既然 main() 函数不能写 return 0 或 return 1,那如果我们想在中途立即终止整个程序并返回退出状态码,应该怎么做呢?

这时我们可以导入专门负责操作系统交互的 os 标准库包,调用其中的 os.Exit() 函数。其中,传入 0 表示程序正常退出,传入 1 等非零整数表示程序异常退出。

示例 3:使用 os.Exit() 终止程序

package main

import (
    "fmt"
    "os"
)

func main() {
    defer fmt.Println("这行 defer 语句不会执行")
    fmt.Println("程序即将立即退出")
    os.Exit(0)
    fmt.Println("这行普通代码也不会执行")
}

运行结果如下。

程序即将立即退出

分析:

在这个例子中,我们使用 import ( ... ) 圆括号分组同时导入了 fmt 和 os 两个包。当程序执行到 os.Exit(0) 时,整个程序会立即终止退出,后面的普通打印代码不会再执行。

小伙伴们要特别留意 os.Exit() 与空 return 的区别:如果在 main() 函数中执行空 return,函数退出前依然会正常执行前面写好的 defer 语句。但如果调用了 os.Exit(),程序会直接强行终止,连前面写好的 defer 语句也不会执行。

因此在实际开发中,我们一般让 main() 函数自然执行到末尾,或者用空 return 提前返回即可。只有在启动时缺少关键配置等严重出错场景下,需要立刻关停程序并返回 os.Exit(1) 这类非零状态码时,才需要调用 os.Exit()。

常见问题

1. main() 函数不能写形参,如果需要在启动程序时传入外部参数该怎么办?

虽然 main() 的小括号内不能声明形参,但我们在终端启动程序时传入的命令行参数,都会由系统自动保存在 os.Args 切片中。需要读取外部参数时,导入 os 包直接访问 os.Args 即可。

2. 如果希望在 main() 函数运行之前先自动完成初始化工作,应该怎么做?

比如加载配置文件或注册驱动这类前置准备工作,Go 语言专门提供了 init() 函数来处理。我们不需要手动调用它,程序启动后系统会自动在 main() 函数执行之前先运行 init() 函数。

上一篇:

下一篇:

给站长反馈

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

邮箱:lvyenet@vip.qq.com

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