Go作为编程语言中的后起之秀,在语言规范上吸收了诸多语言的优点,并形成了自身独特的语言风格。本文探讨一下Go语言的代码风格。

main方法

main 方法同样是go程序的入门函数,但是其定义非常简单,比如上一篇中的:

1func main() {
2	fmt.Println("Hello, world!")
3}

直接用 func 关键字定义一个名为 main 的方法即可,没有任何参数。

那么,如何获取传递给 main 的参数呢,可以使用 os.Args

1func main() {
2	fmt.Println("hello go!")
3	for i, arg := range os.Args {
4		fmt.Println(i, "=", arg)
5	}
6}

os.Args 获取命令行传递的参数,第一个始终为执行程序的名称,一个示例执行结果如下:

1$ go run main_func.go a b
2hello go!
30 = /var/folders/8b/y3pklwbs1wj_cq7hm_yjwgpr0000gn/T/go-build3458283994/b001/exe/main_func
41 = a
52 = b

当然,通常情况不会使用 os.Args 来解析命令行参数,而是使用 go 标准库的 flag 包。

go的关键字

go的内置关键字有25个:

1break        default      func         interface    select
2case         defer        go           map          struct
3chan         else         goto         package      switch
4const        fallthrough  if           range        type
5continue     for          import       return       var

这25个关键字不能作为标识符使用。

标识符命名

Go中的标识符同java一样,必须由字母、数字和下划线"_“组成,而且第一个不能为数字:

1func main() {
2	_a := 1
3	fmt.Println(_a)
4	b := 2
5	fmt.Println(b)
6	// 3c := 3 // 不能编译
7	你好 := 5
8	println(你好)
9}

有意思的是,除了25个关键字之外的合法标识符,只要不存在冲突,都可以作为标识符,比如包名也可以作为标识符:

1fmt := 4
2println(fmt)
3// fmt.println("a") // 不能编译

上边的代码定义了名为 fmt 的变量标识符,这是合法的,但是后续代码就不能只用 fmt 包了,而标识符声明之前的代码不受影响。

注释

go中有两种注释,比java少一种:

  • 单行注释: 使用 // 开头,注释一行
  • 多行注释:使用 /* ... */ 形式,可以用在行内注释

这两种注释与java相同,但是go中没有文档注释 /** ... */,而文档注释可以通过上边两种即可,而且注释中的关键信息如方法名称、类型名称等 go doc 工具会自动识别(goland中会高亮并可链接):

1// sayHello is a function to say hello with the giving name.
2func sayHello(name string) {
3	fmt.Println("hello, ", name)
4}

[[unused_var]]

未使用的变量和包

go是不允许导入了包不使用,或者声明了变量而未使用的,这些都会造成编译失败。

1func main() {
2	name, err := getName() // <1>
3	fmt.Println(name)
4}
5
6func getName() (string, error) {
7	return "huzhou", nil
8}

<1> 声明了变量err却不使用,编译错误

如果不需要使用变量,可以使用下划线 _ 来忽略这个标识符,这被称为 匿名变量,上边的错误代码修改为即可编译:

1name, _ := getName()

同样的,如果导入了包却不使用,也无法通过编译。有时候,我们需要导入包来做一些初始化,比如注册MySQL驱动,但是代码中又不使用,这时就需要使用 _ 让包导入却可以通过编译。比如,gorm框架中的导入mysql包的代码如下:

1_ "github.com/go-sql-driver/mysql"

这样成功导入了mysql驱动包,并可以执行 init 代码来注册驱动了:

.https://github.com/go-sql-driver/mysql/blob/master/driver.go[driver.go]

1func init() {
2	sql.Register("mysql", &MySQLDriver{})
3}

方法和变量的可见性

Go是通过标识符首字母大小写来控制可见性的,这点与java不同(publicprivateprotected、包访问权限default等)。标识符首字母大写的变量、常量、类型、方法等可以被外部其他模块访问,而首字母小写则意味着这些标识符只能内部私有,外部不可见。

比如,我定义了一个 user 模块:

1var Name = "huzhou"
2
3func getName() string {
4	return Name
5}
6
7func SayHello(name string) {
8	fmt.Println("hello, ", name)
9}

其中,Name 变量、SayHello 方法由于首字母大写,所以可以被外部其他模块访问,而 getName 只能在 user 模块内部访问:

 1func main() {
 2	name := user.Name
 3	fmt.Println(name)
 4
 5    // 不能访问,因为是包内部可见性
 6	// name = user.getName()
 7	// fmt.Println(name)
 8
 9	user.SayHello("huzhou")
10}

不支持方法重载

Go中没有方法重载,重名的方法名称会编译失败。比如下边的代码:

 1var data = make(map[int64]string)
 2
 3func init() {
 4	data[1] = "zhangsan"
 5	data[2] = "lisi"
 6	data[3] = "huzhou"
 7}
 8
 9func GetName(id int64) string {
10	return data[id]
11}

原有的 GetName 方法工作正常,现在如果想要增加一个 age 参数,或者返回值增加一个 error,我们肯定不希望在原来的方法上直接修改,这样会导致素有调用的代码都需要修改。我们希望重载两个方法,结果编译失败:

1func GetName(id int64) (string, error) {
2}
3
4func GetName(id int64, age int8) {
5}

新增的这两个方法都会由于方法重名了而导致编译失败,正确的做法是换一个方法名称。

Go中没有三元运算符

可能让初学者一开始很不习惯的是,Go中没有三元运算符,尤其是对已有其他语言经验的开发者而言。究其原因,Go官方认为,三元运算符会给开发者带来阅读障碍,他们认为许多开发者都存在三元运算符乱用的问题,比如在三元运算符中进行逻辑计算、三元运算符嵌套,甚至偷懒使用非常复杂的三元运算符替代 if...else... 语句,比如下边这样:

1isOdd(a) ? a + b : a * b
2isOdd(a) ? (a > 10 ? (a < 20 ? a * 2 : a * a) : a) : a / 2

尽管三元运算符可以减少代码量,但却让代码难以阅读,所以 Go 推荐使用 if 语句,而不提供三元运算符。

 1func main() {
 2    ...
 3	// 编译错误:go中没有三元运算符
 4	// user.Age = validAge(age) ? age: -1
 5	// 使用if语句代替三元运算符
 6	if validAge(age) {
 7		user.Age = age
 8	} else {
 9		user.Age = -1
10	}
11    ...
12}

当然,我们可以定义一个工具方法来实现三元运算效果:

1func Choose(b bool, v1 any, v2 any) any {
2	if b {
3		return v1
4	}
5	return v2
6}

使用时使用类型断言即可:

1ret := Choose(validAge(age), age, -1)
2user.Age = ret.(int) // 类型断言
3fmt.Printf("%v\n", user)

Go 1.18提供了泛型特性,我们也可以定义一个泛型方法来实现,这样就不需要断言了:

1func Choose1[T any](b bool, v1 T, v2 T) T {
2	if b {
3		return v1
4	}
5	return v2
6}

其他代码约束

分号的使用

Go中一行代码的末尾不需要分号 ;,写上分号尽管编译通过,但是显得多余。但是如果一行代码中有多个执行语句,此时需要分号隔开:

1func main() {
2	fmt.Println("Redundant semicolon"); // <1>
3	defer func() {
4		if err := recover(); err != nil { // <2>
5			fmt.Println("recovered")
6		}
7	}()
8}

<1> 分号是多余的 <2> if 中包括两个语句,需要 ; 隔开

条件判断不需要括号

if 语句判断条件是,不需要 ()

1func main() {
2	rand.Seed(time.Now().UnixNano())
3	a := rand.Intn(100)
4	 if (a%2 == 0) { // <1>
5		fmt.Println(a, " is an even number")
6	} else {
7		fmt.Println(a, " is an odd number")
8	}
9}

<1> 多余的小括号

大括号不能换行

Go中,大括号是不能另起一行的,这会造成编译失败。比如下边的代码会编译失败:

1func main()
2{
3}

总结

本文列举了一些 Go 的编码规范和代码风格,欢迎留言补充。

文本示例代码见 https://github.com/huzhouv/go-guide/tree/main/02-code-style[github]


相关阅读