Go语言基础之包管理

在工程化的 Go 语言开发项目中，Go 语言的源码复用是建立在包（package）基础之上的。

本文介绍了 Go 语言中如何定义包、如何导出包的内容及如何导入其他包。

1. 概念

  1. 包（package）是多个 Go 源码的集合，是一种高级的代码复用方案。

  2. Go语言的包借助了目录树的组织形式，并实现了java中的封装思想。

  3. 像 fmt、os、io 等这样具有常用功能的内置包在 Go语言中有 150 个以上，它们被称为标准库，大部分（一些底层的除外）内置于 Go 本身。

2. 包的定义

源文件的第一行有效代码必须是package pacakgeName语句，通过该语句声明自己所在的包。

我们还可以根据自己的需要创建自己的包。一个包可以简单理解为一个存放.go文件的文件夹。 该文件夹下面的所有go文件都要在代码的第一行添加如下代码，声明该文件归属的包。

package 包名

注意事项：

  • 一个文件夹下面直接包含的文件只能归属一个package，同样一个package的文件不能在多个文件夹下。

  • 包名可以不和文件夹的名字一样，包名不能包含 - 符号。

  • 包名为main的包为应用程序的入口包，这种包编译后会得到一个可执行文件，而编译不包含main包的源代码则不会得到可执行文件。

包的习惯用法：

  • 包名一般是小写的，使用一个简短且有意义的名称。

  • 包名一般要和所在的目录同名，也可以不同（建议相同），包名中不能包含-等特殊符号。

  • 包一般使用域名作为目录名称，这样能保证包名的唯一性，比如 GitHub 项目的包一般会放到GOPATH/src/github.com/userName/projectName 目录下。

  • 包名为 main 的包为应用程序的入口包，编译不包含 main 包的源码文件时不会得到可执行文件。

  • 一个包中可以有任意多个源文件，这些原文件属于同一个包，源文件的名字也没有任何规定（但后缀必须是 .go）如果一个包有多个 .go 文件，则建议其中有一个 .go 文件的文件名和包名相同。

  • 同样属于同一个包的源码文件不能放在多个文件夹下。两个不同的包不能放在同一文件夹下。

3. 可见性（导出）

如果想在一个包中引用另外一个包里的标识符（如变量、常量、类型、函数等）时，该标识符必须是对外可见的（public）。在Go语言中只需要将标识符的首字母大写就可以让标识符对外可见了。

举个例子， 我们定义一个包名为pkg2的包，代码如下：

package pkg2
import "fmt"
// 包变量可见性
var a = 100 // 首字母小写，外部包不可见，只能在当前包内使用
// 首字母大写外部包可见，可在其他包中使用
const Mode = 1
type person struct { // 首字母小写，外部包不可见，只能在当前包内使用
	name string
}
// 首字母大写，外部包可见，可在其他包中使用
func Add(x, y int) int {
	return x + y
}
func age() { // 首字母小写，外部包不可见，只能在当前包内使用
	var Age = 18 // 函数局部变量，外部包不可见，只能在当前函数内使用
	fmt.Println(Age)
}

结构体中的字段名和接口中的方法名如果首字母都是大写，外部包可以访问这些字段和方法。例如：

type Student struct {
	Name  string //可在包外访问的方法
	class string //仅限包内访问的字段
}
type Payer interface {
	init() //仅限包内访问的方法
	Pay()  //可在包外访问的方法
}

4. 包的导入

4.1 介绍

要在代码中引用其他包的内容，需要使用 import 关键字导入使用的包。

具体语法如下:

import "包的路径"

注意事项：

  • import 导入语句通常放在源码文件开头 包声明 语句的下面。
  • 导入的包名需要使用双引号包裹起来。
  • 包名是从$GOPATH/src/后开始计算的，使用/进行路径分隔。– 自动导入
  • Go语言中禁止循环导入包。

4.2 导入方式

单行导入

单行导入的格式如下：

import "包1"
import "包2"

多行导入

多行导入的格式如下：

import (
    "包1"
    "包2"
)

4.3 路径

包的引用路径有两种写法，分别是全路径导入（推荐）和相对路径导入。

全路径导入

包的绝对路径就是GOROOT/src/或GOPATH/src/后面包的存放路径，如下所示：

// test 包是自定义的包，其源码位于GOPATH/src/lab/test 目录下
import "lab/test"
// driver 包的源码位于 GOROOT/src/database/sql/driver 目录下
import "database/sql/driver"
// sql    包的源码位于 GOROOT/src/database/sql 目录下
import "database/sql"

相对路径引入

相对路径只能用于导入GOPATH 下的包，标准包的导入只能使用全路径导入。

例如包 a 的所在路径是GOPATH/src/lab/a，包 b 的所在路径为GOPATH/src/lab/b，如果在包 b 中导入包 a ，则可以使用相对路径导入方式。示例如下：

// 相对路径导入
import "../a"

当然了，也可以使用上面的全路径导入，如下所示：

// 全路径导入
import "lab/a"

4.4 引用格式

包的引用有四种格式，下面以 fmt 包为例来分别演示一下这四种格式。

标准引用格式

import "fmt"

fmt.Println("hello word")

可以用fmt.作为前缀来使用 fmt 包中的方法，这是常用的一种方式。

别名引用格式

在导入包名的时候，我们还可以为导入的包设置别名。通常用于导入的包名太长或者导入的包名冲突的情况。

  1. 别名可以解决包名冲突问题。
  2. 如果导入的一个包名很笨重，特别是在一些自动生成的代码中，这时候用一个简短名称会更方便。

具体语法格式如下：

import 别名 "包的路径"

示例：

import f "fmt"

 f.Println("C语言中文网")

f 是 fmt 包的别名，使用时我们可以使用f. 来代替标准引用格式的 fmt.来作为前缀使用 fmt 包中的方法。

省略引用格式

import . "fmt"

//不需要加前缀 fmt.
Println("C语言中文网")

这种格式相当于把 fmt 包直接合并到当前程序中，在使用 fmt 包内的方法是可以不用加前缀 fmt. ，直接引用。

匿名引用格式

  1. 引用某个包时，如果只是希望执行包初始化的 init 函数，而不使用包内部的数据时，可以使用匿名引用格式。

  2. 匿名导入的包与其他方式导入的包一样都会被编译到可执行文件中。同时也会触发 init() 函数调用。

  3. 使用标准格式引用包，但是代码中却没有使用包，编译器会报错。如果包中有 init 初始化函数，则通过该种方式引用包，仅执行包的初始化函数，即使包没有 init 初始化函数，也不会引发编译器报错。

import _ "fmt"

5. 包的加载

在执行 main 包的 mian 函数之前， Go 引导程序会先对整个程序的包进行初始化。整个执行的流程如下图所示：

Go语言包的初始化有如下特点：

  • 包初始化程序从 main 函数引用的包开始，逐级查找包的引用，直到找到没有引用其他包的包，最终生成一个包引用的有向无环图。

  • Go 编译器会将有向无环图转换为一棵树，然后从树的叶子节点开始逐层向上对包进行初始化。

  • 单个包的初始化过程如上图所示，先初始化常量，然后是全局变量，最后执行包的 init 函数。被最后导入的包会最先初始化并调用 init() 函数

  • 一个包可以有多个 init 函数，包加载时会先执行全部的 init 函数，但并不能保证执行顺序，所以不建议在一个包中放入多个 init 函数，将需要初始化的逻辑放到一个 init 函数里面。

  • 包不能出现环形引用的情况，比如包 a 引用了包 b，包 b 引用了包 c，如果包 c 又引用了包 a，则编译不能通过。

  • 包的重复引用是允许的，比如包 a 引用了包 b 和包 c，包 b 和包 c 都引用了包 d。这种场景相当于重复引用了 d，这种情况是允许的，并且 Go 编译器保证包 d 的 init 函数只会执行一次。

示例：

package main
import "chapter08/code8-2/pkg1"
func main() {
    pkg1.ExecPkg1()
}
package pkg1
import (
    "chapter08/code8-2/pkg2"
    "fmt"
)
func ExecPkg1() {
    fmt.Println("ExecPkg1")
    pkg2.ExecPkg2()
}
func init() {
    fmt.Println("pkg1 init")
}
package pkg2
import "fmt"
func ExecPkg2() {
    fmt.Println("ExecPkg2")
}
func init() {
    fmt.Println("pkg2 init")
}

运行结果：

pkg2 init
pkg1 init
ExecPkg1
ExecPkg2

6. init()初始化函数

6.1 init()函数介绍

某些需求需要在包加载时调用一些初始化函数。如果需要通过开发者手动调用这些初始化函数，那么这个过程可能会发生错误或者遗漏。我们希望在被引用的包内部，由包的编写者在程序启动时做一些自己包内代码的初始化工作。Go 语言为以上问题提供了一个非常方便的特性：init() 函数。

在Go语言程序执行时导入包语句会自动触发包内部init()函数的调用。需要注意的是： init()函数没有参数也没有返回值。 init()函数在程序运行时自动被调用执行，不能在代码中主动调用它。

包初始化执行的顺序如下图所示：

init() 函数的特性如下：

  1. 每个源码可以有多个 init() 函数。
  2. init() 函数会在程序执行前（main() 函数执行前）被自动调用。
  3. init() 函数不能被其他函数调用。

6.2 init()函数执行顺序

Go语言包会从main包开始检查其导入的所有包，每个包中又可能导入了其他的包。Go编译器由此构建出一个树状的包引用关系，再根据引用顺序决定编译顺序，依次编译这些包的代码。

在运行时，被最后导入的包会最先初始化并调用其init()函数， 如下图示：

参考感谢
package 包 · 语雀 (yuque.com)
Go语言基础之包 · 语雀 (yuque.com)
08.包（package） · 语雀 (yuque.com)
接口 · 语雀 (yuque.com)
定义包和导入包 · 语雀 (yuque.com)