Go 语言变量命名规范详解-CSDN博客

1. 引言

在 Go 语言中，命名规范不仅仅是代码风格问题，更是语言设计哲学和社区共识的体现。清晰、一致的命名能显著提升代码的可读性、可维护性，并有助于工具（如 gofmt、go vet）进行静态分析。本文将系统性地介绍 Go 语言中变量、常量、函数、类型等标识符的命名规范，并结合官方建议和社区最佳实践，帮助你写出更地道的 Go 代码。

2. 核心命名原则

Go 语言的命名遵循几个核心原则，这些原则由官方工具 gofmt 强制执行或强烈推荐。

2.1 使用混合大小写（MixedCaps / CamelCase）

Go 语言不使用下划线（snake_case）来分隔多个单词。

导出标识符（Public）：使用 PascalCase（又称大驼峰式）。首字母大写意味着该标识符在包外可见。
```
// 包外可访问
var ServerPort int
func CalculateTotal() {}
type UserProfile struct {}
```
非导出标识符（Private）：使用 camelCase（又称小驼峰式）。首字母小写，仅在当前包内可见。
```
// 仅在包内可访问
var maxRetries int
func internalHelper() {}
type localConfig struct {}
```

2.2 保持简洁

Go 崇尚简洁。在作用域小的局部变量中，使用短名称通常比长名称更好。

好的实践：

for i := 0; i < 10; i++ { // `i` 是索引的标准命名
    // ...
}

func Sum(list []int) int {
    s := 0 // `s` 作为求和的临时变量很清晰
    for _, v := range list {
        s += v
    }
    return s
}

应避免：

for indexCounter := 0; indexCounter < 10; indexCounter++ {
    // 过于冗长
}

2.3 保持一致性

在同一个包或上下文中，对相同概念的命名应保持一致。例如，如果你用 offset 表示偏移量，就不要在另一个函数里用 skew 表示相同的含义。

3. 各类标识符命名细则

3.1 变量（Variables）

局部变量：使用简洁的 camelCase。在短小的作用域内（如循环、短函数），单字母名称（i, j, k 用于索引；r 用于 io.Reader；b 用于字节切片）是可接受的。
```
userCount := 10
buf := make([]byte, 1024)
for idx, item := range items {
    // ...
}
```

参数与返回值：同样使用 camelCase。返回值命名应具有描述性，尤其是多个返回值时。

func ReadConfig(path string) (config Config, err error) {
    // `config` 和 `err` 是命名的返回值
}

包级变量：使用更具描述性的 camelCase 名称，因为它们的作用域更广。

var defaultTimeout = 30 * time.Second
var mu sync.Mutex // `mu` 是互斥锁的惯用短名

3.2 常量（Constants）

使用 MixedCaps，与变量规则相同。

对于枚举类型的常量，或一组相关的常量，通常使用前缀来分组。

const (
    StatusOK = 200
    StatusNotFound = 404
    StatusInternalError = 500
)

const (
    LogLevelDebug = iota
    LogLevelInfo
    LogLevelWarn
    LogLevelError
)

3.3 函数与方法（Functions & Methods）

函数名：通常使用动词或动词短语，采用 MixedCaps。导出函数用 PascalCase，非导出函数用 camelCase。
```
func GetUserByID(id int) (*User, error) // 导出
func validateInput(input string) error   // 非导出
```

Getter 方法：Go 不强制使用 Get 前缀。如果某个方法主要是获取一个字段的值，通常直接以字段名命名（首字母大写）。

type Person struct {
    name string
    age  int
}
func (p *Person) Name() string { // 而不是 GetName
    return p.name
}

Setter 方法：使用 Set 前缀。

func (p *Person) SetName(name string) {
    p.name = name
}

3.4 类型（Types）

类型名：使用 PascalCase（单数名词）。应具有描述性。

type CustomerOrder struct {}
type Distance float64        // 类型别名
type HandlerFunc func()      // 函数类型

接口名：通常以 -er 结尾。如果接口只包含一个方法，则方法名加上 -er 是常见做法。

type Reader interface {
    Read(p []byte) (n int, err error)
}
type Stringer interface {
    String() string
}

3.5 包（Packages）

包名：使用简短、小写、单数的名词。避免下划线和混合大小写。
- net/http (好)
- encoding/json (好)
- util (可以，但应谨慎使用，避免过于泛化)
- myPackage 或 my_package (不好)
包名是其所有导出标识符名称的一部分。调用时 包名.标识符 应读起来自然。
```
bytes.Buffer  // 好：`bytes` 包下的 `Buffer` 类型
strings.ToUpper // 好
```

4. 特殊约定与惯用法

4.1 缩写词

缩写词应保持全大写或全小写，而不是仅首字母大写。

正确：URL, HTTP, ID, jsonAPI
应避免：Url, Http, Id, JsonApi

4.2 错误变量

错误变量通常以 Err 开头。

var ErrNotFound = errors.New("not found")
var ErrInvalidInput = errors.New("invalid input")

4.3 测试文件

测试文件的命名是在源文件后加 _test.go。测试函数名以 Test 开头，后接被测试函数/功能名，且首字母大写。

// 文件：calculator_test.go
func TestAdd(t *testing.T) {
    // ...
}
func TestDivide_ByZero(t *testing.T) {
    // ...
}

4.4 循环变量

i, j, k：用于整数索引。
r：常用于 io.Reader。
b：常用于字节切片 ([]byte)。
v：在 for range 循环中代表值。

5. 工具与检查

gofmt：Go 官方代码格式化工具。必须使用。它会自动调整代码布局，但不会重命名标识符。确保你的编辑器在保存时自动运行 gofmt。
golint / revive / staticcheck：这些是代码检查工具（Linter），可以捕获不符合命名规范（如导出函数缺少注释、包名不佳等）和其他风格问题的问题。建议集成到开发流程中。