go异常处理

在了解go异常处理的时候,有必要先了解为什么需要做异常处理,异常处理主要在哪几个方面,区分异常和错误的区别等等.

QA

为什么需要做异常处理?

我个人认为有一下几点

从程序设计的角度来看, 保证程序的鲁棒性,健壮性
从开发的角度来看, 快速定位问题,解决问题,预防问题

异常处理主要在哪几个方面

异常处理主要在实践上可以区分为

业务层面: 保证业务的稳定性, 逻辑性
基础库: 保证代码逻辑正常

异常与错误的区别

编程语言中的异常和错误是两个相似但不相同的概念。异常和错误都可以引起程序执行错误而退出，他们属于程序没有考虑到的例外情况(exception)。

便于理解举个例子:

一个网络请求, 没有网络-错误

一个网络请求过程中,对方服务器处理超时(注意是对方服务器正常) - 异常

Error 和 Exception

go error

go error 就是一个普通的接口, 普通的值.

// https://golang.org/pkg/builtin/#error
type error interface {
    Error ()
}

经常使用 errors.New() 来返回一个 error 对象

// https://go.dev/src/errors/errors.go

package errors

// New returns an error that formats as the given text.
// Each call to New returns a distinct error value even if the text is identical.
func New(text string) error {
	return &errorString{text}
}

// errorString is a trivial implementation of error.
type errorString struct {
	s string
}

func (e *errorString) Error() string {
	return e.s
}

New() 返回的是 errorString对象的指针

为什么返回的是指针?

避免创建的error的值一致

基础库中大量定义的error

// https://go.dev/src/bufio/bufio.go

var (
	ErrInvalidUnreadByte = errors.New("bufio: invalid use of UnreadByte")
	ErrInvalidUnreadRune = errors.New("bufio: invalid use of UnreadRune")
	ErrBufferFull        = errors.New("bufio: buffer full")
	ErrNegativeCount     = errors.New("bufio: negative count")
)

tip: 在定义错误的时候带上包名,便于区分. 如ErrInvalidUnreadByte = errors.New("bufio: invalid use of UnreadByte") 中的bufio:

Error VS Exception

各语言的演进历史

C: 但返回值, 入参通过传递指针作为入参, 返回int 表示成功还是失败, 以及如果失败的状态码是什么

C++: 引入了Exception,但无法知道被调用者抛出什么异常

Java: 引入了checked exception,方法的所有者必须申明, 调用者必须处理.

go: 支持多参数返回, 所以很容易在函数签名上实现了error interface的对象,交由调用者处理

如果一个函数返回了 (value,error), 不能对这个value做任何假设, 必须先判定error

补充: go中panic机制,意味着 fatal all, 不能假设调用者来解决panic 意味着代码down了

记录单一清晰的错误, 并处理!!!

注意二值性

go特征

简单
考虑失败而不是成功
没有隐藏的控制流
完全交给开发者来处理
Error are values

对于真正的错误, 表示不可恢复的程序错误,例如索引越界, 不可恢复的环境问题, 堆栈溢出,才使用panic ,对于其他的错误情况,应该是情况我使用error来进行判定

go error type

Sentinel Error

预定义的特定错误,称之为 Sentinel Error. 这个名字起源于计算机编程中使用一个表示不可能进一步处理的做法. 使用特定值来表示错误.

1 2	if err == ErrorSomething { ....} // 类似于 io.EOF 更底层的syscall.ENOENT

使用 Sentinel Error 值是最不灵活的错误处理策略, 因为调用方法必须使用==

将结果与预先声明的值进行比较. 当需要提供更多的上下文时,就会出现一个因为反返回一个不同的错误将被破坏相等性检查.

例如一些有意义的fmt.Errorf 携带一些上下文,也会破坏调用者的== ,调用者将被迫查看error.Error()方法的输出,以查看它是否与特定的字符串匹配

tips:

不依赖检查error.Error的输出.

不应该以来检测error.Error的输出, Error方法存在于error接口主要用于方便开发者使用,而不是程序(编写测试会依赖这个返回). 这个输出的字符串用于记录日志,输出到stdout

Sentient errors 成为你API公共部分

如果公共函数或方法返回一个特定的值,那么该值必须是公共的,当然要有文档记录,这会增加API的表面积

如果API定义了以恶搞返回特定错误的Interface ,则该接口的所有实现都将被限制为仅返回该错误, 即使他们可以提供更具有描述性错误

比如: io.Reader. 像io.Copy这类函数需要reader的实现者比如返回 io.EOF 来告诉调用者没有更多数据量,但这又不是错误

Sentient errors 在这个两个包之间创建依赖

Sentinel errors 最糟糕的问题是他们在两个包之间创建了源码依赖关系

例如检查错误是否等于io.EOF, 代码就必须要导入io包, 虽然听起来似乎不那么糟糕,但想象一下,当项目中的许多包到处错误值时,存在耦合,项目中的其他包必须要导入这些错误值才能校验特定的错误条件

建议:尽可能的避免使用 sentinel errors

Error Types

Error type 实现了error接口自定义类型.例如ExampleError 类型记录了文件和行号以及展示发生了什么. 如下代码所示

import (
	"fmt"
)

type ExampleError struct {
	Msg      string
	FileName string
	Line     int
}

func (e *ExampleError) Error() string {
	return fmt.Sprintf(`%s:%d %s`, e.FileName, e.Line, e.Msg)
}

func test() error {
	return &ExampleError{`something happened`, `example.go`, 33}
}

func main() {
	err := test()
	switch err := err.(type) {
	case nil:
	// call succeeded, nothing to do
	case *ExampleError:
		fmt.Println(`Error occurred on call:`, err)
	default:
		// unknown error
	}
}

与错误值相比, 错误类型的优点是他们能够包装底层错误以提供更多上下文.

官方实例 os.PathError:

type PathError struct {
	Op      string
	Path    string
	Err     int
}

调用者要使用类型断言和switch,就要让自定义的error变为公共的, 这种模型会导致和调用者产生强耦合,从而导致API非常脆弱

结论: 尽量避免使用error types,或者说尽量避免其成为公共API的一部分

虽然错误类型比sentinel error更完善,提供更多的上下文信息, 但error types 共享error value许多相同的问题.

Opaque errors

不透明的错误处理

直接返回错误而不假设其内容

Assert errors for behaviour, not type

在某些情况下,这种二分错误处理方法是不够的, 例如与外界交互(网络), 需要调用方法查错误的性质,以确定重试是否合理. 在这种情况下,可以使用断言错误实现了特定的行为.

Handle Error

Indented flow is for errors

缩进流用于错误

// 无错误的正常流程代码应为一条直线
f, err := os.Open(filePath)
if err != nil {
    // handle error
}

// do stuff

Eliminate error handing by eliminating errors

通过消除错误来消除错误处理

func AuthenticateRequest(r *Requests) error {
    err := authenticate(r.user)
    if err != nil {
        return err
    }
    return nil
}


func AuthenticateRequest(r *Requests) error {
	return authenticate(r.user)
}

io Reader Example

统计 io.Reader 读取内容的行数代码实例

func CountLines(r io.Reader) (int, error) {
	var (
		br    = bufio.NewReader(r)
		lines int
		err   error
	)

	for {
		_, err := br.ReadString('\n')
		lines++
		if err != nil {
			break
		}
	}
	if err != io.EOF {
		return 0, err
	}
	return lines, nil
}

改进-使用bufio.scanner

func CountLines1(r io.Reader) (int, error) {
	var lines int
	sc := bufio.NewScanner(r)

	for sc.Scan() {
		lines++
	}

	return lines, sc.Err()
}

Http Example

type Header struct {
	Key, Value string
}

type Status struct {
	Code   int
	Reason string
}

func WriteResponse(w io.Writer, s Status, headers []Header, body io.Reader) error {
	_, err := fmt.Fprintf(w, "HTTP/1.1 %d %s\r\n", s.Code, s.Reason)
	if err != nil {
		return err
	}
	for _, h := range headers {
		_, err := fmt.Fprintf(w, "%s:%s\r\n", h.Key, h.Value)
		if err != nil {
			return err
		}
	}
	if _, err := fmt.Fprintf(w, "\r\n"); err != nil {
		return err
	}

	_, err = io.Copy(w, body)
	return err
}

import (
	"fmt"
	"io"
)

type Header struct {
	Key, Value string
}

type Status struct {
	Code   int
	Reason string
}

type errWrite struct {
	io.Writer
	err error
}

func (e *errWrite) Write(buf []byte) (int, error) {
	var n int
	if e.err != nil {
		return 0, nil
	}

	n, e.err = e.Writer.Write(buf)
	return n, nil

}
func WriteResponse(w io.Writer, s Status, headers []Header, body io.Reader) error {
	ew := &errWrite{Writer: w}
	fmt.Fprintf(ew, "HTTP/1.1 %d %s\r\n", s.Code, s.Reason)

	for _, h := range headers {
		fmt.Fprintf(ew, "%s:%s\r\n", h.Key, h.Value)
	}
	fmt.Fprint(ew, "\r\n")
	io.Copy(ew, body)

	return ew.err
}

Wrap errors

you should only handle errors once. Handing an error means inspecting the error value, and make a single decision

日志与错误无关且对调试没有帮助的信息都应视为噪声, 应予以质疑. 记录的原因是应为某些东西失败了,而包含了答案

错误要被日志记录
应用程序处理错误,保证百分百完整性
之后不在报当前错误

pkg-errors

dev-pkg-errors

pkg-errors

在应用代码中,使用pkg/errors中的errors.New 或者 error.Errorf返回错误
如果调用其他包内的函数,通常简单的直接返回
如果与其他库协作, 考虑使用pkg/errors中的errors.New 或者 error.Errorf返回错误保持堆栈信息
直接放回错误, 而不是每个错误产生的地方打日志
在程序的顶部或者是工作的 goroutine顶部(请求入口), 使用%+v保存堆栈详情记录
使用errors.Cause获取root error 在进行sentinel error判定

小结

Packages that are reusable across many projects only return root error values.

选择 wrap error 是只有 applications 可以选择应用的策略。具有最高可重用性的包只能返回根错误值。此机制与 Go 标准库中使用的相同（kit 库的 sql.ErrNoRows）。

If the error is not going to be handled, wrap and return up the call stack.

这是关于函数/方法调用返回的每个错误的基本问题。如果函数/方法不打算处理错误，那么用足够的上下文 wrap errors 并将其返回到调用堆栈中。例如，额外的上下文可以是使用的输入参数或失败的查询语句。确定您记录的上下文是足够多还是太多的一个好方法是检查日志并验证它们在开发期间是否为您工作。

Once an error is handled, it is not allowed to be passed up the call stack any longer.

一旦确定函数/方法将处理错误，错误就不再是错误。如果函数/方法仍然需要发出返回，则它不能返回错误值。它应该只返回零**（比如降级处理中，你返回了降级数据，然后需要 return nil）。