快捷導(dǎo)航

淺析golang開發(fā)Error的使用詳解

更新時(shí)間：2021年07月21日 09:50:36 作者：飛翔碼農(nóng)

Error是Go語言開發(fā)中最基礎(chǔ)也是最重要的部分，很多朋友不明白goland error的一些基本使用方法，今天通過本文給大家詳細(xì)介紹下，需要的朋友參考下吧

Error是Go語言開發(fā)中最基礎(chǔ)也是最重要的部分，跟其他語言的try catch的作用基本一致，想想在PHP JAVA開發(fā)中，try catch 不會使用，或者使用不靈活，就無法感知到程序運(yùn)行中出現(xiàn)了什么錯(cuò)誤，是特別可怕的一件事。

Error 基礎(chǔ)

Golang中 error類型就是一個(gè)最基本interface，定義了一個(gè)Error()的方法

type error interface {
	Error() string
}

平常使用最多的是這樣的

errors.New("error")

在Golang中errors.New這樣定義的

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
}

其實(shí)是返回了一個(gè)errorString的結(jié)構(gòu)體，這個(gè)結(jié)構(gòu)體實(shí)現(xiàn)了Error()方法，所以實(shí)現(xiàn)了error interface

看下Error在項(xiàng)目開發(fā)中是怎么使用的？

1.定義Error變量

在一段代碼里面可能返回了很多個(gè)error，我怎么判斷這個(gè)error是哪一種呢？
是這樣的吧

var ERR_MSG = "error"
if err.Error() == ERR_MSG

這樣的話，多個(gè)第三方類庫和自己項(xiàng)目的錯(cuò)誤描述要是一致的話就無法比較出來了，其實(shí)不應(yīng)該是這樣的。
我們看下 beego里面orm是怎么定義的，從上面的基礎(chǔ)我們知道errors.New返回的是errorString的指針

var (
	ErrTxHasBegan    = errors.New("<Ormer.Begin> transaction already begin")
	ErrTxDone        = errors.New("<Ormer.Commit/Rollback> transaction not begin")
	ErrMultiRows     = errors.New("<QuerySeter> return multi rows")
	ErrNoRows        = errors.New("<QuerySeter> no row found")
	ErrStmtClosed    = errors.New("<QuerySeter> stmt already closed")
	ErrArgs          = errors.New("<Ormer> args error may be empty")
	ErrNotImplement  = errors.New("have not implement")
)

其實(shí)都是使用指針判斷的

看下怎么使用，下面是偽代碼

err := this.QueryTable(this.table).Filter("id", id).One(data)
if err != nil && err != orm.ErrNoRows {
	return err
}
return nil

這種其實(shí)在Golang 源碼或者第三方類庫里面用的比較多，缺點(diǎn)就是耦合，調(diào)用者使用一個(gè)第三方類庫，需要知道的它的代碼里面的錯(cuò)誤類型，而且還需要在項(xiàng)目中使用這些錯(cuò)誤類型的變量進(jìn)行比較，第一次使用的開發(fā)者，很難想到需要這么使用。

2.自定義自己的Error

以前PHP的項(xiàng)目Exception里面會定義自己的錯(cuò)誤碼 code。
Golang中我們也可以定義自己的Error類型，然后使用斷言決定是那種Error來獲取更多的錯(cuò)誤數(shù)據(jù)，看下下面的示例代碼，了解下自定義Error的簡單使用

type SelfError struct {
	Code int
	Err error
}

func (this *SelfError) Error() string {
	return this.Err.Error()
}
func (this *SelfError) GetCode() int {
	return this.Code
}

func OpenFile(name string) error {
	err := os.Rename("/tmp/test","/tmp/test1")
	if err != nil {
		return &SelfError{-1001, err}
	}
	return nil
}

func main() {
	err := OpenFile("test")
	switch erro := err.(type) {
	case nil:
		fmt.Println("success")
	case *SelfError:
		fmt.Println(erro.Error(),erro.Code)
	case error:
		fmt.Println(erro.Error())
	}
}

還有一種用法就是判斷error類型是否是自定義如果是，就返回自定義的屬性

func main() {
	err := OpenFile("test")
	serr, ok := err.(*SelfError)
	if ok {
		fmt.Println(serr.GetCode())
	}
}

可以看到都是通過斷言去判斷error是否是自定義的Error，如果是，就使用自定義的Error自己的屬性和方法。

耦合，調(diào)用者需要使用switch或者斷言才能使用自定義的Error的屬性。

3.Wrap Errors的使用

wrap errors的使用應(yīng)該是項(xiàng)目對error的處理運(yùn)用最多的一種，可以方便的加入使用時(shí)的上下文。
Wrap Errors 顧名思義就是把error一層層的包裝，最外層拿到的是error的一個(gè)堆棧信息，根據(jù)堆棧信息一直可以追蹤到第一個(gè)引起error 的調(diào)用代碼。
需要使用這個(gè)包

github.com/pkg/errors

看下代碼示例

package main

import (
	"fmt"
	"github.com/pkg/errors"
	"os"
)

func ModelFile() error {
	err := os.Rename("/tmp/test","/tmp/test1")
	if err != nil {
		return errors.Wrap(err, "model_rename_fail")
	}
	return nil
}

func LogicFile() error {
	err := ModelFile()
	if err != nil {
		return errors.Wrap(err, "logic_rename_fail")
	}
	return nil
}

func main() {
	err := LogicFile()
	if err != nil {
		fmt.Printf("error:%v", errors.Cause(err))
		fmt.Printf("%+v", err)
	}
}

看下執(zhí)行結(jié)果的堆棧

error:rename /tmp/test /tmp/test1: no such file or directoryrename /tmp/test /tmp/test1: no such file or directory
model_rename_fail
main.ModelFile
        /data/www/go/src/test1/main.go:12
main.LogicFile
        /data/www/go/src/test1/main.go:18
main.main
        /data/www/go/src/test1/main.go:26
runtime.main
        /usr/local/go/src/runtime/proc.go:203
runtime.goexit
        /usr/local/go/src/runtime/asm_amd64.s:1357
logic_rename_fail
main.LogicFile
        /data/www/go/src/test1/main.go:20
main.main
        /data/www/go/src/test1/main.go:26
runtime.main
        /usr/local/go/src/runtime/proc.go:203
runtime.goexit
        /usr/local/go/src/runtime/asm_amd64.s:1357

使用的簡單規(guī)則

這么多使用方法，到底應(yīng)該用哪一種，大致建議應(yīng)該是這樣的