建站
咨詢(xún)
售后
建站咨詢(xún)
新聞中心
在幾天前寫(xiě)的代碼中，犯了幾個(gè)比較典型的錯(cuò)誤，帶來(lái)不小的麻煩。特在此復(fù)現(xiàn)一下，吸取教訓(xùn)。
成都創(chuàng)新互聯(lián)是創(chuàng)新、創(chuàng)意、研發(fā)型一體的綜合型網(wǎng)站建設(shè)公司，自成立以來(lái)公司不斷探索創(chuàng)新，始終堅(jiān)持為客戶(hù)提供滿(mǎn)意周到的服務(wù)，在本地打下了良好的口碑，在過(guò)去的十年時(shí)間我們累計(jì)服務(wù)了上千家以及全國(guó)政企客戶(hù)，如成都辦公空間設(shè)計(jì)等企業(yè)單位，完善的項(xiàng)目管理流程，嚴(yán)格把控項(xiàng)目進(jìn)度與質(zhì)量監(jiān)控加上過(guò)硬的技術(shù)實(shí)力獲得客戶(hù)的一致贊譽(yù)。
情景描述
代碼中需要實(shí)現(xiàn)一個(gè)客戶(hù)端與服務(wù)器的數(shù)據(jù)重傳機(jī)制，通過(guò)write寫(xiě)數(shù)據(jù)給服務(wù)器，read讀取服務(wù)器返回。一旦中途發(fā)生錯(cuò)誤，每隔1s就嘗試重新寫(xiě)讀數(shù)據(jù)。當(dāng)超過(guò)上下文時(shí)間，重傳失敗。重傳實(shí)現(xiàn)代碼retry如下。
- func retry(ctx context.Context) (data string, err error) {
- LOOP:
- for i:=1;;i++{
- err = write()
- if err == nil{
- res, err := read()
- if err == nil{
- data = string(res)
- return data, err
- }
- }
- log.Printf("change data failed, err: %v, retry times : %d\n", err, i)
- select {
- case <-ctx.Done():
- log.Printf("retry failed")
- break LOOP
- case <-time.After(1 * time.Second):
- }
- }
- return "", err
- }
讀寫(xiě)服務(wù)器數(shù)據(jù)函數(shù)和調(diào)用重傳代碼mock如下。
- func write() error {
- return nil
- }
- func read() ([]byte, error) {
- return []byte("hello world"), errors.New("this is a error")
- }
- func main() {
- ctx,_ := context.WithTimeout(context.Background(),5*time.Second)
- _, _ = retry(ctx)
- time.Sleep(10*time.Second)
- }
write返回err為nil，read有非nil返回。這種情況下，日志輸出如下。
- 2020/07/05 09:30:57 change data failed, err:
, retry times : 1 - 2020/07/05 09:30:58 change data failed, err:
, retry times : 2 - 2020/07/05 09:30:59 change data failed, err:
, retry times : 3 - 2020/07/05 09:31:00 change data failed, err:
, retry times : 4 - 2020/07/05 09:31:01 change data failed, err:
, retry times : 5 - 2020/07/05 09:31:02 retry failed
原因分析
可以看到的是，如預(yù)想的一樣：當(dāng)發(fā)生錯(cuò)誤時(shí)，就重新嘗試write和read。即重傳機(jī)制生效。但是，日志中為何err會(huì)為nil，read方法的錯(cuò)誤返回被吞掉了?
經(jīng)過(guò)排查，發(fā)現(xiàn)原因就在于——Go語(yǔ)法糖:=(短變量聲明)的不當(dāng)使用。
- err = write()
- if err == nil{
- res, err := read()
- if err == nil{
- data = string(res)
- return data, err
- }
- }
- log.Printf("change data failed, err: %v, retry times : %d\n", err, i)
在retry中，err是已被聲明的變量類(lèi)型error。由于read返回的是兩個(gè)變量，故小菜刀在此利用短變量聲明res變量，接受read的第一個(gè)返回參數(shù)。但是，此舉會(huì)改變err的作用范圍：err成為了一個(gè)局部變量。什么意思呢?即此時(shí)的err被短變量聲明所作用，成為了新聲明對(duì)象，它只能作用于內(nèi)部區(qū)域了。對(duì)于外部log.Printf而言，其引用到的err還是write方法生成的err對(duì)象。因此，即使read方法返回的err不為空，log.Printf打印的還是write方法的err結(jié)果，導(dǎo)致read的err內(nèi)容被吞。
因此，為了避免此類(lèi)錯(cuò)誤發(fā)生，相應(yīng)代碼調(diào)整如下。
- var res []byte
- res, err = read()
- if err == nil{
- data = string(res)
- return data, err
- }
此時(shí)，當(dāng)read返回err非nil時(shí)，日志打印如下。
- 2020/07/05 09:46:16 change data failed, err: this is a error, retry times : 1
- 2020/07/05 09:46:17 change data failed, err: this is a error, retry times : 2
- 2020/07/05 09:46:18 change data failed, err: this is a error, retry times : 3
- 2020/07/05 09:46:19 change data failed, err: this is a error, retry times : 4
- 2020/07/05 09:46:20 change data failed, err: this is a error, retry times : 5
- 2020/07/05 09:46:21 retry failed
總結(jié)
一、Go語(yǔ)法糖——短變量聲明(:=)使用注意事項(xiàng)。
- :=表示聲明+賦值。
- 短變量聲明不需要聲明所有在左邊的變量。如果一些變量在同一個(gè)詞法塊中聲明，那么對(duì)于這些變量，短聲明的行為等同于賦值(同時(shí)更改了這些變量的作用域)。
二、異常判斷規(guī)則
在上述場(chǎng)景代碼中，是一個(gè)多層級(jí)條件判斷的情形，其判斷規(guī)則是err為nil。但這是一種不恰當(dāng)?shù)奶幚磉壿?。合理的判斷條件，是對(duì)異常情況作判斷，而將正常邏輯置于條件之外。那么，修改后的retry條件判斷邏輯應(yīng)該如下所示。
- func retry(ctx context.Context) (data string, err error) {
- LOOP:
- for i:=1;;i++{
- err = write()
- if err != nil{
- log.Printf("write data failed, err: %v, retry times : %d\n", err, i)
- select {
- case <-ctx.Done():
- log.Printf("retry failed")
- break LOOP
- case <-time.After(1 * time.Second):
- }
- continue
- }
- res, err := read()
- if err != nil{
- log.Printf("read data failed, err: %v, retry times : %d\n", err, i)
- select {
- case <-ctx.Done():
- log.Printf("retry failed")
- break LOOP
- case <-time.After(1 * time.Second):
- }
- continue
- }
- data = string(res)
- return data, err
- }
- return "", err
- }
這樣，正常的處理流程，其主邏輯均在最外層，只有異常情況(err!=nil)才進(jìn)入異常處理邏輯。當(dāng)采用這種判斷規(guī)則之后，就不存在多層條件嵌套語(yǔ)句，由語(yǔ)法糖帶來(lái)的問(wèn)題，也不復(fù)存在。
分享標(biāo)題：Go語(yǔ)言一次真實(shí)的錯(cuò)誤吞并的教訓(xùn)
分享鏈接：http://www.dlmjj.cn/article/cdoochh.html
