在Golang中，error接口是内置的错误处理核心接口，所有错误类型都需要实现该接口才能被当作错误处理。error接口的定义非常简单，仅包含一个返回错误信息的Error方法，开发者可以通过多种方式使用它完成错误的定义、传递和处理。
error接口的基本定义
Go语言内置的error接口定义在builtin包中，其定义如下：
// 内置error接口定义
type error interface {
Error() string
}
只要某个类型实现了Error() string方法，那么该类型的实例就可以作为error类型使用。标准库中最常用的错误实现是errors包中的errorString类型，我们通过errors.New创建的错误就是该类型的实例。
创建和使用基础错误
最常用的创建错误的方式有两种，分别是使用errors包和fmt包，两者的使用场景略有不同。
使用errors包创建错误
errors.New函数可以创建一个简单的错误实例，适合不需要携带额外上下文的场景：
package main
import (
"errors"
"fmt"
)
func divide(a, b int) (int, error) {
if b == 0 {
// 创建除零错误
return 0, errors.New("除数不能为0")
}
return a / b, nil
}
func main() {
result, err := divide(10, 0)
if err != nil {
fmt.Println("计算失败:", err)
return
}
fmt.Println("计算结果:", result)
}
使用fmt包创建错误
fmt.Errorf可以像fmt.Sprintf一样格式化错误信息，适合需要拼接动态内容的错误场景：
package main
import (
"fmt"
)
func getUserInfo(id int) (string, error) {
if id <= 0 {
// 格式化错误信息，包含用户传入的id
return "", fmt.Errorf("无效的用户ID: %d", id)
}
return "用户姓名", nil
}
func main() {
name, err := getUserInfo(-1)
if err != nil {
fmt.Println("获取用户信息失败:", err)
return
}
fmt.Println("用户姓名:", name)
}
自定义错误类型
当我们需要在错误中携带更多上下文信息，或者需要根据错误类型做不同的处理逻辑时，可以自定义实现error接口的类型。
package main
import (
"fmt"
)
// 定义自定义错误类型，包含错误码和错误信息
type MyError struct {
Code int
Message string
}
// 实现error接口的Error方法
func (e *MyError) Error() string {
return fmt.Sprintf("错误码: %d, 错误信息: %s", e.Code, e.Message)
}
func processTask(taskID int) error {
if taskID == 0 {
// 返回自定义错误实例
return &MyError{
Code: 1001,
Message: "任务ID不能为0",
}
}
return nil
}
func main() {
err := processTask(0)
if err != nil {
// 类型断言获取自定义错误的详细信息
if myErr, ok := err.(*MyError); ok {
fmt.Printf("自定义错误处理: 错误码=%d, 信息=%sn", myErr.Code, myErr.Message)
} else {
fmt.Println("其他错误:", err)
}
return
}
fmt.Println("任务处理成功")
}
错误的判断与处理
在实际开发中，我们经常需要判断返回的错误是否属于特定类型，或者是否包含特定的错误信息。
直接判断错误内容
对于简单的错误，可以直接比较错误内容：
package main
import (
"errors"
"fmt"
)
var ErrInvalidInput = errors.New("输入参数无效")
func validateInput(input string) error {
if input == "" {
return ErrInvalidInput
}
return nil
}
func main() {
err := validateInput("")
// 直接比较错误实例
if err == ErrInvalidInput {
fmt.Println("捕获到输入无效错误")
}
}
使用errors.Is判断错误链
Go 1.13之后引入了错误包装机制，我们可以使用errors.Is来判断错误链中是否包含目标错误：
package main
import (
"errors"
"fmt"
)
var ErrNotFound = errors.New("资源不存在")
func queryData(id int) error {
// 包装原始错误，添加更多上下文
return fmt.Errorf("查询ID为%d的数据失败: %w", id, ErrNotFound)
}
func main() {
err := queryData(100)
// 判断错误链中是否包含ErrNotFound
if errors.Is(err, ErrNotFound) {
fmt.Println("捕获到资源不存在错误，原始错误:", err)
}
}
使用errors.As提取错误
如果需要从错误链中提取特定类型的错误，可以使用errors.As方法：
package main
import (
"errors"
"fmt"
)
type TimeoutError struct {
Duration int
}
func (e *TimeoutError) Error() string {
return fmt.Sprintf("请求超时，超时时长: %d秒", e.Duration)
}
func sendRequest() error {
return &TimeoutError{Duration: 30}
}
func main() {
err := sendRequest()
var timeoutErr *TimeoutError
// 从错误链中提取TimeoutError类型
if errors.As(err, &timeoutErr) {
fmt.Printf("捕获到超时错误，超时时长: %d秒n", timeoutErr.Duration)
}
}
错误包装的最佳实践
在传递错误时，建议对错误进行包装，添加当前层的上下文信息，方便后续排查问题。包装错误时使用%w动词，这样后续可以通过errors.Is和errors.As解析错误链。
package main
import (
"errors"
"fmt"
)
func readFile(path string) error {
return fmt.Errorf("读取文件%s失败: %w", path, errors.New("文件不存在"))
}
func processFile(path string) error {
// 再次包装错误，添加处理文件层的上下文
return fmt.Errorf("处理文件失败: %w", readFile(path))
}
func main() {
err := processFile("./test.txt")
fmt.Println("最终错误:", err)
// 可以追溯原始错误
if errors.Is(err, errors.New("文件不存在")) {
fmt.Println("原始错误是文件不存在")
}
}
需要注意的是，不要在错误中暴露敏感信息，比如用户密码、内部服务地址等，避免造成安全风险。同时，错误信息的描述要清晰准确，方便其他开发者快速定位问题。