前言
對(duì)于一門(mén)編程語(yǔ)言的開(kāi)發(fā)者，類(lèi)庫(kù)包管理是一項(xiàng)考核編程語(yǔ)言成熟度的重要指標(biāo)之一，Golang 也不例外。筆者在日常使用Golang語(yǔ)言開(kāi)發(fā)系統(tǒng)程序時(shí)發(fā)現(xiàn)，在 Golang 的世界里，存在著大量的技術(shù)實(shí)現(xiàn)討論和各種自制的解決方案。
最近在開(kāi)發(fā)Go項(xiàng)目，發(fā)現(xiàn)Go語(yǔ)言本身存在的error并沒(méi)有像觸發(fā)panic時(shí)顯示詳細(xì)的調(diào)試信息。對(duì)于復(fù)雜的系統(tǒng)而言，這會(huì)讓我們開(kāi)發(fā)者需要一定的時(shí)間才能定位到錯(cuò)誤。所以我們基本Go本身的error封裝了一個(gè)可以快速定位錯(cuò)誤工具包。下面讓我們來(lái)看看這個(gè)工具包是怎么實(shí)現(xiàn)的。
設(shè)計(jì)思想
- 工具包提供Err和Errf兩個(gè)完善來(lái)登記錯(cuò)誤，其用法分別類(lèi)似于fmt.Print和fmt.Printf的使用方式，在參數(shù)的定義中添加了innerError參數(shù)來(lái)實(shí)現(xiàn)錯(cuò)誤的傳遞，其值可為nil.
- 對(duì)外提供StackTrace函數(shù)，方便使用者獲取錯(cuò)誤產(chǎn)生的堆棧信息。
- 通過(guò)SetConfig方式實(shí)現(xiàn)對(duì)錯(cuò)誤信息顯示的配置，如在生產(chǎn)環(huán)境不需要打印堆棧信息。通過(guò)響應(yīng)的配置即可關(guān)閉。
實(shí)現(xiàn)思路
工具包中主要是對(duì)堆棧信息的處理，就是如何才能定位到error的產(chǎn)生位置,通過(guò)查看官方文檔，我們發(fā)現(xiàn)通過(guò)runtime包中的Callers和CallersFrames函數(shù)可以獲取當(dāng)前函數(shù)調(diào)用的堆棧信息。并且通過(guò)Skip參數(shù)和自定義過(guò)濾條件即可拿到error的產(chǎn)生位置。具體的實(shí)現(xiàn)過(guò)程如下：
對(duì)外提供的2個(gè)函數(shù)的實(shí)現(xiàn)
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
}
堆棧信息的實(shí)現(xiàn)
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 ""
}
錯(cuò)誤信息顯示配置的實(shí)現(xiàn)
const (
//print stack info
PRINTSTACK = 1
)
// global error config object
var config *errConfig = errConfig{}
// error config
type errConfig struct {
isPrintStack uint32
}
//set error config info
func SetConfig(conf byte) {
if (conf PRINTSTACK) != 0 {
atomic.CompareAndSwapUint32(config.isPrintStack, 0, 1)
}
}
測(cè)試
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()
}
錯(cuò)誤信息如下所示
結(jié)尾
該工具包只是對(duì)error信息和堆棧信息的封裝，還存在含多不足的地方。如果各位有好的意見(jiàn)。歡迎指點(diǎn)。
總結(jié)：
以上就是這篇文章的全部?jī)?nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，如果有疑問(wèn)大家可以留言交流，謝謝大家對(duì)腳本之家的支持。
您可能感興趣的文章:- golang 打印error的堆棧信息操作
- 修復(fù) Mac brew 安裝 mongodb 報(bào) Error: No available formula with the name ‘mongodb’ 問(wèn)題詳解
- Django錯(cuò)誤：TypeError at / ''bool'' object is not callable解決
- 解決啟動(dòng)MongoDB錯(cuò)誤：error while loading shared libraries: libstdc++.so.6:cannot open shared object file:
- django.db.utils.ProgrammingError: (1146, u“Table‘’ doesn’t exist”)問(wèn)題的解決
- GO語(yǔ)言標(biāo)準(zhǔn)錯(cuò)誤處理機(jī)制error用法實(shí)例
- 淺析golang開(kāi)發(fā)Error的使用詳解
