Go 司空見慣的錯誤檢測,原來還有這麼多幹貨-

一、錯誤處理機制

Go 語言以結果多值返回方式處理錯誤, 函數或者方法最後一個返回值作爲錯誤類型。

func ReadFile(filename string) ([]byte, error)

調用時根據錯誤值判斷是否正常

data, err := ReadFile("abc.txt")
if err != nil {
    // 處理錯誤
} else {
   // 處理data
}
  1. error 類型及其意義

Go 語言通過內置的 error 類型實現錯誤處理, 它是一個接口

type error interface {
    Error() string
}

實現 error 的類型都可以作爲錯誤類型返回, 框架會使用 Error() 方法打印錯誤信息。

任意類型只要實現該接口就表示一個錯誤

type ParseError struct {
    Filename string // 文件名
    Line     int    // 錯誤行號
}
func (e *ParseError) Error() string {
    return fmt.Sprintf("%s:%d", e.Filename, e.Line)  
}
  1. if err != nil 檢查錯誤

if 語句常用於判斷函數調用是否發生錯誤

file, err := os.Open("/tmp/abc.txt")
if err != nil {
    log.Fatal(err)
}
  1. 自定義錯誤類型

可自定義錯誤類型保存更多信息,自定義錯誤能更好表達錯誤場景, 修正錯誤也更方便。

type NotFoundError struct {
    FileName string
}
func (e *NotFoundError) Error() string {
    return fmt.Sprintf("%s not found", e.FileName)
}
func find(filename string) error {
    _, err := os.Stat(filename)
    if err != nil {
        // 創建自定義錯誤類型並返回
        return &NotFoundError{filename} 
    }
    return nil
}

調用時可以轉換回來

err := find("hello.txt")
if e, ok := err.(*NotFoundError); ok {
    fmt.Println(e.FileName) 
}

二、defer 處理資源釋放問題

Go 語言中的 defer 語句會將函數執行推遲到外層函數返回之前。

  1. defer 的執行規則與特點

defer 延遲調用遵循 FILO 規則。

func main() {
  defer fmt.Println(1) 
  defer fmt.Println(2)
  fmt.Println(3) 
  // 輸出順序是 3,2,1。
}

defer 語句中的變量在定義時求值(輸出是 1, 不是 2。)

func main() {
  x := 1
  defer fmt.Println(x)  
  x++      
}
  1. defer 釋放資源

defer 經常用於釋放資源,不管 process 返回與否, 都能保證文件關閉。

func main() {
  file := openFile("abc.txt")
  defer file.Close()
  process(file) // 使用文件
}
  1. defer 經典案例

讀取文件內容的示例,輸出完內容後, defer 確保文件正確關閉。

func cat(f string) error {
    file, err := os.Open(f) 
    if err != nil {
        return err
    }
    defer file.Close() 
    stat, err := file.Stat()
    if err != nil {
        return err
    }
    bs := make([]byte, stat.Size())
    _, err = file.Read(bs)
    if err != nil {
       return err 
    }
    fmt.Println(string(bs))
    return nil
}

三、panic 和 recover

panic 用於程序未能處理的錯誤, recover 可以讓 panic 跳出的 goroutine 恢復, 防止整個程序崩潰。

  1. panic、defer 和 recover 的關係
  • panic 會導致當前 goroutine 立即中止執行, 但 defer 保證執行

  • recover 可以捕獲 panic, 從而影響應用恢復

  1. recover 捕獲 panic

recover 只在 defer 內調用時有效

func ProtectRun(entry func()) {
   defer func() {
       // 捕獲函數異常
       if r := recover(); r != nil {
           log.Printf("run time panic: %v", r)
       }
   }()
   entry() // 可能引發panic的函數
}
  1. panic 應用場景

不希望看到 panic, 但它也有合理應用場景

// 非法狀態,不可能恢復
panic("invalid state") 
// 參數校驗未過,不應繼續
// 等於“拋出異常”,讓程序停下。
if x <= 0 {
  panic("x must > 0") 
}

四、日誌的最佳實踐

log 包實現日誌收集, 支持輸出到文件, 網絡等地方。

  1. log 包的基本使用

導入 log 包並設置輸出位置

func main() {
    log.SetOutput(os.Stdout)
    log.Println("logging example")
}
  1. 設置日誌級別, 控制日誌輸出

log 級別包含 Debug、Info、Warning、Error、Fatal 等。

log.SetPrefix("[Debug] ")
log.SetFlags(log.Llongfile | log.LUTC) 
log.Println("debug message") 
log.Fatalln("fatal message")

Fatal 會在寫入日誌後調用 os.Exit(1)。

  1. 將日誌寫入文件, 按文件大小切分

默認日誌只輸出到 stderr,可以寫入文件,超過文件限制後, 將日誌保存到 xx.log.1。

f, _ := os.OpenFile("/tmp/xx.log",
 os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
log.SetOutput(f)
本文由 Readfog 進行 AMP 轉碼,版權歸原作者所有。
來源https://mp.weixin.qq.com/s/WKG9S_6XoMFc14RVxu-iyw