前言
對于一門編程語言的開發(fā)者，類庫包管理是一項考核編程語言成熟度的重要指標之一，Golang 也不例外。筆者在日常使用Golang語言開發(fā)系統(tǒng)程序時發(fā)現(xiàn)，在 Golang 的世界里，存在著大量的技術(shù)實現(xiàn)討論和各種自制的解決方案。
最近在開發(fā)Go項目，發(fā)現(xiàn)Go語言本身存在的error并沒有像觸發(fā)panic時顯示詳細的調(diào)試信息。對于復(fù)雜的系統(tǒng)而言，這會讓我們開發(fā)者需要一定的時間才能定位到錯誤。所以我們基本Go本身的error封裝了一個可以快速定位錯誤工具包。下面讓我們來看看這個工具包是怎么實現(xiàn)的。
設(shè)計思想
- 工具包提供Err和Errf兩個完善來登記錯誤，其用法分別類似于fmt.Print和fmt.Printf的使用方式，在參數(shù)的定義中添加了innerError參數(shù)來實現(xiàn)錯誤的傳遞，其值可為nil.
- 對外提供StackTrace函數(shù)，方便使用者獲取錯誤產(chǎn)生的堆棧信息。
- 通過SetConfig方式實現(xiàn)對錯誤信息顯示的配置，如在生產(chǎn)環(huán)境不需要打印堆棧信息。通過響應(yīng)的配置即可關(guān)閉。
實現(xiàn)思路
工具包中主要是對堆棧信息的處理，就是如何才能定位到error的產(chǎn)生位置,通過查看官方文檔，我們發(fā)現(xiàn)通過runtime包中的Callers和CallersFrames函數(shù)可以獲取當前函數(shù)調(diào)用的堆棧信息。并且通過Skip參數(shù)和自定義過濾條件即可拿到error的產(chǎn)生位置。具體的實現(xiàn)過程如下：
對外提供的2個函數(shù)的實現(xiàn)
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
type Error struct { err error msg string fullMsg string stackTrace}func Errf(err error, format string, args ...interface{}) *Error { e := &Error{ err: err, msg: fmt.Sprintf(format, args), } e.fullMsg = e.genFullMsg() return e}func Err(err error, args ...interface{}) *Error { e := &Error{ err: err, msg: fmt.Sprint(args), } e.fullMsg = e.genFullMsg() return e} |
堆棧信息的實現(xiàn)
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
type stackTrace struct { // stack info data string callers []uintptr}func (err *Error) getStackTrace() string { if strings.TrimSpace(err.data) == "" { return err.genStackTrace(5) } return err.data}func (err *Error) StackTrace() string { return err.data}func (err *Error) genStackTrace(skip int) string { if config.isPrintStack == 1 { var buffer bytes.Buffer buffer.WriteString("StackTrace:\n") var st [64]uintptr n := runtime.Callers(skip, st[:]) err.callers = st[:n] frames := runtime.CallersFrames(err.callers) for { frame, ok := frames.Next() if !ok { break } if !strings.Contains(frame.File, "runtime/") { buffer.WriteString(fmt.Sprintf("%s\n\t%s:%d\n", frame.Func.Name(), frame.File, frame.Line)) } } err.data = buffer.String() return err.data } return ""} |
錯誤信息顯示配置的實現(xiàn)
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
const ( //print stack info PRINTSTACK = 1)// global error config objectvar config *errConfig = &errConfig{}// error configtype errConfig struct { isPrintStack uint32}//set error config infofunc SetConfig(conf byte) { if (conf & PRINTSTACK) != 0 { atomic.CompareAndSwapUint32(&config.isPrintStack, 0, 1) }} |
測試
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
func init() { errors.SetConfig(errors.PRINTSTACK)}func main() { a := func() { err := errors.Err(nil, "this is an inner error") fmt.Print(err.StackTrace()) b := errors.Errf(err, "this is a %s message", "test").Error() fmt.Println(b) } a()} |
錯誤信息如下所示
結(jié)尾
該工具包只是對error信息和堆棧信息的封裝，還存在含多不足的地方。如果各位有好的意見。歡迎指點。
總結(jié)：
以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，如果有疑問大家可以留言交流，謝謝大家對服務(wù)器之家的支持。
原文鏈接：https://studygolang.com/articles/14631
