在 go 中设计优雅的函数 api 需要遵循命名约定、优化参数类型、管理错误和考虑可测试性。使用命名约定明确区分函数名称和方法名称，标识 api 类别或目的。优化参数类型，使用结构体代替指针或值类型，定义清晰的输入和输出参数。使用错误类型表示 api 调用失败的原因，避免直接返回错误字符串或值。编写可单元测试的函数，避免使用全局状态或共享可变数据。
在 Go 中设计优雅的函数 API
设计的函数 API 既直观又易于使用对于构建可维护且可扩展的代码库至关重要。以下是如何在 Go 中实现：
1. 使用命名约定
立即学习“go语言免费学习笔记（深入）”；
- 保持一致的命名风格，使用蛇形或驼峰式大小写。
- 明确区分函数名称和方法名称。
- 使用前缀标识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 更易于扩展和测试。
