在业务代码开发过程中，我们会有很大概率使用go语言的goroutine来开启一个新的goroutine执行另外一段业务，或者开启多个goroutine来并行执行多个业务逻辑。所以我为hade框架增加了两个方法goroutine.SafeGo 和 goroutine.SafeGoAndWait。
image.png

封装

SafeGo

SafeGo 这个函数，提供了一种goroutine安全的函数调用方式。主要适用于业务中需要进行开启异步goroutine业务逻辑调用的场景。

  1. / SafeGo 进行安全的goroutine调用
  2. // 第一个参数是context接口，如果还实现了Container接口，且绑定了日志服务，则使用日志服务
  3. // 第二个参数是匿名函数handler, 进行最终的业务逻辑
  4. // SafeGo 函数并不会返回error，panic都会进入hade的日志服务
  5. func SafeGo(ctx context.Context, handler func())

调用方式参照如下的单元测试用例：

  1. func TestSafeGo(t *testing.T) {
  2.     container := tests.InitBaseContainer()
  3.     container.Bind(&log.HadeTestingLogProvider{})
  5.     ctx, _ := gin.CreateTestContext(httptest.NewRecorder())
  6.     goroutine.SafeGo(ctx, func() {
  7.         time.Sleep(1 * time.Second)
  8.         return
  9.     })
  10.     t.Log("safe go main start")
  11.     time.Sleep(2 * time.Second)
  12.     t.Log("safe go main end")
  14.     goroutine.SafeGo(ctx, func() {
  15.         time.Sleep(1 * time.Second)
  16.         panic("safe go test panic")
  17.     })
  18.     t.Log("safe go2 main start")
  19.     time.Sleep(2 * time.Second)
  20.     t.Log("safe go2 main end")
  22. }

SafeGoAndWait

SafeGoAndWait 这个函数，提供安全的多并发调用方式。该函数等待所有函数都结束后才返回。

  1. // SafeGoAndWait 进行并发安全并行调用
  2. // 第一个参数是context接口，如果还实现了Container接口，且绑定了日志服务，则使用日志服务
  3. // 第二个参数是匿名函数handlers数组, 进行最终的业务逻辑
  4. // 返回handlers中任何一个错误（如果handlers中有业务逻辑返回错误）
  5. func SafeGoAndWait(ctx context.Context, handlers ...func() error) error

调用方式参照如下的单元测试用例：

  1. func TestSafeGoAndWait(t *testing.T) {
  2.     container := tests.InitBaseContainer()
  3.     container.Bind(&log.HadeTestingLogProvider{})
  5.     errStr := "safe go test error"
  6.     t.Log("safe go and wait start", time.Now().String())
  7.     ctx, _ := gin.CreateTestContext(httptest.NewRecorder())
  9.     err := goroutine.SafeGoAndWait(ctx, func() error {
  10.         time.Sleep(1 * time.Second)
  11.         return errors.New(errStr)
  12.     }, func() error {
  13.         time.Sleep(2 * time.Second)
  14.         return nil
  15.     }, func() error {
  16.         time.Sleep(3 * time.Second)
  17.         return nil
  18.     })
  19.     t.Log("safe go and wait end", time.Now().String())
  21.     if err == nil {
  22.         t.Error("err not be nil")
  23.     } else if err.Error() != errStr {
  24.         t.Error("err content not same")
  25.     }
  27.     // panic error
  28.     err = goroutine.SafeGoAndWait(ctx, func() error {
  29.         time.Sleep(1 * time.Second)
  30.         return errors.New(errStr)
  31.     }, func() error {
  32.         time.Sleep(2 * time.Second)
  33.         panic("test2")
  34.     }, func() error {
  35.         time.Sleep(3 * time.Second)
  36.         return nil
  37.     })
  38.     if err == nil {
  39.         t.Error("err not be nil")
  40.     } else if err.Error() != errStr {
  41.         t.Error("err content not same")
  42.     }
  43. }

实现说明

实现方面，有几个难点记录下。

首先是接口设计方面

可以看到handler函数在两个接口中是不一样的。在SafeGo接口中，handler定义为func() 而在SafeGoAndWait中，定义为func() error
两者的区别就在于SafeGo这个接口是没有能力处理error的，因为它go出去一个goroutine就直接进行接下来的操作了。而SafeGoAndWait是必须等到所有的请求结束，所以它是有能力接收到error的。
所以SafeGo的handler没有必要设置error返回值，而SafeGoAndWait是可以设置error的。

其次是日志兼容hade

如果出现了panic，如何将panic的日志打印出来。
整个框架我们并不希望有任何的全局变量，包括全局的Log，所以我这里做了一个兼容逻辑。
如果只是传递一个context，我们就使用官方的log包进行打印。
如果传递的是一个即实现了context，又实现了container接口的结构，我们就从container中获取日志服务，来进行日志打印。这样框架的所有日志就能统一在日志打印里面。

  1. if logger != nil {
  2.     logger.Error(ctx, "safe go handler panic", map[string]interface{}{
  3.                             "stack": string(buf),
  4.                             "err":   e,
  5.                         })
  6.                 } else {
  7.                         log.Printf("panic\t%v\t%s", e, buf)
  8.                 }

由于我们修改了gin的context，让它支持了我们的container容器结构，所以我们可以直接将gin.Context传递进来。具体使用起来就像这样了：

  1. // DemoGoroutine goroutine 的使用示例
  2. func (api *DemoApi) DemoGoroutine(c *gin.Context) {
  3.     logger := c.MustMakeLog()
  4.     logger.Info(c, "request start", nil)
  6.     // 初始化一个orm.DB
  7.     gormService := c.MustMake(contract.ORMKey).(contract.ORMService)
  8.     db, err := gormService.GetDB(orm.WithConfigPath("database.default"))
  9.     if err != nil {
  10.         logger.Error(c, err.Error(), nil)
  11.         c.AbortWithError(50001, err)
  12.         return
  13.     }
  14.     db.WithContext(c)
  16.     err = goroutine.SafeGoAndWait(c, func() error {
  17.         // 查询一条数据
  18.         queryUser := &User{ID: 1}
  20.         err = db.First(queryUser).Error
  21.         logger.Info(c, "query user1", map[string]interface{}{
  22.             "err":  err,
  23.             "name": queryUser.Name,
  24.         })
  25.         return err
  26.     }, func() error {
  27.         // 查询一条数据
  28.         queryUser := &User{ID: 2}
  30.         err = db.First(queryUser).Error
  31.         logger.Info(c, "query user2", map[string]interface{}{
  32.             "err":  err,
  33.             "name": queryUser.Name,
  34.         })
  35.         return err
  36.     })
  38.     if err != nil {
  39.         c.AbortWithError(50001, err)
  40.         return
  41.     }
  42.     c.JSON(200, "ok")
  43. }

最后是打印panic的trace记录

官方的panic其实打印的是所有goroutine的堆栈信息。但是这里我们希望打印的是出panic的那个堆栈信息。所以我们会使用
debug.Stack()
来打印出问题的goroutine的堆栈信息。
为了打印美观，这里将换行符统一替换为\n 来进行展示。
具体的实现代码可以参考github地址：https://github.com/gohade/hade/blob/main/framework/util/goroutine/goroutine.go
说明文档：https://github.com/gohade/hade/blob/main/docs/guide/util.md

总结

为hade封装了两个SafeGo方法。特别是第二个SafeGoAndWait，在实际工作中确实是非常有用的。