分享一套Go編碼規範！歡迎收藏！-Golang-PHP中文網

最近在專案中也 codereview 了不少 Go 語言的程式碼，有必要總結下程式碼規範，算是一個筆記記錄了。

說在前面，這只是我們團隊的一套規範而已。

今天我們聊聊 Go 的編碼規範，大概分成幾大模組，如註包/變數/常數命名、基本語法、函數、錯誤處理、心得等。【推薦：golang教學】

1. 程式碼風格

1.1 程式碼格式

程式碼必須用gofmt 格式化，goland 可以配置，可以自行搜尋配置
我們寫的程式碼每行應該不超過120 個字符，超出部分用換行解決。
單一檔案最大行數最大不超過 800 行.
單一函數最大行數不超過 80 行。
import 規範
- 不要使用相對路徑引入包，例如import ../util/net
- 在導入包時，多個相同包名衝突時，必須使用匯入別名

// bad
"github.com/google/uuid"

// good
uuid "github.com/google/uuid"

登入後複製

匯入的套件建議分組，引用匿名套件建議用一個新的分組，並加上註解方便後面小夥伴閱讀

import (
    // Go 标准库
    "fmt"

    //第三方包
    "github.com/jinzhu/gorm"
    "github.com/google/uuid"
    "github.com/go-redis/redis/v8"

    // 匿名包
    /import mysql driver
    _"github.com/jinzhu/gorm/dialects/mysql"

    // 内部包
    slice "xxx.local/pkg/v1/goslice"
    meta "xxx.local/pkg/v1/meta"
    gomap "xxx.local/pkg/v2/gomap")

登入後複製

1.2 宣告、初始化和定義

一個函數需要使用多個變數時，可以在函數最開頭處使用var 宣告。在函數外部宣告的變數不能使用 :=，會踩坑，不知道的可以評論區留言（要評論不易呀）！

var (
    port = 8081
    metricServerPort = 2001)

登入後複製

在初始化結構體用 &struct 取代 new(struct)，確保與結構體初始化一致，初始化結構體時換行。

// bad
stu := new(S)
stu.Name = "张三"

// good
stu := &S{
    Name:"李四"
}

登入後複製

使用 make 在聲明 map、array 等應該指定容器的容量，從而達到預先分配內容。

users := make(map[int]string, 10)tags := make([]int, 0, 10)

登入後複製

使用標準 var 關鍵字事，不要指定類型，除非它與表達式的類型不同。

// bad
var _f string F()

func F() string {
    return "hello world!"
}

// good 
var _f F()

func F() string {
    return "hello world!"
}

登入後複製

1.3 error 處理

若函數傳回 error，必須對 error 進行處理，如果業務允許可以用 _ 接受忽略。對應 defer 可以不用明確處理。

// bad
func InitConfig() error {
    ...
}
InitConfig()


// good
func InitConfig() error {
    ...
}
err := InitConfig()
if err != nil {
    ...
}
// or 
_ := InitConfig()

登入後複製

error 作為回傳值時必須作為最後一個參數傳回

// bad
func InitConfig() (error,int) {
    ...
}

// good 
func InitConfig() (int, error) {
    ...
}

登入後複製

錯誤需要單獨處理，盡量不要與其他的邏輯耦合在一起。

// bad
res, err := InitConfig()
if err != nil || res != nil {
    return err
}

// good
res, err := InitConfig()
if err != nil {
    return err
}
if res != nil {
    return fmt.Errorf("invalid result")
}

登入後複製

1.4 panic處理

在業務程式碼中禁止拋出 panic 錯誤。
panic 只允許出現在在服務啟動之前，例如讀取配置、連結儲存（redis、mysql 等）。
業務程式碼中建議用 error 而不是 panic 來傳遞。

1.5 單元測試

每個重要的函數都要寫測試案例，合併程式碼要自動化執行一下所有的 test。
檔案命名 xxx_test.go。
函數命名建議使用 Test函數名稱。

2. 命名規範

在每個語言中，命名規範在程式碼規範中非常重要，一個統一的、精確的命名不僅僅可以提高程式碼的可讀性，也可以讓人覺的這個同志真的會呀。牛！

2.1 包命名规范

包名必须与目录名一致（这和其他 php、Java 还是有一点不太一样的），尽量采取有意义、简短的包名，不要与 go 的标准库名称一样。
包名小写，没有下划线，可以使用中划线隔开，使用多级目录来划分目录。
包名不要出现复数命名。
包名命名尽量简单一目了然，ge：user、log。

2.2 文件命名规范

文件名要见名思义，尽量简而短
文件名小写，组合词用下划线分割

2.3 函数命名规范

与 php、Java 一样，必须遵循驼峰规范，Go 语言中需要根据访问的控制决定大驼峰还是小驼峰。
单元测试的函数用大驼峰，TestFunc。

2.4 结构体命名规范

与 php、Java 一样，必须遵循驼峰规范，Go 语言中需要根据访问的控制决定大驼峰还是小驼峰。
避免使用 info 、data 这种无意义的名称。
命名使用名词而非动词。
结构体在声明和初始化的时候需要换行，eg：

type Student struct{
    Name string
    Age uint8}student := Student{
    Name: "张三",
    Age: 18,}

登入後複製

2.5 变量命名规范

和 php、Java 一样，必须遵循驼峰规范，Go 语言中需要根据访问的控制决定大驼峰还是小驼峰。
若变量为私有时，可以使用小写命名。
局部变量可以简写，eg：i 表示 index。
若变量代表 bool 值，则可以使用 Is 、Can、Has 前缀命名，eg：

var isExit boolvar canReturn bool

登入後複製

2.6 常量命名规范

必须遵循驼峰规范，Go 语言中需要根据访问的控制决定大驼峰还是小驼峰。
若代表枚举值，需要先创建。

type Code intconst (
    ErrNotFound Code = iota
    ErrFatal)

登入後複製

3. 类型

3.1 字符串

好像学过的语言中，都是从字符串开始说起的。就像写代码第一行都是从 Hello World！一样！同意的点赞哈。

字符串判空值

// bad
if s == "" {
    ...}
 // good
 if len(s) == 0 {
    ...}

登入後複製

字符串去除前后子串。

// bad
var s1 "hello world"var s2 "hello"var s3 strings.TrimPrefix(s1, s2)
// good
var s1 "hello world"var s2 "hello"var s3 stringif strings.HasPrefix(s1, s2){
    s3 = s1[len(s2):]}

登入後複製

3.2 切片 slice

声明 slice。

// bad
s := []string{}s := make([]string, 10)
// good
var s []string
s := make([]string, 0, 10)

登入後複製

非空判断。

//bad
if len(slice) >0 {
    ...}
 // good
 if slice != nil && len(slice) > 0 {
    ...}

登入後複製

slice copy。

// badvar b1,b2 []bytefor i, v := range b1 {
    b2[i] = v}for i := range b1 {
    b2[i] = b1[i]}// goodcopy(b2,b1)

登入後複製

slice 新增。

// bad
var a,b []intfor _, v := range a {
    b = append(b,v)}
// good
var a, b []int
b := append(b, a...)

登入後複製

3.4 结构体 struct

初始化需要多行。

type Student struct{
    Name string
    Age uint8}student := Student{
    Name: "张三",
    Age: 18,}

登入後複製

4. 控制语句

4.1 if

if 可以用局部变量的方式初始化。

if err := InitConfig; err != nil {
    return err}

登入後複製

4.2 for

不允许在 for 中使用 defer， defer 只在函数结束时才会执行。

// bad
for file := range files {
    fd, err := os.Open(file)
    if err != nil {
        return err    }
    defer fd.close()}
// good
    for file := range files{
    func() {
        fd,err := os.open(file)
        if err！=nil {
            return err        }
        defer fd.close()
    }()}

登入後複製

4.3 range

如果不需要 key 直接用 _ 忽略，value 也一样。

for _, v := range students {
    ...}for i, _ := range students {
    ...}for i, v := range students {
    ...}

登入後複製

注：若操作指针时请注意不能直接用 s := v。想知道可以评论区告诉我哦！

4.4 switch

和其他语言不一样，必须要有 defalt

switch type {
    case 1:
        fmt.Println("type = 1")
        break
     case 2:
        fmt.Println("type = 2")
        break
     default :
        fmt.Println("unKnown type")}

登入後複製