用了golang也有一段時(shí)間了,在我推動(dòng)golang在公司項(xiàng)目應(yīng)用工程中也發(fā)現(xiàn)了很多問(wèn)題,關(guān)于公司的golang工程化落地,我會(huì)在這個(gè)文集上面簡(jiǎn)單記錄一下,以供以后參考。
golang error
關(guān)于這個(gè)主題上其實(shí)真的有很多話說(shuō),我們公司有部分項(xiàng)目是從php轉(zhuǎn)過(guò)來(lái)的,基本就是API項(xiàng)目。在之前的工程化上主要用的thinkphp,使用框架的上層handler錯(cuò)誤其實(shí)就挺方便,轉(zhuǎn)到了golang,也可能是剛轉(zhuǎn)過(guò)來(lái)很多概念性的東西沒(méi)有理解透徹,錯(cuò)誤真的就是到處都是,連四五年的php開(kāi)發(fā)工程師在這上面也出現(xiàn)了很基本的錯(cuò)誤
理解方法為什么返回error
我們常常做項(xiàng)目工程上的,都是try catch ,第一次轉(zhuǎn)過(guò)來(lái)肯定還是有相當(dāng)部分不適應(yīng),但是程序員嘛,就是要有究其根本的魄力。
我們看golang官方怎么描述的error
you only need to check the error value if you care about the result.
理解了的人其實(shí)真的覺(jué)得這話說(shuō)的挺不錯(cuò)的,而且是越來(lái)越覺(jué)得這個(gè)比較經(jīng)典:
如果你在乎結(jié)果,你只需要檢查一下這個(gè)錯(cuò)誤值。
我說(shuō)一個(gè)我們公司的例子,是實(shí)實(shí)在在的例子,工作了四五年的一個(gè)工程師,在調(diào)用這個(gè)方法的時(shí)候,選著性忽略掉err的值,說(shuō)是為了代碼好看,為此我還專門(mén)開(kāi)了一個(gè)部門(mén)會(huì)議強(qiáng)調(diào)這個(gè)點(diǎn)。
所以官方描述這句話的時(shí)候我最近越發(fā)覺(jué)得經(jīng)典,雖然在入門(mén)的時(shí)候看了一眼覺(jué)得沒(méi)啥問(wèn)題,但是現(xiàn)在拿這句話來(lái)看我們的代碼還是有很多點(diǎn)可以進(jìn)行改進(jìn)的
error必須被處理,到底應(yīng)該在哪里處理?
在頂級(jí)處理或者”運(yùn)行“方法上進(jìn)行處理!?。。?!
首先觀點(diǎn)先給你們拋出來(lái),很多人聽(tīng)起來(lái)一句帶過(guò),之前我也是的,但是看到我們工程的滿屏日志的時(shí)候我重新審視了一下這句話。我一般把項(xiàng)目分為這兩類:
(1)API項(xiàng)目
在api項(xiàng)目的上,我們架構(gòu)分層大概是:controller ,service ,dao。 controller 進(jìn)行參數(shù)校驗(yàn),結(jié)果返回。service 主要處理邏輯,組裝結(jié)果。dao層主要就是數(shù)據(jù)庫(kù)的操作。按照上面的說(shuō)法頂級(jí)處理或者運(yùn)行方法處理那么就是在controller這個(gè)運(yùn)行點(diǎn)處理錯(cuò)誤并返回結(jié)果。
(2)服務(wù)項(xiàng)目
一般服務(wù)項(xiàng)目就是消耗數(shù)據(jù),進(jìn)行其他的一些操作,我們內(nèi)部項(xiàng)目一般就抽象成消費(fèi)生產(chǎn)者模式,那么這種模式下,我們一般是屬于消費(fèi)端,或者兩個(gè)端都會(huì)存在服務(wù)中,比如爬蟲(chóng),發(fā)起請(qǐng)求,處理結(jié)果,兩者都存在程序中。我們依舊是把這個(gè)抽象成一個(gè)消費(fèi)生產(chǎn)模式,我們生成一個(gè)請(qǐng)求,然后在結(jié)構(gòu)體中包裹回調(diào)方法,在具體的handler方法中處理,那么95%的業(yè)務(wù)報(bào)錯(cuò)我都能在運(yùn)行端記錄,也就是handler記錄。
如何操作error讓我們能夠更加優(yōu)雅
就算解決了上面的error被處理問(wèn)題:在運(yùn)行點(diǎn)或者頂級(jí)方法記錄日志或者報(bào)警。
我們還是要在邏輯業(yè)務(wù)里面寫(xiě)上滿屏的:
if err !=nil{
return err
}
1 . 選擇侵入式的代碼,傳遞指針進(jìn)入方法,返回錯(cuò)誤
func Select(str *string)(err error){
*str ="contvffadf"
return
}
2.統(tǒng)一參數(shù)傳遞返回參數(shù),盡可能減少參數(shù)的判斷
3.重建結(jié)構(gòu)處理錯(cuò)誤返回,這個(gè)后面補(bǔ)上 案例// todo
拿不到堆棧信息怎么辦
當(dāng)我們將所有的錯(cuò)誤都返回出去,實(shí)際上看過(guò)錯(cuò)誤源碼的人都知道,error內(nèi)部實(shí)際上就是一個(gè)字符串,那么該怎么辦呢。
強(qiáng)大的error wrap
使用 :github.com/pkg/errors
使用這個(gè)包下面的方法
package main
import (
"STL/demo/deni"
"fmt"
"github.com/pkg/errors"
)
func main() {
err :=B()
fmt.Printf("stack error trace:\n%+v\n",err)
fmt.Println(err)
fmt.Println(errors.Cause(err))
}
func B()error {
return errors.Wrap(deni.Demo2(), "B方法也壞掉了")
}
package deni
import (
"github.com/pkg/errors"
)
func Demo1 ()error {
e := errors.New("原始錯(cuò)誤e")
return e
}
func Demo2 ()error {
e := Demo1()
w := errors.Wrap(e,"包裝第一下")
return w
}
這里是運(yùn)行的時(shí)候的堆棧
stack error trace:
原始錯(cuò)誤e
STL/demo/deni.Demo1
/Users/shenchenxi/go/src/STL/demo/deni/hh.go:8
STL/demo/deni.Demo2
/Users/shenchenxi/go/src/STL/demo/deni/hh.go:14
main.B
/Users/shenchenxi/go/src/STL/demo/main.go:17
main.main
/Users/shenchenxi/go/src/STL/demo/main.go:9
runtime.main
/usr/local/go/src/runtime/proc.go:203
runtime.goexit
/usr/local/go/src/runtime/asm_amd64.s:1373
包裝第一下
STL/demo/deni.Demo2
/Users/shenchenxi/go/src/STL/demo/deni/hh.go:15
main.B
/Users/shenchenxi/go/src/STL/demo/main.go:17
main.main
/Users/shenchenxi/go/src/STL/demo/main.go:9
runtime.main
/usr/local/go/src/runtime/proc.go:203
runtime.goexit
/usr/local/go/src/runtime/asm_amd64.s:1373
B方法也壞掉了
main.B
/Users/shenchenxi/go/src/STL/demo/main.go:17
main.main
/Users/shenchenxi/go/src/STL/demo/main.go:9
runtime.main
/usr/local/go/src/runtime/proc.go:203
runtime.goexit
/usr/local/go/src/runtime/asm_amd64.s:1373
B方法也壞掉了: 包裝第一下: 原始錯(cuò)誤e
原始錯(cuò)誤e
Process finished with exit code 0
通過(guò)以上幾點(diǎn)就基本上可以非常工程化的處理error了
這個(gè)案例是我們工作中的實(shí)際案例,公司內(nèi)部博文,但是也是我寫(xiě)的啦
API統(tǒng)一錯(cuò)誤處理
1.Err錯(cuò)誤種類:
- 第一種是系統(tǒng)錯(cuò)誤包括:數(shù)據(jù)庫(kù)連接錯(cuò)誤,redis連接錯(cuò)誤,調(diào)用第三方包的錯(cuò)誤。這類錯(cuò)誤我們不可控制
- 第二種邏輯錯(cuò)誤:eg:參數(shù)校驗(yàn)錯(cuò)誤,數(shù)據(jù)讀取錯(cuò)誤,錯(cuò)誤碼
2.接口自定義錯(cuò)誤類型:
type MyError struct {
err string
Code int64
}
func (m *MyError) Error() string {
return m.err
}
func New(str string, code int64) error {
return &MyError{
err: str,
Code: code,
}
}
3.錯(cuò)誤MAP (錯(cuò)誤map 配合內(nèi)部代碼錯(cuò)誤使用)
- 所有的邏輯使用內(nèi)部錯(cuò)誤函數(shù),配合錯(cuò)誤map來(lái)進(jìn)行向上拋出
- 所有非邏輯錯(cuò)誤都配合github.com/pkg/errors 報(bào)錯(cuò),這種錯(cuò)誤可以綁定錯(cuò)誤堆棧
3.接管錯(cuò)誤 ("建議在中間件上面使用這類代碼,統(tǒng)一返回給前端")
func ResponseData(c *gin.Context, err error, data interface{}) {
if data == "" || data == nil {
data = make([]int, 0)
}
resp := &Response{Data: data,Ret: 0,Msg: "success"}
if err !=nil{ // 這里是錯(cuò)誤模式
if tem, ok := err.(*myerror.MyError); ok {
//這是第二類邏輯錯(cuò)誤
resp = &Response{Ret: tem.Code, Msg: myerror.ErrText[tem.Code], Data: make([]int,0)}
} else {
// 第一類未知錯(cuò)誤
stack := fmt.Sprintf("stack error trace:\n%+v\n", err) //錯(cuò)誤的堆棧
fmt.Println(stack)
public.ZapLog.Error(stack)
//返回給前端
resp = &Response{Ret: myerror.COMMENT_ERROR, Msg: myerror.ErrText[myerror.COMMENT_ERROR], Data: make([]int,0)}
}
}
c.Header("Access-Control-Allow-Origin", "*")
c.JSON(200, resp)
c.Abort()
}
為了API的高可用和高度靈活,錯(cuò)誤處理是非?;A(chǔ)且非常重要的一環(huán),需要好好處理