Go 包

在 Go 语言中,我们使用 “包(package)” 来分门别类地组织和管理源代码。简单来说,一个文件夹就是一个包。把不同功能的代码放进不同的包里,项目结构会清晰很多,后期维护起来也更加方便。

小伙伴们可以把 Go 标准库里的各个包想象成不同功能的 “工具箱”。比如 fmt 包负责输入输出,strings 包负责处理字符串,math 包负责数学计算。需要用到哪个功能,先通过 import 导入对应的包,再按 包名.函数名() 调用就可以了。

声明包与导入包

在 Go 语言中,每一个 .go 源文件的开头都必须使用 package 关键字声明它属于哪一个包。当我们需要用到其他包里的功能时,再使用 import 关键字把对应的包导入进来。

语法:

package 包名

import (
    "包路径1"
    "包路径2"
)

说明:

package 包名 必须写在每个 .go 源文件的非注释第一行。如果当前文件包含程序的入口 main() 函数,那么包名必须固定写成 package main,表示这是一个可独立运行的入口包。

同一个文件夹下的所有 .go 文件必须声明相同的 package 名称,不能混放两个不同的包。同时导入多个包时,推荐使用 import (...) 的小括号分组写法,每行写一个双引号包路径,行尾不需要加逗号或分号。

这里还要留意一点:import 双引号里填写的是 “包路径”,而在代码中调用时,默认使用的是路径最后一段的包名。比如导入 "fmt" 时直接通过 fmt 调用,导入带层级的 "math/rand" 时默认就通过 rand 调用。

示例 1:批量导入多个包

package main

import (
    "fmt"
    "math"
    "strings"
)

func main() {
    fmt.Println(math.Abs(-10))
    fmt.Println(strings.ToUpper("go"))
}

运行结果如下。

10
GO

分析:

在这个例子中,我们在文件开头通过 import (...) 一次性导入了 3 个标准库包。随后在 main() 函数中,math.Abs(-10) 表示求 -10 的绝对值,strings.ToUpper("go") 则表示将字符串转为大写。

对于上面这个例子来说,下面 2 种导入方式是等价的。

// 方式 1(推荐)
import (
    "fmt"
    "math"
    "strings"
)

// 方式 2
import "fmt"
import "math"
import "strings"

其中,方式 1 省去了重复书写 import 关键字的麻烦,代码看起来更加整洁。只要同时导入两个或以上的包,我们都推荐使用方式 1。

提示: 平时在 VSCode 或 GoLand 中写代码时,我们直接写出 fmt.Println 或 strings.ToUpper 并保存文件(Ctrl + S)即可。编辑器通常会自动在顶部补全或清理对应的 import 语句,并按字母顺序排好版。

包别名与匿名导入

有时候,同一个文件需要同时导入 "math/rand" 和 "crypto/rand",两者的默认包名都叫 rand,直接调用就会产生重名冲突。

另外,有时我们只想让某个包在程序启动时自动完成初始化工作,并不需要在当前文件里直接调用它的函数。遇到这两种情况,我们可以在导入包时指定 “包别名”,或者在包路径前加上下划线(_)进行 “匿名导入”。

语法:

import (
    别名 "包路径"
    _ "包路径"
)

说明:

别名 "包路径" 表示给导入的包起一个自定义名称,别名写在双引号包路径前面,中间用空格隔开。指定别名之后,当前文件中就必须改用这个新别名来调用包里的内容。

_ "包路径" 中的下划线(_)是空白标识符,表示匿名导入该包。匿名导入只会触发该包内部的初始化操作,不会在当前文件中引入包名,因此即便代码里没有调用它也不会报错。

示例 2:指定包别名

package main

import (
    f "fmt"
)

func main() {
    f.Println("欢迎来到绿叶网!")
}

运行结果如下。

欢迎来到绿叶网!

分析:

f "fmt" 表示在导入 fmt 包的同时,给它起了一个简短的别名 f。因此在 main() 函数中输出内容时,我们就需要使用 f.Println(),在当前文件中不能再使用原来的包名 fmt 了。

这里拿大家最熟悉的 fmt 举例,只是为了方便看清语法。在实际开发中,像 fmt 这样简短的标准库没必要改名。一般只有在原包名太长,或者遇到同名包冲突时,我们才会给其中一个包起别名。比如:

import (
    "math/rand"
    crand "crypto/rand"    // 起别名避免重名冲突
)

除了起别名,我们再来看看如何使用下划线进行匿名导入。

示例 3:下划线匿名导入

package main

import (
    "fmt"
    _ "math"
)

func main() {
    fmt.Println("匿名导入成功")
}

运行结果如下。

匿名导入成功

分析:

在 Go 语言中,如果按普通方式写了 import "math",却在后面的代码里一次都没用到 math 包,编译器就会直接报错。而在 "math" 前面加上下划线写成 _ "math" 后,即使我们在 main() 函数里没有调用它,程序依然可以正常编译运行。

既然代码里不直接调用,为什么要导入这个包呢?这主要是为了自动触发该包内部的 init() 函数。比如以后连接数据库时,我们就会通过 _ 匿名导入数据库驱动包,让它在程序启动时自动完成驱动注册。

这里借用标准库的 math 包演示,只是为了看清匿名导入不会报未使用错误。至于被导入包在启动时具体怎么自动执行初始化,我们在后面讲解 init() 时会完整演示。

除了上面介绍的 3 种方式之外,Go 语法中还有一种使用英文点号(.)的 “点导入” 写法。常见的 4 种导入方式如下表所示。

import 导入方式
导入方式 语法 说明
标准导入 import "fmt" 通过原包名调用(最常用)
别名导入 import f "fmt" 指定新别名,解决重名冲突
匿名导入 import _ "fmt" 仅触发包内初始化,不直接调用
点导入 import . "fmt" 省略包名前缀直接调用(不推荐)

上表中的点导入虽然可以省掉 fmt. 前缀直接写 Println(),但一旦导入的包变多,阅读代码时就很难分清某个函数来自哪个包。因此在日常写代码时,我们不推荐使用点导入。

包的导出与跨包访问规则

Go 语言没有像 Java 或 C++ 那样提供 public、private 权限关键字,而是直接通过标识符的 “首字母大小写” 来决定包内的成员能不能被外部包访问。

这里大家要先分清 “同一个包内部” 和 “跨包访问” 的区别。在同一个包内部,无论函数或变量的首字母是大写还是小写,都可以直接互相访问。只有跨包访问时,才需要遵循以下 2 条规则(如下图所示):

  • 首字母大写(公开导出):包内的变量、常量、函数、结构体以及结构体字段,只要名称首字母是大写,就属于公开成员。比如 fmt.Println 和 math.Pi,其他包导入后都可以直接访问。
  • 首字母小写(包内私有):如果名称首字母是小写,就属于包内私有成员,只能在它自己所在的包内部使用,外部包无法直接访问。

Go 包首字母大小写的跨包访问权限

示例 4:访问包中的公开成员

package main

import (
    "fmt"
    "math"
)

func main() {
    fmt.Println(math.Pi)
    fmt.Println(math.Sqrt(16))
}

运行结果如下。

3.141592653589793
4

分析:

在标准库 math 包中,圆周率常量 Pi 和求平方根函数 Sqrt() 的首字母都是大写的,属于公开导出的成员。因此我们在 main 包中可以直接通过 math.Pi 和 math.Sqrt(16) 访问它们。

在其他编程语言中,圆周率常量一般写成全大写的 PI,而在 Go 语言的 math 包里却是首字母大写、第二个字母小写的 Pi。不管后面几个字母是大写还是小写,小伙伴们只需要看第一个字母,记住 “首字母大写才能跨包访问” 就不会出错。

// 正确方式
fmt.Println(math.Pi)
fmt.Println(math.Sqrt(16))

// 错误方式
fmt.Println(math.pi)
fmt.Println(math.sqrt(16))

Go 语言严格区分大小写,math 包并没有导出小写的 pi 或 sqrt。一旦把首字母误写成小写,编译器就会认为我们在尝试访问未导出的包内成员而直接报错。

需要注意的是,这条规则对结构体同样生效。后面我们自己编写自定义包时,不仅结构体类型名的首字母要大写,内部需要给外部读写的字段名首字母也必须大写。如果某个字段的首字母是小写,外部包就算拿到了这个结构体实例,也无法访问该字段。

常见问题

1. 为什么导入了未使用的包,Go 编译器会直接报错?

如果在文件顶部写了 import "math",但代码里暂时还没用到它,编译时就会报错 imported and not used: "math"。这句话的意思是导入了 "math" 包却没有使用。

这是 Go 语言专门设计的语法检查规则。在大型工程项目中,随着代码不断修改,很容易留下许多不再使用的导入语句。如果放任不管,不仅会让文件顶部堆满无用代码,还会拖慢整个项目的编译速度。因此 Go 语言从语法层面禁止保留未使用的包和局部变量,帮我们让代码始终保持干净整洁。

2. 一个 .go 源文件中可以同时声明多个 package 吗?

不可以。每一个 .go 源文件只能属于一个包,因此文件开头只能写一条 package 声明语句。此外,同一个文件夹下的所有 .go 源文件也必须声明相同的包名。如果需要定义不同的包,就必须把它们分别放进不同的子文件夹中。

上一篇:

下一篇:

给站长反馈

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

邮箱:lvyenet@vip.qq.com

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