Skip to content

GoLang

Go 是一种高性能的、静态类型的编译型语言。

GoC++Python
静态类型静态类型动态类型
编译型语言编译型语言解释型语言
编译速度快编译速度慢-
运行速度快运行速度快运行速度慢
内存安全内存不安全内存安全
不支持类支持类支持类

1 注释

注释是在执行时被忽略的文本。

注释可用于解释代码,并使其更具可读性。

注释还可用于在测试替代代码时阻止代码执行。

Go 支持单行或多行注释。

1.1 单行注释

单行注释以两个正斜杠(//)开头。

编译器将忽略 // 到行尾之间的文本(不会执行)。

go
// 这是一个单行注释
package main

import "fmt"

func main() {
	// 这是一个单行注释
	fmt.Println("Hello World!") // 这是一个单行注释
}

1.2 多行注释

多行注释以 /* 开头和 */ 结尾。

编译器将忽略 /**/ 之间的文本。

go
package main

import "fmt"

func main() {
	/* 这是一个
	多行注释 */
	fmt.Println("Hello World!")
}

2 变量

2.1 声明变量

在 Go 中,有两种方法可以声明变量:

  1. 使用 var 关键字:

var 关键字后面跟变量名和数据类型:

go
var age int = 1

注意

数据类型和值必须指定任意一项,或者像上面那样两个都指定。

go
var age1 int
var age2 = 1
  1. 使用 := 符号:

:= 后面接变量值:

go
age := 1

注意

  • 在这种情况下,将由编译器根据值决定变量的类型。
  • 使用 := 声明变量时必须赋值。

2.2 声明多变量

在 Go 中,可以在同一行声明多个变量。

go
var a, b, c int = 1, 2, 3

注意

如果指定了数据类型,则每行只能声明同一种数据类型的多个变量。

如果不指定数据类型,就能在同一行中声明不同数据类型的变量:

go
var name1, age1 = "Zhang", 23
name2, age2 := "Zhang", 23

多个变量声明也可以组合成一个块,可读性更高:

go
var (
    m    int
    n           = 1
    age  int    = 23
    name string = "Zhang"
)

3 常量

通过 const 关键字声明常量,常量的值是无法修改的。

go
const PI float64 = 3.1415926

注意

必须在声明常量时赋值。

常量名称通常用全部大写,以便区分变量。

go
const (
    A = 23
    B
    C = "Zhang"
    D
)

在上面的声明中,常量 B 的值与 A 一样,常量 D 的值与 C 一样。

go
const (
    A = iota
    B
    C
)

在上面的声明中,常量 A 的值为 0B1C2

iota 是一个特殊常量,在 const 内部第一行的值为 0,后面每行依次递增加一。

4 基本数据类型

4.1 布尔

go
var b1 bool = true
var b2 = true
var b3 bool
b4 := true

4.2 整数

整数类型分为两类:

  • 有符号整数 - 可以存储正值和负值
  • 无符号整数 - 只能存储非负值

4.2.1 有符号整数

类型大小范围
int32 bits 或者 64 bits
取决于是32位系统还是64位系统
int88 bits / 1 byte- (2 ^ 7) ~ (2 ^ 7 - 1)
int1616 bits / 2 bytes- (2 ^ 15) ~ (2 ^ 15 - 1)
int3232 bits / 4 bytes- (2 ^ 31) ~ (2 ^ 31 - 1)
int6464 bits / 8 bytes- (2 ^ 63) ~ (2 ^ 63 - 1)

4.2.2 无符号整数

类型大小范围
uint32 bits 或者 64 bits
取决于是32位系统还是64位系统
uint88 bits / 1 byte0 ~ (2 ^ 8 - 1)
uint1616 bits / 2 bytes0 ~ (2 ^ 16 - 1)
uint3232 bits / 4 bytes0 ~ (2 ^ 32 - 1)
uint6464 bits / 8 bytes0 ~ (2 ^ 64 - 1)

4.2.3 其他

byteuint8 的别名,用于区分字节值和8位无符号整数值,定义如下:

go
type byte = uint8

runeint32 的别名,用于区分字符值和整数值,定义如下:

go
type rune = int32

4.3 浮点数

浮点数类型有两个关键字:float32float64

4.4 字符串

go
var s string = "Hello World"

4.4.1 字符串的拼接

go
name := "Zhang"
age := 23

// 方法一,直观简洁,但是每次拼接会创建新字符串,导致频繁内存分配和复制
s1 := "name: " + name + ", age: " + strconv.Itoa(age)

// 方法二,需解析格式字符串,性能不好
s2 := fmt.Sprintf("name: %s, age: %d", name, age)

// 方法三,推荐
builder := strings.Builder{}
builder.WriteString("name: ")
builder.WriteString(name)
builder.WriteString(", age: ")
builder.WriteString(strconv.Itoa(age))
s3 := builder.String()

fmt.Println(s1)  // name: Zhang, age: 23
fmt.Println(s2)  // name: Zhang, age: 23
fmt.Println(s3)  // name: Zhang, age: 23

其中,strings.Builder 的性能最好,内部使用可扩展缓冲区,减少内存分配次数。

4.4.2 字符串的比较

直接使用比较运算符就行。

go
s1 := "Zhang"
s2 := "Zhang"

fmt.Println(s1 == s2)  // true

5 格式化输出

5.1 常规格式

以下格式可用于所有数据类型:

格式含义
%v以默认格式输出
%#v以Go语法的格式输出
%T输出值的类型
%%输出一个百分号
go
f := 12.3
s := "Zhang"
a := []int{1, 2, 3}

fmt.Printf("%v\n", f)   // 12.3
fmt.Printf("%#v\n", f)  // 12.3
fmt.Printf("%T\n", f)   // float64

fmt.Printf("%v\n", s)   // Zhang
fmt.Printf("%#v\n", s)  // "Zhang"
fmt.Printf("%T\n", s)   // string

fmt.Printf("%v\n", a)   // [1 2 3]
fmt.Printf("%#v\n", a)  // []int{1, 2, 3}
fmt.Printf("%T\n", a)   // []int

fmt.Printf("%%\n")      // %

5.2 整数格式

以下输出格式要和整数类型一起使用:

格式含义
%b以二进制格式输出
%o以八进制格式输出
%O以八进制格式输出并且显示前缀 0o
%d以十进制格式输出
%+d以十进制格式输出并且显示符号
%x以十六进制格式小写输出
%X以十六进制格式大写输出
%#x以十六进制格式小写输出并且显示前缀 0x
%#X以十六进制格式大写输出并且显示前缀 0X
%4d以宽度为 4 的格式输出,左侧填充空格
%-4d以宽度为 4 的格式输出,右侧填充空格
%04d以宽度为 4 的格式输出,左侧填充 0
go
var i = 123

fmt.Printf("%b\n", i)    // 1111011
fmt.Printf("%o\n", i)    // 173
fmt.Printf("%O\n", i)    // 0o173
fmt.Printf("%d\n", i)    // 123
fmt.Printf("%+d\n", i)   // +123
fmt.Printf("%x\n", i)    // 7b
fmt.Printf("%X\n", i)    // 7B
fmt.Printf("%#x\n", i)   // 0x7b
fmt.Printf("%#X\n", i)   // 0X7B
fmt.Printf("%4d\n", i)   //  123
fmt.Printf("%-4d\n", i)  // 123 
fmt.Printf("%04d\n", i)  // 0123

5.3 字符串格式

以下输出格式要和字符串类型一起使用:

格式含义
%s纯字符串输出
%q用双引号包裹输出
%8s以宽度为 8 的格式输出,左侧填充空格
%-8s以宽度为 8 的格式输出,右侧填充空格
%x以十六进制输出字符串的每个字符
% x以十六进制输出字符串的每个字符并且用空格分隔
go
var s = "Zhang"

fmt.Printf("%s\n", s)    // Zhang
fmt.Printf("%q\n", s)    // "Zhang"
fmt.Printf("%8s\n", s)   //    Zhang
fmt.Printf("%-8s\n", s)  // Zhang   
fmt.Printf("%x\n", s)    // 5a68616e67
fmt.Printf("% x\n", s)   // 5a 68 61 6e 67

5.4 布尔格式

以下输出格式要和布尔类型一起使用:

格式含义
%t输出布尔值
go
fmt.Printf("%t\n", true)  // true

5.5 浮点数格式

以下输出格式要和浮点数类型一起使用:

格式含义
%f保留 6 位小数
%.2f保留 2 位小数
%6.2f宽度 6,精度 2
%e科学计数法,输出的 e 小写
%E科学计数法,输出的 E 大写
go
var f float64 = 0.125

fmt.Printf("%f\n", f)     // 0.125000
fmt.Printf("%.2f\n", f)   // 0.12
fmt.Printf("%6.2f\n", f)  //   0.12
fmt.Printf("%e\n", f)     // 1.250000e-01
fmt.Printf("%E\n", f)     // 1.250000E-01

6 条件语句

go
age := 23
if age == 18 {
    fmt.Println("刚成年")
} else if age > 18 {
    fmt.Println("已成年")
} else {
    fmt.Println("未成年")
}

7 循环语句

for 循环是 Go 语言中唯一的循环语句。

go
for i := 0; i < 10; i++ {
    if i == 2 {
        continue
    }
    if i == 6 {
        break
    }
    fmt.Printf("%d ", i)  // 0 1 3 4 5 
}

for index, value := range "Zhang" {
    fmt.Printf("%d-%c ", index, value)  // 0-Z 1-h 2-a 3-n 4-g 
}

for index, value := range []int{66, 88, 99} {
    fmt.Printf("%d-%d ", index, value)  // 0-66 1-88 2-99 
}

8 goto语句

go
	i := 1
LOOP:
	fmt.Printf("%v ", i)  // 1 2 3
	i++
	if i <= 3 {
		goto LOOP
	}

9 switch语句

go
status := 200
switch status {
case 200:
    fmt.Println("OK")
case 403:
    fmt.Println("Permission Denied")
case 404:
    fmt.Println("Not Found")
default:
    fmt.Println("Unknown status")
}

10 数组

go
arr1 := [3]int{1, 2, 3}
arr2 := [...]int{4, 5}
fmt.Printf("%T %T", arr1, arr2)  // [3]int [2]int

注意

在 Go 语言中,数组长度固定,要么给数组指定长度,要么使用 ... 让编译器推断数组的长度。

只初始化数组特定位置:

go
arr1 := [8]int{3: 33, 5: 55}
arr2 := [...]int{6: 66}
fmt.Println(arr1)  // [0 0 0 33 0 55 0 0]
fmt.Println(arr2)  // [0 0 0 0 0 0 66]

可以使用 ==!= 直接比较两个数组是否相等:

go
arr1 := [3]int{1, 2, 3}
arr2 := [...]int{1, 2, 3}
fmt.Println(arr1 == arr2)  // true
fmt.Println(arr1 != arr2)  // false

11 切片

11.1 创建

切片类似于数组,但更灵活。

与数组不同的是,切片的长度可以增大或者缩小。

在 Go 中,有几种方法可以创建切片:

  • 直接声明
  • 从数组创建
  • 使用 make() 函数
go
arr := [...]int{1, 2, 3, 4, 5}
slice1 := []int{1, 2, 3}
slice2 := arr[1:4]
slice3 := make([]int, 3, 6)
fmt.Println(slice1, len(slice1), cap(slice1))  // [1 2 3] 3 3
fmt.Println(slice2, len(slice2), cap(slice2))  // [2 3 4] 3 4
fmt.Println(slice3, len(slice3), cap(slice3))  // [0 0 0] 3 6

cap() 返回切片的容量,如果切片从数组创建的,那么切片的容量为选中的起始位置到数组末尾。

make() 的第二个参数为长度,第三个参数为容量,如果容量未指定,则默认等于长度。

11.2 修改

go
slice1 := []int{1, 2, 3}
slice2 := append(slice1, 4, 5)       // 追加一个元素
slice3 := append(slice2, slice1...)  // 追加一个切片的所有元素
fmt.Println(slice1)  // [1 2 3]
fmt.Println(slice2)  // [1 2 3 4 5]
fmt.Println(slice3)  // [1 2 3 4 5 1 2 3]

注意

将另一个切片的所有元素追加到一个切片上时,需要在另一个切片后面写上 ...

go
// 删除切片中索引为 2 的元素
slice1 := []int{1, 2, 3, 4, 5}
slice2 := append(slice1[:2], slice1[3:]...)
fmt.Println(slice1)  // [1 2 4 5 5]
fmt.Println(slice2)  // [1 2 4 5]

注意

slice1 变成了 [1 2 4 5 5],这是因为切片是对底层数组的引用,当执行 append(slice1[:2], slice1[3:]...) 时,slice1 的底层数组会被修改。具体来说,slice1 的前 2 个元素保持不变,但后面的元素会被覆盖为 [4, 5]

go
slice1 := []int{1, 2, 3, 4, 5, 6}
slice2 := []int{}
slice3 := make([]int, 3)
copy(slice2, slice1[1:])
copy(slice3, slice1[1:])
slice1[1] = 100
fmt.Println(slice1)  // [1 100 3 4 5 6]
fmt.Println(slice2)  // [],因为容量为 0,所以只 copy 了 0 个元素
fmt.Println(slice3)  // [2 3 4],因为容量为 3,所以只 copy 了 3 个元素

通过 copy() 可以避免新切片和原切片引用同一个底层数组。

go
func handle(nums []int) {
	for index := range nums {
		nums[index] *= 10
		nums = append(nums, index)
	}
}

func main() {
	slice := []int{1, 2, 3}
	fmt.Println(slice) // [1, 2, 3]
	handle(slice)
	fmt.Println(slice) // [10, 2, 3]
}

注意

切片的函数传参是值传递,但是会有类似引用传递的效果。例如上述代码中,在第一次循环的时候,下标为 0 的元素变成原来的十倍,影响到了原切片,看似是引用传递,这是因为目前两个共用了一个底层数组,紧接着 append() 触发扩容创建了一个新底层数组给参数变量,后续的操作便影响不到原切片了,实则为值传递。

11.3 底层

切片的定义如下(简化版):

go
type slice struct {
    ptr *T   // 指向底层数组的指针
    len int  // 切片的长度
    cap int  // 切片的容量
}

切片本身并不存储数据,而是引用一个底层数组。

12 Map

Map 是一个无序且可更改的键值对集合。

12.1 创建

go
var myMap = map[string]string{
    "key1": "value1",
    "key2": "value2",
}
myMap["key3"] = "value3"
fmt.Println(myMap)  // map[key1:value1 key2:value2 key3:value3]

下面这种用法将会报错:

go
var myMap map[string]string
fmt.Println(myMap == nil)  // true
myMap["key"] = "value"  // 报错:panic: assignment to entry in nil map

通过 make() 创建空 Map,可以防止这种错误:

go
var myMap = make(map[string]string)
fmt.Println(myMap == nil)  // false
myMap["key"] = "value"
fmt.Println(myMap)  // map[key:value]

12.2 遍历

go
for key, value := range myMap {}
for key := range myMap {}

12.3 删除

go
var myMap = map[string]string{
    "key1": "value1",
    "key2": "value2",
    "key3": "value3",
}
fmt.Println(myMap)  // map[key1:value1 key2:value2 key3:value3]
delete(myMap, "key2")
fmt.Println(myMap)  // map[key1:value1 key3:value3]
delete(myMap, "key4")  // 删除不存在的元素也不会报错
fmt.Println(myMap)  // map[key1:value1 key3:value3]

12.4 查询

go
var myMap = map[string]string{
    "key1": "value1",
    "key2": "value2",
    "key3": "value3",
}
key1, ok1 := myMap["key2"]
key2, ok2 := myMap["key4"]
fmt.Println(ok1, key1)  // true value2
fmt.Println(ok2, key2)  // false (空字符串)

13 函数

13.1 声明

go
func add(m, n int) (sum int, err error) {
	sum = m + n
	return
}

// 效果同上
func add1(m int, n int) (int, error) {
	return m + n, nil
}

// 可变参数
func add2(slice ...int) (sum int, err error) {
	for _, value := range slice {
		sum += value
	}
	return
}

// 返回值为函数
func getFunc() (getN func() int) {
	getN = func() (n int) {
		n = 10
		return
	}
	return
}

func main() {
	fmt.Println(add(1, 2))  // 3 <nil>
    fmt.Println(add2(1, 2, 3))  // 6 <nil>
    fmt.Println(getFunc()())  // 10
}

13.2 闭包

go
func autoIncrement() func() int {
	i := 0
	return func() int {
		i++
		return i
	}
}

func main() {
	nextNum := autoIncrement()
	fmt.Println(nextNum())  // 1
	fmt.Println(nextNum())  // 2
	fmt.Println(nextNum())  // 3

	nextNum = autoIncrement()
	fmt.Println(nextNum())  // 1
	fmt.Println(nextNum())  // 2
}

13.3 defer

多个 defer 按照 LIFO 的顺序执行:

go
func deferPrint() int {
	defer fmt.Print("1")
	defer fmt.Print("2")
	defer fmt.Print("3")
	return 0
}

func main() {
	fmt.Print(deferPrint())  // 3210
}

延迟函数的参数在 defer 语句出现时就已经确定了:

go
n := 1
defer fmt.Println(n)  // 1
n++
fmt.Println(n)  // 2

return 语句在底层并不是原子操作,它分为给返回值赋值和RET指令两步。而 defer 语句执行的实际就在返回值操作后,RET指令前。

因此,延迟函数可操作外层函数的具名返回值:

go
func outer() (result int) {
	defer func() {
		result *= 2
	}()
	return 10
}

func main() {
	fmt.Println(outer())  // 20
}

上述代码执行 return 语句时,先给具名返回值赋值 result = 10,然后执行延迟函数的内容 result *= 2,最后返回 result

13.4 panicrecover

panic 会导致程序退出。

go
func setAge(age int) {
	if age < 0 {
		panic("negative age")
	}
}

func main() {
	setAge(-12)  // panic: negative age
	fmt.Println(0)  // 执行不到这里
}

recover 能够捕获到 panic,让程序继续运行下去。recover 操作必须在 defer 的函数中才有用。

go
func setAge(age int) {
	defer func() {
		if r := recover(); r != nil {
			fmt.Println(r)  // negative age
		}
	}()
	if age < 0 {
		panic("negative age")
	}
}

func main() {
	setAge(-12)
	fmt.Println(0)  // 0
}

14 type

go
type myInt1 = int  // 类型别名,在编译时会直接替换为 int
type myInt2 int    // 自定义类型

func main() {
	var a myInt1
	var b myInt2
	fmt.Printf("%T\n", a)  // int
	fmt.Printf("%T\n", b)  // main.myInt2
}

15 结构体

15.1 声明

go
type Student struct {
	name string
	age  int
}

15.2 访问

go
stu1 := Student{"Zhang", 20}
stu2 := Student{name: "Klose"}
fmt.Println(stu1.name, stu1.age)  // Zhang 20
fmt.Println(stu2.name, stu2.age)  // Klose 0

15.3 嵌套

go
type Info struct {
	name string
	age  int
}

type Student struct {
	info  Info
	score float64
}

func main() {
	stu := Student{Info{"Zhang", 20}, 95.5}
	fmt.Println(stu.info.name)  // Zhang
}

15.4 匿名嵌套

匿名嵌套可直接用 . 访问的被嵌入内部的结构体的成员,但是声明变量时,依旧要写完整被嵌入的结构体。

go
type Info struct {
	name string
	age  int
}

type Student struct {
	Info
	score float64
}

func main() {
	stu := Student{Info{"Zhang", 20}, 95.5}
	fmt.Println(stu.name)  // Zhang
}

如果结构体中与被嵌入内部的结构体中含有相同的成员,会优先使用外层的。

go
type Info struct {
	name string
	age  int
}

type Student struct {
	Info
	name  string
	score float64
}

func main() {
	stu := Student{Info{"Zhang", 20}, "Klose", 95.5}
	fmt.Println(stu.name)  // Klose
}

15.5 方法

go
type Student struct {
	name string
	age  int
}

func (stu Student) print() {
	fmt.Printf("name: %s, age: %d\n", stu.name, stu.age)
}

func main() {
	stu := Student{"zhang", 20}
	stu.print()  // name: zhang, age: 20
}

16 指针

go
func increase(n *int) {
	*n++
}

func main() {
	n := 15
	increase(&n)
	fmt.Println(n)  // 16
}

未初始化的指针的值为 nil,不可直接使用,通过 new() 可以避免该问题:

go
var n1 *int
var n2 = new(int)
fmt.Printf("type: %T, n1==nil: %t\n", n1, n1 == nil)  // type: *int, n1==nil: true
fmt.Printf("type: %T, n2==nil: %t\n", n2, n2 == nil)  // type: *int, n2==nil: false

17 接口

Go 中没有关键字显式声明某个类型实现了某个接口。只要一个类型实现了接口要求的所有方法,该类型就自动被认为实现了该接口。

17.1 接口定义

go
type Duck interface {
	walk()
	eat()
	sleep()
}

17.2 接口实现

go
type PskDuck struct {
	age uint8
}

func (p *PskDuck) walk() {
	fmt.Println("pskDuck walk")
}
func (p *PskDuck) eat() {
	fmt.Println("pskDuck eat")
}
func (p *PskDuck) sleep() {
	fmt.Println("pskDuck sleep")
}

func main() {
	var pskDuck Duck = &PskDuck{age: 1}
	pskDuck.walk()
	pskDuck.eat()
	pskDuck.sleep()
}

17.3 空接口

空接口 interface{} 是 Go 的特殊接口,表示所有类型的超集。任意类型都实现了空接口。

17.4 类型断言

类型断言用于从接口类型中提取其底层值。如果类型不匹配,会触发 panic

go
var a interface{} = "zhang"
name := a.(string)
fmt.Println(name)  // zhang
age := a.(int)  // 报错:panic: interface conversion: interface {} is string, not int
fmt.Println(age)

为了避免 panic,可以使用带检查的类型断言:

go
var a interface{} = "zhang"
age, isInt := a.(int)
if isInt {
	fmt.Println("age:", age)
} else {
	fmt.Println("a:", a)  // zhang
}

17.5 类型选择

go
var i interface{} = "zhang"
switch i.(type) {
case nil:
	fmt.Println("nil")
case int:
	fmt.Println("int")
case string:
	fmt.Println("string")  // string
default:
	fmt.Println("unknown")
}

17.6 接口遇到切片的常见错误

go
func printSlice(slice ...interface{}) {
	for _, v := range slice {
		fmt.Println(v)
	}
}

func main() {
	data := []string{"zhang", "heng", "hua"}
	printSlice(data...)  // 报错:cannot use data (variable of type []string) as []interface{} value in argument to printSlice
}

17.7 error 接口

error 内置接口类型的源码如下:

go
type error interface {
	Error() string
}

自定义错误:

go
type newError struct {}
func (e *newError) Error() string {
	return "新错误"
}

func main() {
	err := &newError{}
	fmt.Println(err)  // 新错误
}

18 package

假设有个包在目录 proj/user 下:

go
package person

type Person struct {
	Name string
}

18.1 导入

go
import (
	"fmt"
	"proj/user"
)

func main() {
	p := person.Person{Name: "Zhang"}
	fmt.Println(p.Name)  // Zhang
}

也可以给包起个别名:

go
import (
	"fmt"
	u "proj/user"
)

func main() {
	p := u.Person{Name: "Zhang"}
	fmt.Println(p.Name)  // Zhang
}

把其他包的东西直接导入 main 包中,效果相当于直接在 main 包声明的一样:

go
import (
	"fmt"
	. "proj/user"
)

func main() {
	p := Person{Name: "Zhang"}
	fmt.Println(p.Name)  // Zhang
}

还可以匿名导入,这样可以导入一个包,但是又不使用它,编译器也不会报错。

go
import (
	"fmt"
	_ "proj/user"
)

func main() {}

18.2 init

如果包中有 init 函数,那么在上面四种方式导入时,都会自动执行:

go
package person

type Person struct {
	Name string
}

// 在当前包被导入时自动执行
func init() {
	fmt.Println("init")
}

19 go modules

19.1 初始化模块

初始化一个新的模块,并创建 go.mod 文件。

shell
go mod init github.com/username/project

19.2 添加依赖

添加或更新依赖包到 go.mod 文件中。

shell
go get github.com/gin-gonic/gin@v1.7.4

19.3 移除未使用的依赖

清理 go.modgo.sum 文件,移除未使用的依赖,并添加缺失的依赖。

shell
go mod tidy

19.4 查看依赖关系

列出当前模块及其所有依赖。

shell
go list -m all

显示模块依赖图。

shell
go mod graph

19.5 下载依赖

下载 go.mod 中指定的所有模块。

shell
go mod download

19.6 查看帮助信息

shell
go help mod

# Go mod provides access to operations on modules.
#
# Note that support for modules is built into all the go commands,
# not just 'go mod'. For example, day-to-day adding, removing, upgrading,
# and downgrading of dependencies should be done using 'go get'.
# See 'go help modules' for an overview of module functionality.
#
# Usage:
#
# go mod <command> [arguments]
#
# The commands are:
#
# download    download modules to local cache
# edit        edit go.mod from tools or scripts
# graph       print module requirement graph
# init        initialize new module in current directory
# tidy        add missing and remove unused modules
# vendor      make vendored copy of dependencies
# verify      verify dependencies have expected content
# why         explain why packages or modules are needed
#
# Use "go help mod <command>" for more information about a command.

20 单元测试

Go 的单元测试主要依赖于 testing 包,并且通过 go test 命令来执行测试。

20.1 基本结构

测试文件必须以 _test.go 结尾,并且与被测试的代码文件位于同一包中。例如,有一个 math.go 文件,对应的测试文件应命名为 math_test.go

测试函数的名称必须以 Test 开头,并接受一个 *testing.T 类型的参数。例如:

go
func TestAdd(t *testing.T) {}

20.2 编写测试用例

假设有一个简单的 math 包,包含一个 Add 函数:

go
// math/math.go
package math

func Add(a, b int) int {
    return a + b
}

对应的测试文件 math_test.go 如下:

go
// math/math_test.go
package math

import "testing"

func TestAdd(t *testing.T) {
	result := Add(2, 3)
	expected := 5
	if result != expected {
		t.Errorf("Add(2, 3) = %d; want %d", result, expected)
	}
}

20.3 运行测试

在包含测试文件的目录下,运行以下命令即可执行所有测试:

shell
go test

使用 -v 标志可以查看详细的测试输出:

shell
go test -v

可以通过指定测试函数名称来运行特定的测试:

shell
go test -run TestAdd

20.4 性能测试

Go 支持基准测试(Benchmark Tests),用于衡量代码的性能。基准测试函数的名称必须以 Benchmark 开头,并接受一个 *testing.B 类型的参数。

go
// math/math_test.go
func BenchmarkAdd(b *testing.B) {
    for i := 0; i < b.N; i++ {
        Add(1, 2)
    }
}

使用 -bench 标志运行基准测试:

shell
go test -bench="."

# ok      learn/math      0.252s

这将运行所有基准测试。也可以指定特定的基准测试:

shell
go test -bench=BenchmarkAdd

# goos: windows
# goarch: amd64
# pkg: learn/math
# cpu: 13th Gen Intel(R) Core(TM) i5-13500H
# BenchmarkAdd-16         1000000000               0.1147 ns/op
# PASS
# ok      learn/math      0.407s

20.5 跳过用例

go
func TestAdd(t *testing.T) {
	if testing.Short() {
		t.Skip("skipping test in short mode.")
	}
	result := Add(2, 3)
	expected := 5
	if result != expected {
		t.Errorf("Add(2, 3) = %d; want %d", result, expected)
	}
}

使用 -short 标志跳过该测试用例:

shell
go test -short

20.6 表格驱动测试

go
func TestAdd(t *testing.T) {
	tests := []struct {
		a        int
		b        int
		expected int
	}{
		{6, 2, 8},
		{5, 0, 5},
		{-6, 2, -4},
	}
	for _, test := range tests {
		result := Add(test.a, test.b)
		if result != test.expected {
			t.Errorf("Add(%d, %d) = %d, want %d", test.a, test.b, result, test.expected)
		}
	}
}