计算机科学中只有两件难事:缓存失效和命名。

命名是编程语言的要求,但是好的命名却是为了提高程序的可读性和可维护性。好的命名是什么样子的呢?Go语言的贡献者和布道师Dave Cheney给出了一个说法:“一个好笑话,如果你必须解释它,那就不好笑了。好的命名也类似。”无论哪门编程语言,良好的命名都应该遵循一些通用的原则,但就像之前提到的“语言影响思维”的假说那样,不同的编程语言会有一些个性化的命名惯例。

在gofmt的帮助下,Go语言统一了代码风格标准,Gopher再也无须为括号摆放位置、使用制表符还是空格、是否对齐赋值操作等而争论了。在这种情况下,命名成了广大Gopher为数不多可以“自由发挥”的空间。不过关于命名,Go语言也有自己期望大家共同遵循的原则。

下面将详细阐述这两个原则以及在这两个原则下的一些命名惯例。

简单且一致

对于简单,我们最直观的理解就是“短小”,但这里的简单还包含着清晰明确这一前提。

下面是Go语言中一些常见类别标识符的命名惯例。

1. 包

对于Go中的包(package),一般建议以小写形式的单个单词命名。Go标准库在这方面给我们做出了很好的示范

在这里插入图片描述

我们在给包命名时不要有是否与其他包重名的顾虑,因为在Go中,包名可以不唯一。

比如:foo项目有名为log的包,bar项目也可以有自己的名为log的包。

示例如下。

import "github.com/bigwhite/foo/log" // log.XX中的log指代github.com/ bigwhite/foo/log下的包
import barlog "github.com/bigwhite/bar/log" // barlog这个显式包名指代git

Go语言建议,包名应尽量与包导入路径(import path)的最后一个路径分段保持一致。

比如:包导入路径golang.org/x/text/encoding的最后路径分段是encoding,该路径下包名就应该为encoding。

但在实际情况中,包名与导入路径最后分段不同的也有很多。
比如:实时分布式消息队列NSQ的官方客户端包的导入路径为github.com/nsqio/go-nsq,但是该路径下面的包名却是nsq。笔者分析这主要是为了用仓库名称强调该实现是针对Go语言的,比如go-nsq的意义是这是一份Go语言实现的NSQ客户端API库,为的是与nsq-java、pynsq、rust-nsq等其他语言的客户端API进行显式区分。

此外,我们在给包命名的时候,不仅要考虑包自身的名字,还要兼顾该包导出的标识符(如变量、常量、类型、函数等)的命名。

2. 变量、类型、函数和方法

一个Go工程中包的数量是有限的,变量、类型、函数和方法的命名占据了命名工作的较大比重。

Go语言官方要求标识符命名采用驼峰命名法(CamelCase),以变量名为例,如果变量名由一个以上的词组合构成,那么这些词之间紧密相连,不使用任何连接符(如下划线)。

驼峰命名法有两种形式:

1)一种是第一个词的首字母小写,后面每个词的首字母大写,叫作“小骆峰拼写法”(lowerCamelCase),这也是在Go中最常见的标识符命名法;

2)而 第 一 个 词 的 首 字 母 以 及 后 面 每 个 词 的 首 字 母 都 大 写, 叫 作“大 驼 峰 拼 写法”(UpperCamelCase),又称“帕斯卡拼写法”(PascalCase)。

3)由于首字母大写的标识符在Go语言中被视作包导出标识符,因此只有在涉及包导出的情况下才会用到大驼峰拼写法。不过如果缩略词的首字母是大写的,那么其他字母也要保持全部大写,比如HTTP(Hypertext Transfer Protocol)、CBC(Cipher Block Chaining)等

为变量、类型、函数和方法命名时依然要以简单、短小为首要原则。

感受一下Go命名惯例带来的效果:

// 不好的命名
func RuneCount(buffer []byte) int {
runeCount := 0
for index := 0; index < len(buffer); {
if buffer[index] < RuneSelf {
index++
} else {
_, size := DecodeRune(buffer[index:])
index += size
}
runeCount++
}
return runeCount
}
// 好的命名
func RuneCount(b []byte) int {
count := 0
for i := 0; i < len(b); {
if b[i] < RuneSelf {
 i++
} else {
_, n := DecodeRune(b[i:])
i += n
}
count++
}
return count
}

Go语言命名惯例深受C语言的影响,这与Go语言之父有着深厚的C语言背景不无关系。

Logo

开放原子开发者工作坊旨在鼓励更多人参与开源活动,与志同道合的开发者们相互交流开发经验、分享开发心得、获取前沿技术趋势。工作坊有多种形式的开发者活动,如meetup、训练营等,主打技术交流,干货满满,真诚地邀请各位开发者共同参与!

更多推荐