跳转到主内容
新派编程网 - 新潮编程理念,全新技术课堂!

Golang函数返回值错误处理规范讲解

Go语言通过返回error类型显式处理错误,推荐将error作为函数最后一个返回值并由调用方检查;使用%w包装错误以保留调用链信息,便于用errors.Is和errors.As判断;可定义哨兵错误或自定义错误类型实现精准错误处理;出错时非error返回值应为零值,确保错误状态一致。 在Go语言开发中,错误处理是函数设计的重要组成部分。Golang没有异常机制,而是通过返回
error
类型来显式处理错误。良好的错误处理规范不仅能提高程序的健壮性,还能增强 代码可读性 和维护性。 1. 基本返回值与error约定 Go函数通常将
error
作为最后一个返回值。调用方必须显式检查这个返回值,不能忽略。 例如:
func readFile(filename string) ([]byte, error) { data, err := os.ReadFile(filename) if err != nil { return nil, fmt.Errorf("读取文件失败: %w", err) } return data, nil }
调用时应始终判断error:
data, err := readFile("config.json") if err != nil { log.Fatal(err) } // 使用data
2. 使用error wrapping保留调用链信息 从Go 1.13开始推荐使用
%w
动词包装错误,这样可以保留原始错误信息,便于后续使用
errors.Is
和
errors.As
进行判断。 立即学习 “ go语言免费学习笔记(深入) ”; 正确做法:
if err != nil { return fmt.Errorf("处理数据时出错: %w", err) }
避免只用
%v
丢失上下文: php版微信js-sdk支付接口类 php版微信js-sdk支付接口类 下载
// 不推荐 return fmt.Errorf("处理失败: %v", err)
3. 自定义错误类型与哨兵错误 对于特定业务场景,可以定义哨兵错误或自定义错误类型,方便调用方做精确判断。
var ErrNotFound = errors.New("记录未找到")

type ValidationError struct { Field string Msg string }

func (e *ValidationError) Error() string { return fmt.Sprintf("验证错误: %s - %s", e.Field, e.Msg) }

调用方可以使用
errors.Is
或
errors.As
进行判断:
if errors.Is(err, ErrNotFound) { // 处理未找到的情况 }

var ve *ValidationError if errors.As(err, &ve) { log.Printf("字段校验失败: %v", ve) }

4. 错误返回的一致性原则 函数在返回非nil error时,其他返回值应为“零值”或无效状态,避免调用方误用。 返回切片出错时,slice应为nil 返回指针出错时,指针应为nil 数值类返回值出错时应为0 同时,不要在成功时返回
nil
错误但附带无效数据,也不要错误时仍返回部分有效结果(除非接口明确说明)。 基本上就这些。Go的错误处理强调显式、清晰和一致性。只要坚持检查每一个error、合理包装、正确使用类型判断,就能写出可靠的服务代码。

相关文章