Golang 中的 errors 包详解：返回自定义 error 类型

之前的文章《Golang 中的 errors 包详解》详细讲解了 errors 包的主要类型和函数，以及它们的使用方法。本文结合之前讲解的知识，来讲解一下根据自己或团队的项目要求如何返回自定义的 error 类型。

为什么需要自定义 error 类型？

在日常开发中，返回自定义 error 类型是一种很常见的做法，因为很多场景下标准库 errors 包中的 error 类型并不能满足需求。例如开发 web 项目时，常见的返回结构可能如下：

{"code":xxx, "data":yyy,"msg":"zzz"}

code 为状态码，data 为接口返回的业务数据，msg 为错误信息。针对这种响应结构，一般做法是调用处理业务逻辑的函数或方法，返回业务数据和 error，然后在 api 层拼装成这种结构。所以 error 对象至少要包含状态码 code 和错误信息 msg，这时候就需要实现自己的 error 类型了。

如何实现自定义 error 类型？

在 Golang 中，可以通过创建一个实现了 error 接口（该接口仅包含一个 Error 方法）的结构体来返回自定义的 error 类型。自定义的 error 类型可以包含自己定义的字段和方法，以提供更多的错误信息和上下文信息。看一个示例来展示如何创建和返回自定义 error 类型：

package main
 
import (
	"errors"
	"fmt"
)
 
// 自定义的错误类型
type MyError struct {
	code int64
	msg  string
}
 
// 实现error接口的Error方法
func (e MyError) Error() string {
	return fmt.Sprintf("Error: [%d] %s", e.code, e.msg)
}
 
func (e MyError) Code() int64 {
	return e.code
}
 
func (e MyError) Msg() string {
	return e.msg
}
 
// 函数示例，返回自定义error类型
func doSomething() error {
	err := MyError{
		code: 500,
		msg:  "Something went wrong",
	}
	return err
}
 
func main() {
	err := doSomething()
	if err != nil {
		fmt.Println(err)
	}
 
	// 比较自定义error类型
	myErr := MyError{
		code: 500,
		msg:  "Something went wrong",
	}
 
	equal := errors.Is(err, myErr)
	fmt.Println(equal) // true
}

在上述示例中，首先定义了一个自定义的 MyError 类型，包含 code 和 msg 两个字段，然后实现 error 接口要求的 Error 方法。

接下来再看一个结合 gin 框架的具体使用示例，简单示例代码如下：

package main
 
import (
	"errors"
	"fmt"
	"github.com/gin-gonic/gin"
	"net/http"
)
 
// 自定义的错误类型
type MyError struct {
	code int64
	msg  string
}
 
func NewError(code int64, msg string) MyError {
	return MyError{
		code: code,
		msg:  msg,
	}
}
 
// 实现error接口的Error方法
func (e MyError) Error() string {
	return fmt.Sprintf("Error: [%d] %s", e.code, e.msg)
}
 
func (e MyError) GetCode() int64 {
	return e.code
}
 
func (e MyError) GetMsg() string {
	return e.msg
}
 
// 函数示例，返回自定义error类型
func doSomething() error {
	err := MyError{
		code: 500,
		msg:  "Something went wrong",
	}
	return err
}
 
func FromError(err error) MyError {
	if err == nil {
		return NewError(1, "")
	}
	if !errors.As(err, &MyError{}) {
		return NewError(-1, "")
	}
	return err.(MyError)
}
 
func TestHandler(c *gin.Context) {
	err := Logic()
	if err != nil {
		e := FromError(err)
		c.JSON(http.StatusOK, gin.H{"code": e.GetCode(), "data": nil, "msg": e.GetMsg()})
		return
	}
	c.JSON(http.StatusOK, gin.H{"code": 1, "data": nil, "msg": ""})
}
 
func Logic() error {
	return NewError(-1, "something went wrong")
}
 
func main() {
	r := gin.New()
	r.GET("/test", TestHandler)
	r.Run(":8080")
}

小结

通过返回自定义的 error 类型，可以提供更多的错误信息和上下文信息，使错误处理更加灵活和准确，可以根据自己的实际需求和应用场景创建自定义错误类型。