Go vet 工具詳解：程式碼靜態分析利器

什麼是 go vet？（What is go vet?）

go vet 是 Go 語言官方提供的靜態分析工具，用於檢測 Go 程式碼中可能存在的問題和錯誤。它可以找出編譯器無法檢測到的潛在問題，例如：格式化字串錯誤、不可到達的程式碼、錯誤的並發使用等。

go vet 的主要功能（Main Features）

靜態程式碼分析（Static Code Analysis）
- 在編譯前檢測潛在問題
- 提供程式碼品質保證
多種檢查器（Multiple Checkers）
- 內建多種檢查規則
- 可以自定義檢查項目
整合開發流程（Development Integration）
- 可以整合到 CI/CD 流程
- 支援 IDE 整合

基本用法（Basic Usage）

檢查單個檔案

# 檢查單個 Go 檔案
go vet main.go

# 檢查指定目錄下的所有 Go 檔案
go vet ./...

# 檢查當前包
go vet .

常見檢查項目

1. Printf 格式化錯誤

package main

import "fmt"

func main() {
    name := "John"
    age := 25
    
    // 錯誤：格式化動詞與參數類型不匹配
    fmt.Printf("%d years old\n", name) // go vet 會檢測到這個錯誤
    
    // 正確的寫法
    fmt.Printf("%s is %d years old\n", name, age)
}

2. 不可到達的程式碼

package main

import "fmt"

func unreachableCode() {
    fmt.Println("This will be printed")
    return
    fmt.Println("This is unreachable code") // go vet 會檢測到這個問題
}

3. 錯誤的 struct tag

package main

import (
    "encoding/json"
    "fmt"
)

type User struct {
    Name string `json:"name,omitempty"`
    Age  int    `json:"age,omitempty"`
    // 錯誤：struct tag 格式錯誤
    Email string `json:"email,omitempty" xml:"email"` // 缺少空格
}

// 正確的寫法
type UserCorrect struct {
    Name  string `json:"name,omitempty"`
    Age   int    `json:"age,omitempty"`
    Email string `json:"email,omitempty" xml:"email"`
}

4. 錯誤的原子操作使用

package main

import (
    "sync/atomic"
)

type Counter struct {
    value int64
}

func (c *Counter) wrongIncrement() {
    // 錯誤：應該傳遞指標而不是值
    atomic.AddInt64(c.value, 1) // go vet 會檢測到這個錯誤
}

func (c *Counter) correctIncrement() {
    // 正確：傳遞指標
    atomic.AddInt64(&c.value, 1)
}

進階用法（Advanced Usage）

自定義檢查項目

# 只執行特定的檢查項目
go vet -printf=false ./...

# 查看所有可用的檢查項目
go vet -h

常用檢查項目列表

asmdecl: 檢查組合語言檔案與 Go 宣告的一致性
assign: 檢查無用的賦值
atomic: 檢查 atomic 包的常見錯誤使用
bools: 檢查布林運算的錯誤
buildtag: 檢查 build tag 的格式
cgocall: 檢查 cgo 調用的錯誤
composites: 檢查複合字面量的未鍵控欄位
copylocks: 檢查鎖的值複製
httpresponse: 檢查 HTTP 回應的錯誤使用
loopclosure: 檢查迴圈變數參考的錯誤
lostcancel: 檢查取消函數的調用
nilfunc: 檢查無用的 nil 函數比較
printf: 檢查 Printf 類函數的格式化字串
shift: 檢查等於或超過整數寬度的移位
stdmethods: 檢查已知介面的方法簽名
structtag: 檢查 struct tag 的格式
tests: 檢查測試函數和範例函數的錯誤使用
unmarshal: 檢查傳遞給 unmarshal 的非指標或非介面值
unreachable: 檢查不可到達的程式碼
unusedresult: 檢查未使用的函數結果

排除特定檢查

# 排除 printf 檢查
go vet -printf=false ./...

# 排除多個檢查項目
go vet -printf=false -unreachable=false ./...

實際應用範例（Practical Examples）

1. Printf 錯誤檢測

package main

import "fmt"

func printfExamples() {
    var count int = 42
    var message string = "Hello"
    
    // 這些都會被 go vet 檢測到
    fmt.Printf("%s", count)        // 錯誤：%s 用於整數
    fmt.Printf("%d", message)      // 錯誤：%d 用於字串
    fmt.Printf("%d %s", count)     // 錯誤：參數不足
    fmt.Printf("%d", count, message) // 錯誤：參數過多
    
    // 正確的用法
    fmt.Printf("%d", count)
    fmt.Printf("%s", message)
    fmt.Printf("%d %s", count, message)
}

2. 並發安全檢查

package main

import (
    "sync"
    "sync/atomic"
)

type SafeCounter struct {
    mu    sync.Mutex
    value int64
}

func (c *SafeCounter) wrongUsage() {
    // 錯誤：複製了包含鎖的結構體
    copy := *c // go vet 會檢測到這個問題
    copy.value = 10
}

func (c *SafeCounter) atomicWrongUsage() {
    // 錯誤：原子操作使用值而不是指標
    atomic.AddInt64(c.value, 1) // go vet 會檢測到這個問題
}

func (c *SafeCounter) correctUsage() {
    c.mu.Lock()
    defer c.mu.Unlock()
    c.value++
    
    // 或者使用原子操作
    atomic.AddInt64(&c.value, 1)
}

3. 迴圈閉包錯誤

package main

import (
    "fmt"
    "time"
)

func loopClosureExample() {
    var funcs []func()
    
    // 錯誤：迴圈變數在閉包中被捕獲
    for i := 0; i < 3; i++ {
        funcs = append(funcs, func() {
            fmt.Println(i) // go vet 會檢測到這個問題
        })
    }
    
    // 正確的寫法：傳遞參數
    for i := 0; i < 3; i++ {
        i := i // 創建局部變數
        funcs = append(funcs, func() {
            fmt.Println(i)
        })
    }
    
    // 或者使用參數傳遞
    for i := 0; i < 3; i++ {
        func(index int) {
            funcs = append(funcs, func() {
                fmt.Println(index)
            })
        }(i)
    }
}

整合到開發流程（Integration into Development Workflow）

1. Makefile 整合

.PHONY: vet build test

vet:
	go vet ./...

build: vet
	go build ./...

test: vet
	go test ./...

ci: vet test build

2. GitHub Actions 整合

name: Go CI

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    
    - name: Set up Go
      uses: actions/setup-go@v2
      with:
        go-version: 1.21
    
    - name: Run go vet
      run: go vet ./...
    
    - name: Run tests
      run: go test ./...

3. Pre-commit Hook

#!/bin/sh
# .git/hooks/pre-commit

echo "Running go vet..."
if ! go vet ./...; then
    echo "go vet failed. Please fix the issues before committing."
    exit 1
fi

echo "Running tests..."
if ! go test ./...; then
    echo "Tests failed. Please fix the issues before committing."
    exit 1
fi

常見問題與解決方案（Common Issues and Solutions）

1. 忽略特定檢查

package main

import "fmt"

func ignoreVetCheck() {
    var count int = 42
    
    // 使用註解忽略特定的 vet 檢查
    //nolint:vet
    fmt.Printf("%s", count)
}

2. 配置檔案設定

創建 .golangci.yml 配置檔案：

linters-settings:
  govet:
    check-shadowing: true
    settings:
      printf:
        funcs:
          - (github.com/sirupsen/logrus.FieldLogger).Infof
          - (github.com/sirupsen/logrus.FieldLogger).Warnf
          - (github.com/sirupsen/logrus.FieldLogger).Errorf
          - (github.com/sirupsen/logrus.FieldLogger).Fatalf

linters:
  enable:
    - govet