Go 语言命名规范整理

tl.s

2022 年 11 月 08 日

205 次浏览

暂无评论

988字数

技术笔记

GO 语言精简命名规范汇集.

本文内容整理自《Go语言精进之路：从新手到高手的编程思想、方法和技巧

1》。

GO 语言语法简单，容易上手，相关的代码风格约束也相对较少。但查阅网络发现排在前几的都总结的不是很好。

正好前期阅读了《Go语言精进之路：从新手到高手的编程思想、方法和技巧1》这本书，受益匪浅，特将其中命名规范部分做了整理分享出来，详情还是建议大家找来原书阅读。

下面是较重要的几条规范，推荐阅读。

1、包

对于Go中的包（package），一般建议以小写形式的单个单词命名。

原则：

包名应尽量与包导入路径（import path）的最后一个路径分段保持一致；
仅要考虑包自身的名字，还要兼顾该包导出的标识符（如变量、常量、类型、函数等）的命名。

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

Go语言官方要求标识符命名采用驼峰命名法（CamelCase）

原则：

为变量、类型、函数和方法命名时以简单、短小为首要原则；
保持变量声明与使用之间的距离越近越好，或者在第一次使用变量之前声明该变量；
变量名字中不要带有类型信息（原因见原则2）；
保持简短命名变量含义上的一致性，例如：

i -> index,
v -> value,
k -> key,
t -> time,
b -> byte

特征：

循环和条件变量多采用单个字母命名（如 i, j, k, v ）；
函数/方法的参数和返回值变量以单个单词或单个字母为主；
方法的命名以单个单词为主；
函数多以多单词的复合词进行命名；
类型多以多单词的复合词进行命名。

3、常量

原则：

常量多使用多单词组合的方式命名；
可以对名称本身就是全大写的特定常量使用全大写的名字 (如 PI )。

举例：

// $GOROOT/src/net/http/request.go

const (
    defaultMaxMemory = 32 << 20 // 32 MB
)

// $GOROOT/src/math/sin.go
const (
    PI4A = 7.85398125648498535156E-1  // 0x3fe921fb40000000,
    PI4B = 3.77489470793079817668E-8  // 0x3e64442d00000000,
    PI4C = 2.69515142907905952645E-15 // 0x3ce8469898cc5170,
)

// $GOROOT/src/syscall/zerrors_linux_amd64.go
// 信号
const (
    SIGABRT   = Signal(0x6)
    SIGALRM   = Signal(0xe)
    SIGBUS    = Signal(0x7)
    SIGCHLD   = Signal(0x11)
    ...
)

4、接口

原则：

Go语言的惯例是用“ 方法名+er ”命名；
Go语言推荐尽量定义小接口，并通过接口组合的方式构建程序。

举例：

// $GOROOT/src/io/io.go

type Writer interface {
    Write(p []byte) (n int, err error)
}

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

type Closer interface {
    Close() error
}

type ReadWriteCloser interface {
    Reader
    Writer
    Closer
}