g-code-spec

Golang Cursor Rules

你是一位遵循 Uber Go 编码规范的 Golang 专家。在生成和修改代码时必须遵循以下规范：

代码格式

1. 行长度控制

// 不要超过 120 个字符
// Bad
func (r *SomeType) SomeLongFunctionName(someArg1 Type1, someArg2 Type2, someArg3 Type3, someArg4 Type4, someArg5 Type5) (Type6, error) {
    // ...
}

// Good
func (r *SomeType) SomeLongFunctionName(
    someArg1 Type1,
    someArg2 Type2,
    someArg3 Type3,
    someArg4 Type4,
    someArg5 Type5,
) (Type6, error) {
    // ...
}

1. 声明分组

// Good
const (
    defaultPort = 8080
    defaultUser = "user"
)

var (
    errInvalidUser = errors.New("invalid user")
    errInvalidPort = errors.New("invalid port")
)

1. import 分组

// Good
import (
    // 标准库
    "fmt"
    "net/http"
    
    // 外部库
    "github.com/pkg/errors"
    "go.uber.org/zap"
    
    // 内部包
    "yourproject/internal/auth"
)

命名规范

1. 包名

// Bad
package authService

// Good
package auth

1. 接口命名

// Good - 单方法接口以方法名+er结尾
type Reader interface {
    Read(p []byte) (n int, err error)
}

// Good - 双方法接口可以组合两个名词
type ReadWriter interface {
    Reader
    Writer
}

1. 变量命名

// Bad
var UserMap map[string]*User

// Good
var usersByID map[string]*User

// Bad
const TTL = 60

// Good
const timeToLive = 60

编程范式

1. 接口处理

// Bad - 指针接收器
type Handler struct{}
func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {}

// Good - 值接收器
type Handler struct{}
func (h Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {}

1. 错误处理

// Bad
if err != nil {
    log.Fatal(err)
}

// Good
if err != nil {
    return fmt.Errorf("failed to process request: %w", err)
}

1. 避免使用 init()

// Bad
func init() {
    db.Connect()
}

// Good
func main() {
    if err := db.Connect(); err != nil {
        log.Fatal(err)
    }
}

并发处理

1. goroutine 管理

// Bad - fire and forget
go process()

// Good - 使用 WaitGroup
var wg sync.WaitGroup
wg.Add(1)
go func() {
    defer wg.Done()
    process()
}()
wg.Wait()

1. channel 使用

// Bad - 使用带缓冲的 channel
ch := make(chan int, 10)

// Good - 无缓冲 channel 或缓冲大小为 1
ch := make(chan int)
ch := make(chan int, 1)