GolangNote

Golang笔记

公司内部 Golang 编码规范参考

Permalink

此文是作者所在团队约定的编码规范,力图与官方及社区编码风格保持一致。

公司内部 Golang 编码规范参考

参考官方指南Effective GolangGolang Code Review Comments

gofmt

大部分的格式问题可以通过gofmt解决,gofmt自动格式化代码,保证所有的go代码一致的格式。

正常情况下,采用Sublime编写go代码时,插件GoSublilme已经调用gofmt对代码实现了格式化。

注释

在编码阶段同步写好变量、函数、包注释,注释可以通过godoc导出生成文档。

注释必须是完整的句子,以需要注释的内容作为开头,句点作为结尾。

程序中每一个被导出的(大写的)名字,都应该有一个文档注释。

包注释

每个程序包都应该有一个包注释,一个位于package子句之前的块注释或行注释。

包如果有多个go文件,只需要出现在一个go文件中即可。

Go: 包注释
1
2
3
//Package regexp implements a simple library 
//for regular expressions.
package regexp

可导出类型

第一条语句应该为一条概括语句,并且使用被声明的名字作为开头。

Go: 可导出类型
1
2
3
// Compile parses a regular expression and returns, if successful, a Regexp
// object that can be used to match against text.
func Compile(str string) (regexp *Regexp, err error) {

命名

使用短命名,长名字并不会自动使得事物更易读,文档注释会比格外长的名字更有用。

包名

包名应该为小写单词,不要使用下划线或者混合大小写。

接口名

单个函数的接口名以"er"作为后缀,如Reader,Writer

接口的实现则去掉“er”

Go: interface
1
2
3
type Reader interface {
        Read(p []byte) (n int, err error)
}

两个函数的接口名综合两个函数名

Go: 接口名
1
2
3
4
type WriteFlusher interface {
    Write([]byte) (int, error)
    Flush() error
}

三个以上函数的接口名,类似于结构体名

Go: 三个以上函数的接口名
1
2
3
4
5
type Car interface {
    Start([]byte) 
    Stop() error
    Recover()
}

混合大小写

采用驼峰式命名

Go: 驼峰式命名
1
2
MixedCaps 大写开头可导出
mixedCaps 小写开头不可导出

变量

plaintext: 变量
1
2
3
全局变量:驼峰式,结合是否可导出确定首字母大小写
参数传递:驼峰式,小写字母开头
局部变量:下划线形式

控制结构

if

if 接受初始化语句,约定如下方式建立局部变量

Go: if 语句
1
2
3
if err := file.Chmod(0664); err != nil {
    return err
}

for

采用短声明建立局部变量

Go: for 语句
1
2
3
4
sum := 0
for i := 0; i < 10; i++ {
    sum += i
}

range

如果只需要第一项(key),就丢弃第二个:

Go: range
1
2
3
4
5
for key := range m {
    if key.expired() {
        delete(m, key)
    }
}

如果只需要第二项,则把第一项置为下划线

Go: range
1
2
3
4
sum := 0
for _, value := range array {
    sum += value
}

return

尽早return:一旦有错误发生,马上返回

Go: return
1
2
3
4
5
6
7
8
9
10
f, err := os.Open(name)
if err != nil {
    return err
}
d, err := f.Stat()
if err != nil {
    f.Close()
    return err
}
codeUsing(f, d)

函数(必须)

函数采用命名的多值返回

传入变量和返回变量以小写字母开头

Go: 变量名
1
func nextInt(b []byte, pos int) (value, nextPos int) {

在godoc生成的文档中,带有返回值的函数声明更利于理解

错误处理

  • error作为函数的值返回,必须对error进行处理
  • 错误描述如果是英文必须为小写,不需要标点结尾
  • 采用独立的错误流进行处理

不要采用这种方式

Go: 不正确姿势错误处理
1
2
3
4
5
if err != nil {
    // error handling
} else {
    // normal code
}

而要采用下面的方式

Go: 正确姿势处理错误
1
2
3
4
5
6
if err != nil {
    // error handling
    return // or continue, etc.
}
// normal code

如果返回值需要初始化,则采用下面的方式

Go: 返回值初始化
1
2
3
4
5
6
7
x, err := f()
if err != nil {
    // error handling
    return
}
// use x

panic

尽量不要使用 panic,除非你知道你在做什么

import

对 import 的包进行分组管理,而且标准库作为第一组

Go: import分组管理
1
2
3
4
5
6
7
8
9
10
11
12
13
package main

import (
    "fmt"
    "hash/adler32"
    "os"

    "appengine/user"
    "appengine/foo"

    "code.google.com/p/x/y"
    "github.com/foo/bar"
)

goimports 实现了自动格式化

缩写

采用全部大写或者全部小写来表示缩写单词

比如对于url这个单词,不要使用 UrlPony,而要使用 urlPony 或者 URLPony

参数传递

  • 对于少量数据,不要传递指针
  • 对于大量数据的struct可以考虑使用指针
  • 传入参数是map,slice,chan不要传递指针

因为map,slice,chan是引用类型,不需要传递指针的指针

接受者

名称

统一采用单字母'p'而不是this,me或者self

Go: 接受者名称
1
2
type T struct{} 
func (p *T)Get(){}

类型

对于go初学者,接受者的类型如果不清楚,统一采用指针型

Go: 接受者类型-建议
1
func (p *T)Get(){}

而不是

Go: go 接受者类型-不建议
1
func (p T)Get(){}

在某些情况下,出于性能的考虑,或者类型本来就是引用类型,有一些特例

如果接收者是 map,slice或者chan,不要用指针传递

Go: 引用类型
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
//Map
package main

import (
    "fmt"
)

type mp map[string]string

func (m mp) Set(k, v string) {
    m[k] = v
}

func main() {
    m := make(mp)
    m.Set("k", "v")
    fmt.Println(m)
}

//Channel
package main

import (
    "fmt"
)

type ch chan interface{}

func (c ch) Push(i interface{}) {
    c <- i
}

func (c ch) Pop() interface{} {
    return <-c
}

func main() {
    c := make(ch, 1)
    c.Push("i")
    fmt.Println(c.Pop())
}

如果需要对slice进行修改,通过返回值的方式重新赋值

Go: slice修改
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
//Slice
package main

import (
    "fmt"
)

type slice []byte

func main() {
    s := make(slice, 0)
    s = s.addOne(42)
    fmt.Println(s)
}

func (s slice) addOne(b byte) []byte {
    return append(s, b)
}

如果接收者是含有sync.Mutex或者类似同步字段的结构体,必须使用指针传递避免复制

Go: Mutex 必须使用指针传递避免复制
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
package main

import (
    "sync"
)

//Channel
package main

import (
    "fmt"
)

type ch chan interface{}

func (c ch) Push(i interface{}) {
    c <- i
}

func (c ch) Pop() interface{} {
    return <-c
}

func main() {
    c := make(ch, 1)
    c.Push("i")
    fmt.Println(c.Pop())
}

如果接收者是大的结构体或者数组,使用指针传递会更有效率。

Go: 大的结构体或者数组,使用指针传递会更有效率
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
package main

import (
    "fmt"
)

type T struct {
    data [1024]byte
}

func (t *T) Get() byte {
    return t.data[0]
}

func main() {
    t := new(T)
    fmt.Println(t.Get())
}

Related articles

Golang 单实例实现网站多域名请求

有时候写网站,为了统一的后端,把不同业务都集中到一个后端,这时就需要处理多域名的请求,在 Go http server 里实现很简单,只需把不同域名映射到不同的 `http.Handler`。...

golang共享数据用Mutex 或 Channel

在go 里,多线程对共享数据的操作一般要使用Mutex 或 Channel 来加锁或隔离通信。下面是一个使用Mutex 和 Channel 比较的例子。...

Write a Comment to "公司内部 Golang 编码规范参考"

Submit Comment Login
Based on Golang + fastHTTP + sdb | go1.16.5 Processed in 1ms