go函数详解

函数定义

函数是组织好的、可重复使用的、用于执行指定任务的代码块。

Go 语言中支持：函数、匿名函数和闭包。

Go 语言中定义函数使用 func 关键字，具体格式如下：

func 函数名(参数)(返回值){
函数体
}

其中：

函数名：由字母、数字、下划线组成。但函数名的第一个字母不能是数字。在同一个包
内，函数名也称不能重名（包的概念详见后文）。
参数：参数由参数变量和参数变量的类型组成，多个参数之间使用,分隔。
返回值：返回值由返回值变量和其变量类型组成，也可以只写返回值的类型，多个返回值必须用()包裹，并用,分隔。
函数体：实现指定功能的代码块。

我们先来定义一个求两个数之和的函数：

func intSum(x int, y int) int {
	return x + y
}

函数的参数和返回值都是可选的，例如我们可以实现一个既不需要参数也没有返回值的函数：

func sayHello() {
fmt.Println("Hello World")
}

函数的调用

定义了函数之后，我们可以通过函数名()的方式调用函数。例如我们调用上面定义的两个函数，代码如下：

package main

import "fmt"

func intSum(x int, y int) int {
	return x + y
}

func sayHello() {
	fmt.Println("Hello World")
}
func main() {
	sayHello()
	ret := intSum(1, 2)
	fmt.Println(ret) // 3
}

注意，调用有返回值的函数时，可以不接收其返回值。

函数的参数

类型简写

函数的参数中如果相邻变量的类型相同，则可以省略类型，例如：

func intSum(x, y int) int {
	return x + y
}

上面的代码中，intSum 函数有两个参数，这两个参数的类型均为 int，因此可以省略 x 的类型，因为 y 后面有类型说明，x 参数也是该类型。

可变参数

可变参数是指函数的参数数量不固定。Go 语言中的可变参数通过在参数名后加…来标识。

注意：可变参数通常要作为函数的最后一个参数。

代码示例：

package main

import "fmt"

func intSum2(x ...int) int {
	fmt.Println(x) //x 是一个切片
	sum := 0
	for _, v := range x {
		sum = sum + v
	}
	return sum
}
func main() {
	ret1 := intSum2()
	ret2 := intSum2(10)
	ret3 := intSum2(10, 20)
	ret4 := intSum2(10, 20, 30)
	fmt.Println(ret1, ret2, ret3, ret4) //0 10 30 60
}

固定参数搭配可变参数使用时，可变参数要放在固定参数的后面，示例代码如下：

package main

import "fmt"

func intSum3(x int, y ...int) int {
	fmt.Println(x, y) // 
	sum := x
	for _, v := range y {
		sum = sum + v
	}
	return sum
}
func main() {
	ret5 := intSum3(100) // 100 []  可变参数是切片
	ret6 := intSum3(100, 10) // 100 [10]
	ret7 := intSum3(100, 10, 20) // 100 [10 20]
	ret8 := intSum3(100, 10, 20, 30) // 100 [10 20 30]
	fmt.Println(ret5, ret6, ret7, ret8) //100 110 130 160
}

本质上，函数的可变参数是通过切片来实现的。

函数返回值

Go 语言中通过 return 关键字向外输出返回值。

函数多返回值

Go 语言中函数支持多返回值，函数如果有多个返回值时必须用()将所有返回值包裹起来。

代码示例：

package main

import "fmt"

func calc(x, y int) (int, int) {
	sum := x + y
	sub := x - y
	return sum, sub
}
func main() {
	sum, sub := calc(2, 1)
	fmt.Println(sum, sub) // 3 1
}

返回值命名

函数定义时可以给返回值命名，并在函数体中直接使用这些变量，最后通过 return 关键字返回。

代码示例：

package main

import "fmt"

func calc(x, y int) (sum int, sub int) {
	sum = x + y
	sub = x - y
	return
}
func main() {
	sum, sub := calc(2, 1)
	fmt.Println(sum, sub) // 3 1
}

函数变量作用域

全局变量

全局变量是定义在函数外部的变量，它在程序整个运行周期内都有效。在函数中可以访问到全局变量。

代码示例：

package main

import "fmt"

// 定义全局变量 num
var num int64 = 10

func testGlobalVar() {
	fmt.Printf("num=%d\n", num) //函数中可以访问全局变量 num
}

func main() {
	testGlobalVar() //num=10
}

局部变量

局部变量是函数内部定义的变量，函数内定义的变量无法在该函数外使用。

函数内定义的变量无法在该函数外使用

例如下面的示例代码 main 函数中无法使用 testLocalVar 函数中定义的变量 x：

package main

import "fmt"

func testLocalVar() {
	//定义一个函数局部变量 x,仅在该函数内生效
	var x int64 = 100
	fmt.Printf("x=%d\n", x)
}

func main() {
	testLocalVar() // x=100
	//fmt.Println(x) // 此时无法使用变量 x
}

如果局部变量和全局变量重名，优先访问局部变量

package main

import "fmt"

// 定义全局变量 num
var num int64 = 10

func testNum() {
	num := 100
	fmt.Printf("num=%d\n", num) // 函数中优先使用局部变量
}

func main() {
	testNum() // num=100
}

接下来我们来看一下语句块定义的变量，通常我们会在 if 条件判断、for 循环、switch 语句上使用这种定义变量的方式。

package main

import "fmt"

func testLocalVar2(x, y int) {
	fmt.Println(x, y) //函数的参数也是只在本函数中生效
	if x > 0 {
		z := 100 //变量 z 只在 if语句块生效
		fmt.Println(z)
	}
	//fmt.Println(z)//此处无法使用变量 z
}
func main() {
	testLocalVar2(1, 2) 
}

同理 for 循环语句中定义的变量，也是只在 for语句块中生效：

package main

import "fmt"

func testLocalVar3() {
	for i := 0; i < 10; i++ {
		fmt.Println(i) //变量 i 只在当前 for 语句块中生效
	}
	//fmt.Println(i) //此处无法使用变量 i
}
func main() {
	testLocalVar3()
}

函数类型与变量

定义函数类型

我们可以使用 type 关键字来定义一个函数类型，具体格式如下：

type calculation func(int, int) int

上面语句定义了一个 calculation 类型，它是一种函数类型，这种函数接收两个 int 类型的参数并且返回一个 int 类型的返回值。

简单来说，凡是满足这个条件的函数都是 calculation 类型的函数，例如下面的 add 和 sub 是calculation 类型。

package main

import "fmt"

type calculation func(int, int) int

func add(x, y int) int {
	return x + y
}
func sub(x, y int) int {
	return x - y
}

func main() {
	var a calculation
	a = add
	fmt.Println(a(2, 1)) // 3
	var b calculation
	b = sub
	fmt.Println(b(2, 1)) // 1

}

函数类型变量

我们可以声明函数类型的变量并且为该变量赋值：

package main

import "fmt"

type calculation func(int, int) int

func add(x, y int) int {
	return x + y
}
func sub(x, y int) int {
	return x - y
}

func main() {
	var c calculation               // 声明一个 calculation 类型的变量 c
	c = add                         // 把 add 赋值给 c
	fmt.Printf("type of c:%T\n", c) // type of c:main.calculation
	fmt.Println(c(1, 2))            // 像调用 add 一样调用 c
	f := sub                        // 将函数 sub 赋值给变量 f1
	fmt.Printf("type of f:%T\n", f) // type of f:func(int, int) int
	fmt.Println(f(20, 10))          // 像调用 sub 一样调用 f

}

高阶函数

高阶函数分为函数作为参数和函数作为返回值两部分。

函数作为参数

函数可以作为参数：

package main

import "fmt"

func add(x, y int) int {
	return x + y
}
func calc(x, y int, op func(int, int) int) int {
	return op(x, y)
}

func main() {
	ret2 := calc(10, 20, add)
	fmt.Println(ret2) //30
}

函数作为返回值

函数也可以作为返回值：

package main

import "fmt"

func add(x, y int) int {
	return x + y
}
func sub(x, y int) int {
	return x - y
}
func do(s string) func(int, int) int {
	switch s {
	case "+":
		return add
	case "-":
		return sub
	default:
		return nil
	}
}

func main() {
	var a = do("+")
	fmt.Println(a(10, 20)) // 30
}

匿名函数和闭包

匿名函数

函数可以作为返回值，但是在 Go 语言中函数内部不能再像之前那样定义函数了，只能定义匿名函数。匿名函数就是没有函数名的函数，匿名函数的定义格式如下：

func(参数)(返回值){
函数体
}

匿名函数因为没有函数名，所以没办法像普通函数那样调用，所以匿名函数需要保存到某个变量或者作为立即执行函数:

package main

import "fmt"

func main() {
	// 将匿名函数保存到变量
	add := func(x, y int) {
		fmt.Println(x + y) // 30
	}
	add(10, 20) // 通过变量调用匿名函数
	//自执行函数：匿名函数定义完加()直接执行
	func(x, y int) {
		fmt.Println(x + y) // 30
	}(10, 20)
}

匿名函数多用于实现回调函数和闭包。

闭包

闭包可以理解成“定义在一个函数内部的函数“。在本质上，闭包是将函数内部和函数外部连接起来的桥梁。或者说是函数和其引用环境的组合体。首先我们来看一个例子：

package main

import "fmt"

func adder() func(int) int {
	var x int
	return func(y int) int {
		x += y
		return x
	}
}
func main() {
	var f = adder()
	fmt.Println(f(10)) //10
	fmt.Println(f(20)) //30
	fmt.Println(f(30)) //60
	f1 := adder()
	fmt.Println(f1(40)) //40
	fmt.Println(f1(50)) //90
}

变量 f 是一个函数并且它引用了其外部作用域中的 x 变量，此时 f 就是一个闭包。在 f 的生命周期内，变量 x 也一直有效。

闭包其实并不复杂，只要牢记闭包=函数+引用环境。

defer语句

Go 语言中的 defer 语句会将其后面跟随的语句进行延迟处理。在 defer 归属的函数即将返回时，将延迟处理的语句按 defer 定义的逆序进行执行，也就是说，先被 defer 的语句最后被执行，最后被 defer 的语句，最先被执行。

代码示例：

package main

import "fmt"

func main() {
	fmt.Println("start")
	defer fmt.Println(1)
	defer fmt.Println(2)
	defer fmt.Println(3)
	fmt.Println("end")
}

结果：

start
end
3
2
1

由于 defer 语句延迟调用的特性，所以 defer 语句能非常方便的处理资源释放问题。比如：资源清理、文件关闭、解锁及记录时间等。

defer执行时机

在 Go 语言的函数中 return 语句在底层并不是原子操作，它分为给返回值赋值和 RET 指令两步。而 defer 语句执行的时机就在返回值赋值操作后，RET 指令执行前。具体如下图所示：

在这里插入图片描述

RET 指令是指机器层面或汇编层面的一个指令，用于实现函数调用后的返回操作。具体来说，RET 指令的作用是从当前函数返回到调用者的位置继续执行代码。

defer案例

案例1：defer与命名返回值

代码示例：

package main

import "fmt"

func f1() int {
	x := 5
	defer func() {
		x++
	}()
	return x
}
func f2() (x int) {
	defer func() {
		x++
	}()
	return 5
}
func f3() (y int) {
	x := 5
	defer func() {
		x++
	}()
	return x
}
func f4() (x int) {
	defer func(x int) {
		x++
	}(x)
	return 5
}
func main() {
	fmt.Println(f1())
	fmt.Println(f2())
	fmt.Println(f3())
	fmt.Println(f4())
}

代码详解：
这段代码展示了 Go 语言中 defer 语句与命名返回值、匿名返回值的不同交互方式。让我们逐一分析每个函数：

（1）f1 函数：

定义了一个局部变量 x 并初始化为 5。
使用 defer 来延迟执行一个匿名函数，在这个匿名函数中对 x 进行自增操作。
返回 x 的初始值 5，但由于 defer 在返回前执行，因此会先将 x 自增为 6。
然而，由于 x 不是命名返回值，所以最终返回的仍然是 5。

（2）f2 函数：

返回值被命名为 x 并且没有在函数体中再次赋值（直接在 return 语句中设置为 5）。
同样使用 defer 来延迟执行一个匿名函数，在该匿名函数中对命名返回值 x 进行自增操作。
当 return 5 执行时，首先将返回值 x 设置为 5，然后执行 defer 中的内容，将 x 增加到 6。
因此，最终返回的结果是 6。

（3） f3 函数：

定义了一个局部变量 x 并初始化为 5，同时定义了命名返回值 y。
使用 defer 来延迟执行一个匿名函数，在该匿名函数中对局部变量 x 进行自增操作。
在 return x 时，返回的是局部变量 x 的值，而 defer 操作只影响局部变量 x，并不会影响命名返回值 y。
因此，尽管 x 在 defer 中被增加到了 6，但返回的仍是 x 初始值 5，因为 y 没有受到影响。

（4） f4 函数：

定义了命名返回值 x，并使用 defer 调用一个带有参数的匿名函数，在该匿名函数中对传入的参数进行自增操作。
参数 x 是按值传递的，因此在 defer 中的操作不会影响到外部的 x。
当 return 5 执行时，返回值 x 被设置为 5，并且 defer 中的操作仅影响到它自己的参数副本，不影响实际的返回值。
最终返回的结果是 5。

综上所述，这些例子主要展示了 Go 语言中 defer 语句与命名返回值和非命名返回值之间的互动。特别是要注意，defer 内部修改的是局部变量还是命名返回值，这直接影响到函数的最终返回结果。

案例2

代码示例：

package main

import "fmt"

func calc(index string, a, b int) int {
	ret := a + b
	fmt.Println(index, a, b, ret)
	return ret
}
func main() {
	x := 1
	y := 2
	defer calc("AA", x, calc("A", x, y))
	x = 10
	defer calc("BB", x, calc("B", x, y))
	y = 20
}

代码详解：
这段代码展示了 Go 语言中 defer 语句的使用及其执行顺序。让我们逐步解析这段代码的执行过程：

（1） 初始化变量：在 main 函数开始时，定义了两个整型变量 x 和 y 并分别初始化为 1 和 2。

（2） 第一个 defer 调用：

执行到 defer calc("AA", x, calc("A", x, y)) 这一行。
根据 Go 中 defer 的特性，参数会在 defer 语句被执行时立即求值，而不是等到 defer 对应的函数实际执行时才计算。
因此，首先会调用 calc("A", x, y)，此时 x=1 和 y=2，所以它打印出 "A 1 2 3" 并返回 3。
然后，将 defer calc("AA", x, 3) 加入到延迟调用栈中（注意这里的 x 仍然是 1，因为这是在 x=10 之前计算的）。

（3） 修改 x 的值：将 x 修改为 10。

（4） 第二个 defer 调用：

接下来是 defer calc("BB", x, calc("B", x, y))。
同样地，先计算参数，首先调用 calc("B", x, y)，这时 x=10 和 y=2，因此打印 "B 10 2 12" 并返回 12。
然后，将 defer calc("BB", 10, 12) 加入到延迟调用栈中（这里的 x 是 10，因为这是在 x=10 之后计算的）。

（5） 修改 y 的值：将 y 修改为 20，但这对已经加入到延迟调用栈中的函数没有影响，因为它们的参数值已经被确定。

（6） 主函数结束：当 main 函数即将结束时，延迟调用栈中的函数会按照后进先出的顺序执行：

首先执行 calc("BB", 10, 12)，打印 "BB 10 12 22"。
然后执行 calc("AA", 1, 3)，打印 "AA 1 3 4"。

综上所述，程序的实际输出将会是：

A 1 2 3
B 10 2 12
BB 10 12 22
AA 1 3 4

这段代码很好地演示了 Go 语言中 defer 语句的行为，特别是参数预计算的特点以及延迟调用按逆序执行的规则。

内置函数（panic/recover）

在这里插入图片描述
Go 语言中目前（Go1.12）是没有异常机制，但是使用 panic/recover 模式来处理错误。 panic可以在任何地方引发，但 recover 只有在 defer 调用的函数中有效。首先来看一个例子：

panic/recover 的基本使用

代码示例：

package main

import "fmt"

func funcA() {
	fmt.Println("func A")
}
func funcB() {
	panic("panic in B")
}
func funcC() {
	fmt.Println("func C")
}
func main() {
	funcA()
	funcB()
	funcC()
}

结果：

func A
panic: panic in B

goroutine 1 [running]:
main.funcB(...)
	D:/project/go-project/cmd/main.go:9
main.main()
	D:/project/go-project/cmd/main.go:16 +0x5b

程序运行期间 funcB 中引发了 panic 导致程序崩溃，异常退出了。这个时候我们就可以通过recover 将程序恢复回来，继续往后执行。

示例代码：

package main

import "fmt"

func funcA() {
	fmt.Println("func A")
}
func funcB() {
	defer func() {
		err := recover()
		//如果程序出出现了 panic 错误,可以通过 recover 恢复过来
		if err != nil {
			fmt.Println("recover in B")
		}
	}()
	panic("panic in B")
}
func funcC() {
	fmt.Println("func C")
}
func main() {
	funcA()
	funcB()
	funcC()
}

运行结果：

func A
recover in B
func C

注意：

recover()必须搭配 defer 使用。
defer 一定要在可能引发 panic

defer 、recover 实现异常

package main

import "fmt"

func fn2(num1 int, num2 int) int {
	defer func() {
		err := recover()
		if err != nil {
			fmt.Println("抛出异常给管理员发送邮件")
			fmt.Println(err)
		}
	}()
	res := num1 / num2
	return res
}

func main() {
	fmt.Println(fn2(1, 0))
}

结果：

抛出异常给管理员发送邮件
runtime error: integer divide by zero
0

defer 、panic、recover 抛出异常

package main

import (
	"errors"
	"fmt"
)

func readFile(fileName string) error {
	if fileName == "main.go" {
		return nil
	}
	return errors.New("读取文件错误")
}
func fn3() {
	defer func() {
		err := recover()
		if err != nil {
			fmt.Println("抛出异常给管理员发送邮件")
		}
	}()
	var err = readFile("xxx.go")
	if err != nil {
		panic(err)
	}
	fmt.Println("继续执行")
}
func main() {
	fn3()
}

结果：

抛出异常给管理员发送邮件

参考文献

https://go.dev/doc/tutorial/getting-started

https://gobyexample.com/

https://www.w3schools.com/go/

https://go.dev/doc/tutorial/

https://www.geeksforgeeks.org/golang-tutorial-learn-go-programming-language/

go函数详解

函数定义

函数的调用

函数的参数

函数返回值

函数变量作用域

函数类型与变量

高阶函数

匿名函数和闭包

defer语句

内置函数（panic/recover）

参考文献

悦读