Go语言一次真实的错误吞并的教训

在几天前写的代码中，犯了几个比较典型的错误，带来不小的麻烦。特在此复现一下，吸取教训。

成都创新互联是创新、创意、研发型一体的综合型网站建设公司，自成立以来公司不断探索创新，始终坚持为客户提供满意周到的服务，在本地打下了良好的口碑，在过去的十年时间我们累计服务了上千家以及全国政企客户，如成都办公空间设计等企业单位，完善的项目管理流程，严格把控项目进度与质量监控加上过硬的技术实力获得客户的一致赞誉。

情景描述

代码中需要实现一个客户端与服务器的数据重传机制，通过write写数据给服务器，read读取服务器返回。一旦中途发生错误，每隔1s就尝试重新写读数据。当超过上下文时间，重传失败。重传实现代码retry如下。

 
 
 
    
  
  
  
  1. func retry(ctx context.Context) (data string, err error) { 
    2. 
  
  
  
  2.  
    3. 
  
  
  
  3. LOOP: 
    4. 
  
  
  
  4.  for i:=1;;i++{ 
    5. 
  
  
  
  5.   err = write() 
    6. 
  
  
  
  6.   if err == nil{ 
    7. 
  
  
  
  7.    res, err := read() 
    8. 
  
  
  
  8.    if err == nil{ 
    9. 
  
  
  
  9.     data = string(res) 
    10. 
  
  
  
  10.     return data, err 
    11. 
  
  
  
  11.    } 
    12. 
  
  
  
  12.   } 
    13. 
  
  
  
  13.  
    14. 
  
  
  
  14.   log.Printf("change data failed, err: %v, retry times : %d\n", err, i) 
    15. 
  
  
  
  15.  
    16. 
  
  
  
  16.   select { 
    17. 
  
  
  
  17.   case <-ctx.Done(): 
    18. 
  
  
  
  18.    log.Printf("retry failed") 
    19. 
  
  
  
  19.    break LOOP 
    20. 
  
  
  
  20.   case <-time.After(1 * time.Second): 
    21. 
  
  
  
  21.   } 
    22. 
  
  
  
  22.  } 
    23. 
  
  
  
  23.  return "", err 
    24. 
  
  
  
  24. } 
    25.

读写服务器数据函数和调用重传代码mock如下。

 
 
 
    
  
  
  
  1. func write() error { 
    2. 
  
  
  
  2.  return nil 
    3. 
  
  
  
  3. } 
    4. 
  
  
  
  4.  
    5. 
  
  
  
  5. func read() ([]byte, error) { 
    6. 
  
  
  
  6.  return []byte("hello world"), errors.New("this is a error") 
    7. 
  
  
  
  7. } 
    8. 
  
  
  
  8.  
    9. 
  
  
  
  9. func main() { 
    10. 
  
  
  
  10.  ctx,_ := context.WithTimeout(context.Background(),5*time.Second) 
    11. 
  
  
  
  11.  _, _ = retry(ctx) 
    12. 
  
  
  
  12.  time.Sleep(10*time.Second) 
    13. 
  
  
  
  13. } 
    14.

write返回err为nil，read有非nil返回。这种情况下，日志输出如下。

 
 
 
    
  
  
  
  1. 2020/07/05 09:30:57 change data failed, err: , retry times : 1 
    2. 
  
  
  
  2. 2020/07/05 09:30:58 change data failed, err: , retry times : 2 
    3. 
  
  
  
  3. 2020/07/05 09:30:59 change data failed, err: , retry times : 3 
    4. 
  
  
  
  4. 2020/07/05 09:31:00 change data failed, err: , retry times : 4 
    5. 
  
  
  
  5. 2020/07/05 09:31:01 change data failed, err: , retry times : 5 
    6. 
  
  
  
  6. 2020/07/05 09:31:02 retry failed 
    7.

原因分析

可以看到的是，如预想的一样：当发生错误时，就重新尝试write和read。即重传机制生效。但是，日志中为何err会为nil，read方法的错误返回被吞掉了?

经过排查，发现原因就在于——Go语法糖:=(短变量声明)的不当使用。

 
 
 
    
  
  
  
  1. err = write() 
    2. 
  
  
  
  2.  if err == nil{ 
    3. 
  
  
  
  3.   res, err := read() 
    4. 
  
  
  
  4.   if err == nil{ 
    5. 
  
  
  
  5.    data = string(res) 
    6. 
  
  
  
  6.    return data, err 
    7. 
  
  
  
  7.   } 
    8. 
  
  
  
  8.  } 
    9. 
  
  
  
  9.  
    10. 
  
  
  
  10.  log.Printf("change data failed, err: %v, retry times : %d\n", err, i) 
    11.

在retry中，err是已被声明的变量类型error。由于read返回的是两个变量，故小菜刀在此利用短变量声明res变量，接受read的第一个返回参数。但是，此举会改变err的作用范围：err成为了一个局部变量。什么意思呢?即此时的err被短变量声明所作用，成为了新声明对象，它只能作用于内部区域了。对于外部log.Printf而言，其引用到的err还是write方法生成的err对象。因此，即使read方法返回的err不为空，log.Printf打印的还是write方法的err结果，导致read的err内容被吞。

因此，为了避免此类错误发生，相应代码调整如下。

 
 
 
    
  
  
  
  1. var res []byte 
    2. 
  
  
  
  2.  res, err = read() 
    3. 
  
  
  
  3.  if err == nil{ 
    4. 
  
  
  
  4.   data = string(res) 
    5. 
  
  
  
  5.   return data, err 
    6. 
  
  
  
  6.  } 
    7.

此时，当read返回err非nil时，日志打印如下。

 
 
 
    
  
  
  
  1. 2020/07/05 09:46:16 change data failed, err: this is a error, retry times : 1 
    2. 
  
  
  
  2. 2020/07/05 09:46:17 change data failed, err: this is a error, retry times : 2 
    3. 
  
  
  
  3. 2020/07/05 09:46:18 change data failed, err: this is a error, retry times : 3 
    4. 
  
  
  
  4. 2020/07/05 09:46:19 change data failed, err: this is a error, retry times : 4 
    5. 
  
  
  
  5. 2020/07/05 09:46:20 change data failed, err: this is a error, retry times : 5 
    6. 
  
  
  
  6. 2020/07/05 09:46:21 retry failed 
    7.

总结

一、Go语法糖——短变量声明(:=)使用注意事项。

  • :=表示声明+赋值。
  •  短变量声明不需要声明所有在左边的变量。如果一些变量在同一个词法块中声明，那么对于这些变量，短声明的行为等同于赋值(同时更改了这些变量的作用域)。

二、异常判断规则

在上述场景代码中，是一个多层级条件判断的情形，其判断规则是err为nil。但这是一种不恰当的处理逻辑。合理的判断条件，是对异常情况作判断，而将正常逻辑置于条件之外。那么，修改后的retry条件判断逻辑应该如下所示。

 
 
 
    
  
  
  
  1. func retry(ctx context.Context) (data string, err error) { 
    2. 
  
  
  
  2.  
    3. 
  
  
  
  3. LOOP: 
    4. 
  
  
  
  4.  for i:=1;;i++{ 
    5. 
  
  
  
  5.   err = write() 
    6. 
  
  
  
  6.   if err != nil{ 
    7. 
  
  
  
  7.    log.Printf("write data failed, err: %v, retry times : %d\n", err, i) 
    8. 
  
  
  
  8.    select { 
    9. 
  
  
  
  9.    case <-ctx.Done(): 
    10. 
  
  
  
  10.     log.Printf("retry failed") 
    11. 
  
  
  
  11.     break LOOP 
    12. 
  
  
  
  12.    case <-time.After(1 * time.Second): 
    13. 
  
  
  
  13.    } 
    14. 
  
  
  
  14.    continue 
    15. 
  
  
  
  15.   } 
    16. 
  
  
  
  16.  
    17. 
  
  
  
  17.   res, err := read() 
    18. 
  
  
  
  18.   if err != nil{ 
    19. 
  
  
  
  19.    log.Printf("read data failed, err: %v, retry times : %d\n", err, i) 
    20. 
  
  
  
  20.    select { 
    21. 
  
  
  
  21.    case <-ctx.Done(): 
    22. 
  
  
  
  22.     log.Printf("retry failed") 
    23. 
  
  
  
  23.     break LOOP 
    24. 
  
  
  
  24.    case <-time.After(1 * time.Second): 
    25. 
  
  
  
  25.    } 
    26. 
  
  
  
  26.    continue 
    27. 
  
  
  
  27.   } 
    28. 
  
  
  
  28.  
    29. 
  
  
  
  29.   data = string(res) 
    30. 
  
  
  
  30.   return data, err 
    31. 
  
  
  
  31.  
    32. 
  
  
  
  32.  } 
    33. 
  
  
  
  33.  return "", err 
    34. 
  
  
  
  34. } 
    35.

这样，正常的处理流程，其主逻辑均在最外层，只有异常情况(err!=nil)才进入异常处理逻辑。当采用这种判断规则之后，就不存在多层条件嵌套语句，由语法糖带来的问题，也不复存在。

分享标题：Go语言一次真实的错误吞并的教训
转载来源：http://www.shufengxianlan.com/qtweb/news12/43312.html

网站建设、网络推广公司-创新互联，是专注品牌与效果的网站制作，网络营销seo公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 创新互联

猜你还喜欢下面的内容

网站策划知识

分类信息网站

成都网站运营维护　　 　乐山服务器托管　　 　丹棱网站建设　　 　腾讯云香港虚拟主机　　 　App开发　　 　贵州义龙电信机房　　 　成都租用服务器　　 　珉田数据中心　　 　成都网站推广　　 　成都小程序商城　　 　重庆网站营销　　 　营销推广　　 　重庆网站建设　　 　app软件开发　　 　网站建设改版　　 　成都纯水机　　 　温江电信机房　　 　成都花箱厂家　　 　bgp机房托管　　 　成都网站维护