Golang 程序的基本结构和要素

2024-01-09

字数统计: 4.8k字 | 阅读时长≈ 17分

Go 入门指南: Go 程序的基本结构和要素

Go 程序的基本结构和要素

包的概念，导入和可见性

包是结构化代码的一种方式: 每个程序都由包(通常简称为 pkg) 的概念组成，可以使用自身的包或者从其他包中导入内容。

如同其他一些编程语言中的类库或命名空间的概念，每个 go 文件都属于且仅属于一个包。一个包可以由许多以 .go 为扩展名的源文件组成，因此文件名和包名一般来说都是不相同的。

你必须在源文件中非注释的第一行指明这个文件属于哪个包，如 package main。package main 表示一个可独立执行的程序，每个 go 应用程序都包含一个名为 main 的包。

一个应用陈旭可以包含不同的包，而且即使你只使用 main 包也不必把所有的代码都写在一个巨大的文件里: 可以使用一些较小的文件，并且在每个文件非注释的第一行都使用 package main 来指明这些文件都属于 main 包。如果你打算编译包名不也是为 main 的源文件，如 pack1，编译后产生的对象文件将会是 pack1.a 而不是可执行程序。另外要注意的是，所有的包名都应该使用小写字母

标准库
在 go 的安装文件里包含了一些可以直接使用的包，即标准库。在 Windows 下，标准库的位置在 Go 根目录下的子目录 pkg\windows_386 中；在 Linux 下，标准库在 Go 目录下的子目录 pkg/linux_amd64 中（如果安装的是 32 位，则在 linux_386 目录中）。一般情况下，标准库会存放在 $GOROOT/pkg/$GOOS_$GOARCH/ 目录下。

Go 的标准库包含了大量的包（如: fmt 和 os)，但是你也可以创建自己的包.

如果想要构建一个程序，则包和包内的文件都必须以正确的顺序进行编译。包的依赖关秀决定了其构建顺序。
属于同一个包的源文件必须全部被一起编译，一个包即是编译时的一个单元，因此根据惯例，每个目录都只包含一个包。

如果对一个包进行更改或重新编译，所有引用了这个包的客户端程序都必须全部重新编译。

Go 中的包模型采用了显式依赖关系的机制来达到快速编译的目的，编译器会从后缀名为 .go 的对象文件（需要且只需要这个文件）中提取传递依赖类型的信息。

如果 A.go 依赖 B.go，而 B.go 又依赖 C.go:

编译器会先编译 C.go，B.go，然后是 A.go
为了编译 A.go，编译器读取的是 B.o 而不是 C.o

这种机制对于编译大型的项目时可以显著地提升编译速度。

每一段代码只会被编译一次
一个 Go 程序是通过 import 关键字将一组包链接在一起。
import "fmt" 告诉 Go 编译器这个程序需要使用 fmt 包的函数或其他元素，fmt 包实现了格式化 IO(输入/输出) 的函数。包名被封闭在双引号 "" 中。如果你打算从已编译的包中导入并加载公开声明的方法，不需要插入已编译包的源代码.

如果需要多个包，它们可以被分别导入:

import "fmt"
import "os"

//或者如下方式导入
import "fmt"; import "os"

还有更短且更优雅的方法（被称为因式分解关键字，该方法同样适用于 const、var 和 type 的声明或定义）

import (
  "fmnt"
  "os"
)

// 它甚至还可以更短的形式，但使用 gofmt 后将被强制换行

import ("fmt"; "os")

放你导入多个包时，最好按照字母顺序排列包名，这样做更加清晰易读。

如果包名不是以 . 或 / 开头，如 "fmt" 或者 "container/list"，则go 会在全局文件进行查找；
如果包名以 . 开头，则 go 会在相对目录中查找；
如果包名以 / 开头（在 windows 下也可以这样使用），则会在系统的绝对路劲中查找.

导入包即等同于包含了这个包的所有的代码对象。

除了符号 _，包中所有代码对象的标识符必须是唯一的，以避免名称冲突。但是相同的标识符可以在不同的包中使用，因为就可以使用包名来区分它们。

包通过下面这个被编译器强制执行的规则来决定是否将自身的代码对象暴露给外部文件：

可见性规则
当标识符（包括常量、变量、类型、函数名、结构字段等等）以一个大写字母开头，如 Group1，那么使用这种形式的标识符的对象就可以被外部包的代码所使用（客户端程序首先要先导入这个包），这被称为导出（像面向对象语言中的 public）；标识符如果以小写字母开头，则对包外是不可见的，但是他们在整个包的内部是可见并且可用的（像面向对象语言中的 private）。

（大写字母可以使用任何 Unicode 编码的字符，比如希腊文，不仅仅是 ASCII 码中的大写字母）。

因此，在导入一个外部包后，能够且只能够访问该包中导出的对象。

假设在包 pack1 中我们有一个变量或函数叫做 Thing(以 T 开头，所以它能够被导出)，那么在当前包中导入 pack1 包；Thing 就可以像面向对象语言那样使用点标记来调用: pack1.Thing（pack1 在这里是不可以省略的）

因此包也可以作为命名空间使用，帮助避免命名冲突（名称冲突）:两个包中的同名变量的区别在于他们的包名，例如 pack1.Thing 和 pack2.Thing
你可以通过使用包的别名来解决包名之间的名称冲突，或者说根据你的个人喜好对包名进行重新设置，如: import fm "fmt"。

下面的代码展示了如何使用包的别名

package main

import fm "fmt"    // alias3

func main() {
  fm.Println("hello, world")
}

注意事项
如果你导入了一个包却没有使用它，则会在构建程序时引发错误，如 imported and not used: os，这正是遵循了 Go 的格言：”没有不必要的代码！”。

包的分级声明和初始化
你可以在使用 import 导入包之后定义或声明 0 个或多个常量（const）、变量（var）和类型（type），这些对象的作用域都是全局的（在本包范围内），所以可以被本包中所有的函数调用（如 gotemplate.go 源文件中的 c 和 v），然后声明一个或多个函数（func）。

函数

如下，这是定义一个函数最简单的格式

1	func functionName()

你可以在括号 () 中写入 0 个或多个函数的参数(使用逗号 , 分隔)，每个参数的名称后面必须紧跟着该参数的类型。

main 函数是每一个可执行程序所必须包含的，一般来说都是在启动后第一个执行的函数（如果有 int() 函数则会先执行该函数）。如果你的 main 包的源代码没有包含 main 函数，则会引发构建错误 undefined: main.main。main 函数既没有参数，也没有返回类型（与 C 家族中的其他语言恰好相反）。如果你不小心为 main 函数添加了参数或者返回类型。将会引发构建错误:

1	func main must have no arguments and no return values results.

在程序开始执行并完成初始化后，第一个调用（程序的入口点）的函数是 main.main()（如：C 语言），该函数一旦返回就表示程序已成功执行并立即退出。

函数里面的代码(函数体) 使用大括号 {} 括起来。

左大括号 { 必须与方法的声明放在同一行，这是编译器的强制规定，否则你在使用 gofmt 时就会出现错误提示：

1	`build-error: syntax error: unexpected semicolon or newline before {`

这是因为编译器会产生 func main(); 这样的结果，很明显这错误的，Go 语言虽然看起来不使用分号作为语句的结束，但实际上这一过程是由编译器自动完成，因此才会引发像上面这样的错误

右大括号 } 需要被放在紧接着函数体的下一行。如果你的函数非常简短，你也可以将它们放在同一行：

1	func Sum(a, b int) int { return a + b }

对于大括号 {} 的使用规则在任何时候都是相同的（如：if 语句等）。因此符合规范的函数一般写成如下的形式：

1
2
3

func functionName(parameter_list) (return_value_list) {
   …
}

其中:

parameter_list 的形式为 (param1 type1, param2 type2, …)
return_value_list 的形式为 (ret1 type1, ret2 type2, …)

只有当某个函数需要被外部包调用的时候才使用大写字母开头，并遵循 Pascal 命名法；否则就遵循骆驼命名法，即第一个单词的首字母小写，其余单词的首字母大写。

下面这一行调用了 fmt 包中的 Println 函数，可以将字符串输出到控制台，并在最后自动增加换行字符 \n：

1	fmt.Println（"hello, world"）

使用 fmt.Print("hello, world\n") 可以得到相同的结果。Print 和 Println 这两个函数也支持使用变量，如：fmt.Println(arr)。如果没有特别指定，它们会以默认的打印格式将变量 arr 输出到控制台。

单纯地打印一个字符串或变量甚至可以使用预定义的方法来实现，如：print、println：print("ABC")、println("ABC")、println(i)（带一个变量 i）。

这些函数只可以用于调试阶段，在部署程序的时候务必将它们替换成 fmt 中的相关函数。

当被调用函数的代码执行到结束符 } 或返回语句时就会返回，然后程序继续执行调用该函数之后的代码。

程序正常退出的代码为 0 即 Program exited with code 0；如果程序因为异常而被终止，则会返回非零值，如：1。这个数值可以用来测试是否成功执行一个程序。

注释

示例 hello_world2.go

package main

import "fmt" // Package implementing formatted I/O.

func main() {
  fmt.Printf("Καλημέρα κόσμε; or こんにちは 世界\n")
}

上面的例子通过打印 Καλημέρα κόσμε; or こんにちは世界 展示了如何在 Go 中使用国际化字符，以及如何使用注释。注释不会被编译，但可以通过 godoc 来使用。

单行注释是最常见的注释形式，你可以在任何地方使用 // 开头配置单行注释。多行注释也叫块注释，均以 /* 开头，并以 */ 结尾，且不可以嵌套使用，多行注释一般用于包的文档描述或者注释成块的代码片段。

每一个包应该有相关的注释，在 package 语句之前的块注释将被默认为是这个包的文档说明，其中应该提供一些相关的信息并对整体功能做简要的介绍。一个包可以分散在多个文件中，但是只需要在其中一个进行注释说明即可。当开发人员需要了解包的情况时，自然会用 godoc 来显示包的文档说明，在首行的简要注释之后可以用成段的注释来进行更详细的说明，而不必拥挤在一起。另外，在多段注释之间应以空行分隔加以区分。

示例:

// Package superman implements methods for saving the world.
//
// Experience has shown that a small number of procedures can prove
// helpful when attempting to save the world.
package superman

几乎所有全局作用域的类型、常量、变量、函数和被导出的对象都应该有一个合理的注释。如果这种注释（称为文档注释）出现在函数前面，例如函数 Abcd，则要以 "Abcd ..." 作为开头。如下所示

// enterOrbit causes Superman to fly into low Earth orbit, a position
// that presents several possibilities for planet salvation.
func enterOrbit() error {
   ...
}

godoc 工具会收集这些注释并产生一个技术文档。

类型

可以包含数据的变量（或常量），可以使用不同的数据类型或类型来保存数据。使用 var 声明的变量的值会自动初始化为该类型的零值。类型定义了某个变量的值的集合与可对其进行操作的集合。

类型可以是基本类型，如: int、float、bool、string; 结构化的（复合的），如: struct、array、slice、map、channel; 只描述类型的行为的,如: interface。

结构化的类型没有真正的值，它使用 nil 作为默认值（在 Objective-C 中是 nil，在 Java 中是 null，在 C 和 C++ 中是 NULL 或 0）。值得注意的是，Go 语言中不存在类型继承。

函数也可以是一个确定的类型，就是以函数作为返回类型。这种类型的声明要写在函数名和可选的参数列表之后，例如

1	func FunctionName (a typea, b typeb) typeFunc

你可以在函数体中的某处返回使用类型为 typeFunc 的变量 var:

1	return var

一个函数可以有多个返回值，返回类型之间需要使用逗号分隔，并使用小括号 () 将它们括起来，如:

1	func FunctionName (a typea, b typeb) (t1 type1, t2 type2)

示例:
函数 Atoi: func Atoi(s string) (i int, err error) 返回的形式:

1	return var1, var2

这种多返回值一般用于判断某个函数是否执行成功（true/false）或与其它返回值一同返回错误消息（详见之后的并行赋值）。

使用 type 关键字可以定义你自己的类型，你可能想要定义一个结构体，但是也可以定义一个已经存在的类型的别名，如：

1	type IZ int

这里并不是真正意义上的别名，因为使用这种方法定义之后的类型可以拥有更多的特性，且在类型转换时必须显式转换。

然后我们可以使用下面的方式声明变量：

1	var a IZ = 5

这里我们可以看到 int 是变量 a 的底层类型，这也使得它们之间存在相互转换的可能。

如果你有多个类型需要定义，可以使用因式分解关键字的方式，例如:

type (
   IZ int
   FZ float64
   STR string
)

每个值都必须在经过编译后属于某个类型（编译器必须能够推断出所有值的类型），因为 Go 语言是一种静态类型语言。

Go 程序的一般结构

下面的程序可以被顺利编译但什么都做不了，不过这很好的展示了一个 Go 程序的首选结构。这种结构并没有被强制要求，编译器也不关心 main 函数在前还是变量的声明在前，但使用统一的结构能够在从上至下阅读 go 代码时有更好的体验。

所有的结构将在这一章或接下来的章节中进一步地解释说明，但总体思路如下

在完成包的 import 之后，开始对常量、变量和类型的定义或声明。
如果存在 init 函数的话，则对该函数进行定义（这是一个特殊的函数，每个含有该函数的包都会首先执行这个函数）。
如果当前包是 main 包，则定义 main 函数。
然后定义其余的函数，首先是类型的方法，接着是按照 main 函数中先后调用的顺序来定义相关函数，如果有很多函数，则可以按照字母顺序来进行排序。

示例: gotemplate.go

package main

import (
   "fmt"
)

const c = "C"

var v int = 5

type T struct{}

func init() { // initialization of package
}

func main() {
   var a int
   Func1()
   // ...
   fmt.Println(a)
}

func (t T) Method1() {
   //...
}

func Func1() { // exported function Func1
   //...
}

Go 程序的执行（程序启动）顺序如下:

按顺序导入所有被 main 包引用的其它包，然后在每个包中执行如下流程：
如果该包又导入了其它的包，则从第一步开始递归执行，但是每个包只会被导入一次。
然后以相反的顺序在每个包中初始化常量和变量，如果该包含有 init 函数的话，则调用该函数。
在完成这一切之后，main 也执行同样的过程，最后调用 main 函数开始执行程序。

类型转换

在必要以及可行的情况下，一个类型的值可以被转换成另一种类型的值。由于 Go 语言不存在隐式类型转换，因此所有的转换都必须显式说明，就像调用一个函数一样（类型在这里的作用可以看作是一种函数）：

1	valueOfTypeB = typeB(valueOfTypeA)

类型 B 的值 = 类型 B (类型 A 的值)

示例:

1 2	a := 5.0 b := int(a)

但这只能在定义正确的情况下转换成功，例如从一个取值范围较小的类型转换到一个取值范围较大的类型（例如将 int16 转换为 int32）。当从一个取值范围较大的转换到取值范围较小的类型时（例如将 int32 转换为 int16 或将 float32 转换为 int），会发生精度丢失（截断）的情况。当编译器捕捉到非法的类型转换时会引发编译时错误，否则将引发运行时错误。

具有相同底层类型的变量之间可以相互转换：

1
2
3

var a IZ = 5
c := int(a)
d := IZ(c)

Go 命名规范

干净、可读的代码和简洁性是 Go 追求的主要目标。通过 gofmt 来强制实现统一的代码风格。Go 语言中对象的命名也应该是简洁且有意义的。像 Java 和 Python 中那样使用混合着大小写和下划线的冗长的名称会严重降低代码的可读性。名称不需要指出自己所属的包，因为在调用的时候会使用包名作为限定符。返回某个对象的函数或方法的名称一般都是使用名词，没有 Get… 之类的字符，如果是用于修改某个对象，则使用 SetName。有必须要的话可以使用大小写混合的方式，如 MixedCaps 或 mixedCaps，而不是使用下划线来分割多个名称。