golang规范

最新推荐文章于 2024-02-07 11:53:55 发布

yanjiangbo

最新推荐文章于 2024-02-07 11:53:55 发布

阅读量485

点赞数

分类专栏： Golang 文章标签： golang

本文链接：https://blog.csdn.net/YanJiangbo/article/details/123717808

版权

Golang 专栏收录该内容

17 篇文章 1 订阅

订阅专栏

必须遵守的：

【比较】
1. 当明确expr为bool类型时，禁止使用==或!=与true/false比较，应该使用expr或!expr
2. 判断某个整数表达式expr是否为零时，禁止使用!expr，应该使用expr == 0
```
GOOD:
var isWhiteCat bool
var num int
if isWhiteCat {
    // ...
}
if num == 0 {
    // ...
}


BAD:
var isWhiteCat bool
var num int
if isWhite == true {
    // ...
}
if !num {
    // ...
}
```
【receiver】
1. 如果receiver是struct，且包含sync.Mutex类型字段，则必须使用指针避免拷贝。
2. 如果receiver是比较大的struct/array，建议使用指针，这样会更有效率。
3. 如果receiver是struct、array或slice，其中指针元素所指的内容可能在方法内被修改，建议使用指针类型。
4. 如果receiver是比较小的struct/array，建议使用value类型
5. 禁止使用“this"、”self“等面向对象语言中特定的叫法。
```
GOOD:
// "c" receiver
func (c Client) call() error {
    // ... 
}

func (c Client) done() error {
    // ...
}

BAD:
// self
func (self Client) call() error {
    // ... 
}

// this
func (this Client) done() error {
    // ... 
}
```
【声明】
1. 申明slice时，建议使用var方式申明，不建议使用大括号的方式（var方式申明在slice不被append的情况下避免了内存分配）
```
GOOD:
var t []string

BAD:
t := []string{}
```
【Error Handler】
1. 对于返回值中的error，一定要进行判断和处理，不可以使用 ”_“ 变量忽略error
2. error string尽量使用小写字母，并且结尾不带标点符号
```
GOOD：
fmt.Errorf("something bad")

BAD：
fmt.Errorf("Something bad")
```

【结构体嵌套】

embedding只用于"is a"的语义下，而不用于"has a"的语义下
语义上embedding是一种“继承关系“，而不是”成员关系“

一个定义内，多于一个的embedding尽量少用，如果一个定义内有多个embedding，则很难判断某个成员变量或函数是从哪里继承得到的

GOOD:
type Automobile struct {
    // ... 
}
type Engine struct {
    // ....
}
//
type Car struct {
    Automobile           //  Car is a Automobile
    engine Engine        //  Car has a Engine
}


BAD:
type Car struct {
    Automobile      //  Car is a Automobile
    Engine          //  Car has a Engine, but Car is NOT a Engine
}

【函数返回值】
1. 对于“逻辑判断型”的函数，返回值的意义代表“真”或“假”，返回值类型定义为bool
2. 对于“操作型”的函数，返回值的意义代表“成功”或“失败”，返回值类型定义为error
  1. 如果成功，则返回nil
  2. 如果失败，则返回对应的error值
3. 对于“获取数据型”的函数，返回值的意义代表“有数据”或“无数据/获取数据失败”，返回值类型定义为(data, error)
  1. 正常情况下，返回为:(data, nil)
  2. 异常情况下，返回为:(data, error)

【参数个数和返回值个数】

函数参数不建议超过3个，大于3个时建议通过struct进行包装

函数返回值小于等于3个，大于3个时必须通过struct进行包装

GOOD：
type student struct {
    id       int
    name     string
    email    string
    address  string
}

// bool
func isWhiteCat() bool {
    // ... 
}

// error
func deleteData() error {
    // ... 
}

// (data, error)
func getData() (student, error) {
    // ... 
}

错误处理时缩进错误处理代码，对正常代码保持最少的缩进

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


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

【Don't panic】
1. 除非出现不可恢复的程序错误，不要使用panic，用多返回值和error。
【unsafe package】
1. 除非特殊原因，不建议使用unsafe package，比如进行指针和数值uintptr之间转换就是一个特殊原因
【关于lock的保护】
1. 如果临界区内的逻辑较复杂、无法完全避免panic的发生，则要求适用defer来调用Unlock，即使在临界区过程中发生了panic，也会在函数退出时调用Unlock释放锁。
2. go提供了recover，可以对panic进行捕获，但如果panic发生在临界区内，则可能导致对锁的使用没有释放，这种情况下，即使panic不会导致整个程序的奔溃，也会由于”锁不释放“的问题而使临界区无法被后续的调用访问
```
GOOD：
func doDemo() {
    lock.Lock()
    defer lock.Unlock()
    
    // 
}

BAD:
func doDemo() {
    lock.Lock()
    //
    lock.Unlock()
}
```