Golang编码规范

注:此文是作者所在团队约定的编码规范,参考官方指南Effective GolangGolang Code Review Comments进行整理,力图与官方及社区编码风格保持一致。

gofmt

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

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

注释

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

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

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

  • 包注释

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

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

//Package regexp implements a simple library 
//for regular expressions.
package regexp 
  • 可导出类型

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

// 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”

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

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

type WriteFlusher interface {
    Write([]byte) (int, error)
    Flush() error
}

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

type Car interface {
    Start([]byte) 
    Stop() error
    Recover()
}
  • 混合大小写

采用驼峰式命名

MixedCaps 大写开头,可导出
mixedCaps 小写开头,不可导出
  • 变量

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

控制结构

  • if

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

if err := file.Chmod(0664); err != nil {
    return err
}
  • for

采用短声明建立局部变量

sum := 0
for i := 0; i < 10; i++ {
    sum += i
}
  • range

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

for key := range m {
    if key.expired() {
        delete(m, key)
    }
}

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

sum := 0
for _, value := range array {
    sum += value
}
  • return

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

f, err := os.Open(name)
if err != nil {
    return err
}
d, err := f.Stat()
if err != nil {
    f.Close()
    return err
}
codeUsing(f, d)

函数(必须)

  • 函数采用命名的多值返回
  • 传入变量和返回变量以小写字母开头

    func nextInt(b []byte, pos int) (value, nextPos int) {
    

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

错误处理

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

不要采用这种方式

    if err != nil {
        // error handling
    } else {
        // normal code
    }

而要采用下面的方式

    if err != nil {
        // error handling
        return // or continue, etc.
    }
    // normal code

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

x, err := f()
if err != nil {
    // error handling
    return
}
// use x

panic

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

import

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

    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

    type T struct{} 

    func (p *T)Get(){}
  • 类型

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

func (p *T)Get(){}

而不是

func (p T)Get(){}   

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

  • 如果接收者是map,slice或者chan,不要用指针传递
//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())
}


<pre><code><br /></code></pre>

如果需要对slice进行修改,通过返回值的方式重新赋值
//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)
}

<pre><code><br /></code></pre>

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

import (
    "sync"
)

type T struct {
    m sync.Mutex
}

func (t *T) lock() {
    t.m.Lock()
}

/*
Wrong !!!
func (t T) lock() {
    t.m.Lock()
}
*/

func main() {
    t := new(T)
    t.lock()
}

<pre><code><br /></code></pre>

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

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())
}

阅读 27k

推荐阅读
程式設計
用户专栏

Developer & BTC Investor.

1 人关注
1 篇文章
专栏主页
目录