司空見慣的錯(cuò)誤檢測,原來還有這么多干貨!
一、錯(cuò)誤處理機(jī)制
Go 語言以結(jié)果多值返回方式處理錯(cuò)誤,函數(shù)或者方法最后一個(gè)返回值作為錯(cuò)誤類型。
func ReadFile(filename string) ([]byte, error)
調(diào)用時(shí)根據(jù)錯(cuò)誤值判斷是否正常
data, err := ReadFile("abc.txt")
if err != nil {
// 處理錯(cuò)誤
} else {
// 處理data
}
1. error 類型及其意義
Go 語言通過內(nèi)置的 error 類型實(shí)現(xiàn)錯(cuò)誤處理,它是一個(gè)接口
type error interface {
Error() string
}
實(shí)現(xiàn) error 的類型都可以作為錯(cuò)誤類型返回,框架會(huì)使用 Error()方法打印錯(cuò)誤信息。
任意類型只要實(shí)現(xiàn)該接口就表示一個(gè)錯(cuò)誤
type ParseError struct {
Filename string // 文件名
Line int // 錯(cuò)誤行號(hào)
}
func (e *ParseError) Error() string {
return fmt.Sprintf("%s:%d", e.Filename, e.Line)
}
2. if err != nil 檢查錯(cuò)誤
if 語句常用于判斷函數(shù)調(diào)用是否發(fā)生錯(cuò)誤
file, err := os.Open("/tmp/abc.txt")
if err != nil {
log.Fatal(err)
}
3. 自定義錯(cuò)誤類型
可自定義錯(cuò)誤類型保存更多信息,自定義錯(cuò)誤能更好表達(dá)錯(cuò)誤場景,修正錯(cuò)誤也更方便。
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 {
// 創(chuàng)建自定義錯(cuò)誤類型并返回
return &NotFoundError{filename}
}
return nil
}
調(diào)用時(shí)可以轉(zhuǎn)換回來
err := find("hello.txt")
if e, ok := err.(*NotFoundError); ok {
fmt.Println(e.FileName)
}
二、defer 處理資源釋放問題
Go 語言中的 defer 語句會(huì)將函數(shù)執(zhí)行推遲到外層函數(shù)返回之前。
1. defer 的執(zhí)行規(guī)則與特點(diǎn)
defer 延遲調(diào)用遵循 FILO 規(guī)則。
func main() {
defer fmt.Println(1)
defer fmt.Println(2)
fmt.Println(3)
// 輸出順序是 3,2,1。
}
defer 語句中的變量在定義時(shí)求值(輸出是 1,不是 2。)
func main() {
x := 1
defer fmt.Println(x)
x++
}
2. defer 釋放資源
defer 經(jīng)常用于釋放資源,不管 process 返回與否,都能保證文件關(guān)閉。
func main() {
file := openFile("abc.txt")
defer file.Close()
process(file) // 使用文件
}
3. defer 經(jīng)典案例
讀取文件內(nèi)容的示例,輸出完內(nèi)容后,defer 確保文件正確關(guān)閉。
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 用于程序未能處理的錯(cuò)誤,recover 可以讓 panic 跳出的 goroutine 恢復(fù),防止整個(gè)程序崩潰。
1. panic、defer 和 recover 的關(guān)系
- panic 會(huì)導(dǎo)致當(dāng)前 goroutine 立即中止執(zhí)行,但 defer 保證執(zhí)行
- recover 可以捕獲 panic,從而影響應(yīng)用恢復(fù)
2. recover 捕獲 panic
recover 只在 defer 內(nèi)調(diào)用時(shí)有效
func ProtectRun(entry func()) {
defer func() {
// 捕獲函數(shù)異常
if r := recover(); r != nil {
log.Printf("run time panic: %v", r)
}
}()
entry() // 可能引發(fā)panic的函數(shù)
}
3. panic 應(yīng)用場景
不希望看到 panic,但它也有合理應(yīng)用場景
// 非法狀態(tài),不可能恢復(fù)
panic("invalid state")
// 參數(shù)校驗(yàn)未過,不應(yīng)繼續(xù)
// 等于“拋出異?!?讓程序停下。
if x <= 0 {
panic("x must > 0")
}
四、日志的最佳實(shí)踐
log 包實(shí)現(xiàn)日志收集,支持輸出到文件,網(wǎng)絡(luò)等地方。
1. log 包的基本使用
導(dǎo)入 log 包并設(shè)置輸出位置
func main() {
log.SetOutput(os.Stdout)
log.Println("logging example")
}
2. 設(shè)置日志級(jí)別,控制日志輸出
log 級(jí)別包含 Debug、Info、Warning、Error、Fatal 等。
log.SetPrefix("[Debug] ")
log.SetFlags(log.Llongfile | log.LUTC)
log.Println("debug message")
log.Fatalln("fatal message")
Fatal 會(huì)在寫入日志后調(diào)用 os.Exit(1)。
3. 將日志寫入文件,按文件大小切分
默認(rèn)日志只輸出到 stderr,可以寫入文件,超過文件限制后,將日志保存到 xx.log.1。
f, _ := os.OpenFile("/tmp/xx.log",
os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
log.SetOutput(f)