在 go 中設計優雅的函數 api 需要遵循命名約定、優化參數類型、管理錯誤和考慮可測試性。使用命名約定明確區分函數名稱和方法名稱，標識 api 類別或目的。優化參數類型，使用結構體代替指針或值類型，定義清晰的輸入和輸出參數。使用錯誤類型表示 api 調用失敗的原因，避免直接返回錯誤字符串或值。編寫可單元測試的函數，避免使用全局狀態或共享可變數據。
在 Go 中設計優雅的函數 API
設計的函數 API 既直觀又易于使用對于構建可維護且可擴展的代碼庫至關重要。以下是如何在 Go 中實現：
1. 使用命名約定
保持一致的命名風格，使用蛇形或駝峰式大小寫。
明確區分函數名稱和方法名稱。
使用前綴標識API類別或目的，例如get_、calculate_。
// Get the current user.
func GetCurrentUser() *User { ... }
// Calculate the discount for a given user.
func CalculateDiscountForUser(user *User) float64 { ... }
登錄后復制
2. 優化參數類型
考慮使用結構體代替指針或值類型，以提高可讀性和提高錯誤處理。定義清晰的輸入和輸出參數，避免使用可變參數列表。考慮使用類型別名簡化復雜的類型定義。
type User struct {
ID int
Name string
IsPremium bool
}
func CreateUser(u *User) error { ... }
登錄后復制
3. 管理錯誤
使用錯誤類型明確表示API調用失敗的原因。避免直接返回錯誤字符串或值，而是使用標準 error 接口。使用 errors.Is 和 errors.As 檢查特定錯誤類型。
import "errors"
var ErrUserNotFound = errors.New("user not found")
func GetUserByID(id int) (*User, error) { ... }
登錄后復制
4. 考慮可測試性
編寫函數以進行單元測試。避免使用全局狀態或共享可變數據。使用接口或依賴注入來模擬外部依賴關系。
import (
"fmt"
"io"
)
// Logger接口定義了Write方法。
type Logger interface {
Write(string)
}
// FileLogger將日志寫入文件。
type FileLogger struct {
File *io.File
}
// Write implements the Logger interface.
func (l *FileLogger) Write(msg string) {
fmt.Fprintf(l.File, msg)
}
// NewLogger創建新的日志記錄器。
func NewLogger(path string) (Logger, error) {
f, err := os.Create(path)
if err != nil {
return nil, err
}
return &FileLogger{f}, nil
}
登錄后復制
實戰案例：一個簡單的哈希函數 API
考慮一個生成哈希的函數 API：
// Hash計算給定字符串的哈希值。
func Hash(s string) string { ... }
登錄后復制
我們可以通過將輸入類型聲明為字符串并分離哈希功能和格式化功能來改進此 API：
// ComputeHash計算給定字符串的哈希值。
func ComputeHash(s string) []byte { ... }
// FormatHash格式化哈希值以進行顯示或比較。
func FormatHash(hash []byte) string { ... }
登錄后復制
這樣，我們就可以隔離 API 的功能，并使 API 更易于擴展和測試。
