Go 開發模式

用於建構穩健、高效且可維護應用程式的慣用 Go 模式和最佳實務。

何時啟用

• 撰寫新的 Go 程式碼
• 審查 Go 程式碼
• 重構現有 Go 程式碼
• 設計 Go 套件/模組

核心原則

1. 簡單與清晰

Go 偏好簡單而非聰明。程式碼應該明顯且易讀。

// 良好：清晰直接
func GetUser(id string) (*User, error) {
    user, err := db.FindUser(id)
    if err != nil {
        return nil, fmt.Errorf("get user %s: %w", id, err)
    }
    return user, nil
}

// 不良：過於聰明
func GetUser(id string) (*User, error) {
    return func() (*User, error) {
        if u, e := db.FindUser(id); e == nil {
            return u, nil
        } else {
            return nil, e
        }
    }()
}

2. 讓零值有用

設計類型使其零值無需初始化即可立即使用。

// 良好：零值有用
type Counter struct {
    mu    sync.Mutex
    count int // 零值為 0，可直接使用
}

func (c *Counter) Inc() {
    c.mu.Lock()
    c.count++
    c.mu.Unlock()
}

// 良好：bytes.Buffer 零值可用
var buf bytes.Buffer
buf.WriteString("hello")

// 不良：需要初始化
type BadCounter struct {
    counts map[string]int // nil map 會 panic
}

3. 接受介面，回傳結構

函式應接受介面參數並回傳具體類型。

// 良好：接受介面，回傳具體類型
func ProcessData(r io.Reader) (*Result, error) {
    data, err := io.ReadAll(r)
    if err != nil {
        return nil, err
    }
    return &Result{Data: data}, nil
}

// 不良：回傳介面（不必要地隱藏實作細…