如何优雅地实现并发编排任务

开发 前端
一个应用首页可能依托于很多服务。那就涉及到在加载页面时需要同时请求多个服务的接口。这一步往往是由后端统一调用组装数据再返回给前端,也就是所谓的 BFF(Backend For Frontend) 层。

 [[399159]]

本文转载自微信公众号「吴亲强的深夜食堂」,作者吴亲库里。转载本文请联系吴亲强的深夜食堂公众号。

业务场景

在做任务开发的时候,你们一定会碰到以下场景:

场景1:调用第三方接口的时候, 一个需求你需要调用不同的接口,做数据组装。

场景2:一个应用首页可能依托于很多服务。那就涉及到在加载页面时需要同时请求多个服务的接口。这一步往往是由后端统一调用组装数据再返回给前端,也就是所谓的 BFF(Backend For Frontend) 层。

针对以上两种场景,假设在没有强依赖关系下,选择串行调用,那么总耗时即:

  1. time=s1+s2+....sn 

按照当代秒入百万的有为青年,这么长时间早就把你祖宗十八代问候了一遍。

为了伟大的KPI,我们往往会选择并发地调用这些依赖接口。那么总耗时就是:

  1. time=max(s1,s2,s3.....,sn) 

当然开始堆业务的时候可以先串行化,等到上面的人着急的时候,亮出绝招。

这样,年底 PPT 就可以加上浓重的一笔流水账:为业务某个接口提高百分之XXX性能,间接产生XXX价值。

当然这一切的前提是,做老板不懂技术,做技术”懂”你。

言归正传,如果修改成并发调用,你可能会这么写,

  1. package main 
  2.  
  3. import ( 
  4.     "fmt" 
  5.     "sync" 
  6.     "time" 
  7.  
  8. func main() { 
  9.     var wg sync.WaitGroup 
  10.     wg.Add(2) 
  11.  
  12.     var userInfo *User 
  13.     var productList []Product 
  14.  
  15.     go func() { 
  16.         defer wg.Done() 
  17.         userInfo, _ = getUser() 
  18.     }() 
  19.  
  20.     go func() { 
  21.         defer wg.Done() 
  22.         productList, _ = getProductList() 
  23.     }() 
  24.     wg.Wait() 
  25.     fmt.Printf("用户信息:%+v\n", userInfo) 
  26.     fmt.Printf("商品信息:%+v\n", productList) 
  27.  
  28.  
  29. /********用户服务**********/ 
  30.  
  31. type User struct { 
  32.     Name string 
  33.     Age uint8 
  34.  
  35. func getUser() (*User, error) { 
  36.     time.Sleep(500 * time.Millisecond) 
  37.     var u User 
  38.     u.Name = "wuqinqiang" 
  39.     u.Age = 18 
  40.     return &u, nil 
  41.  
  42. /********商品服务**********/ 
  43.  
  44. type Product struct { 
  45.     Title string 
  46.     Price uint32 
  47.  
  48. func getProductList() ([]Product, error) { 
  49.     time.Sleep(400 * time.Millisecond) 
  50.     var list []Product 
  51.     list = append(list, Product{ 
  52.         Title: "SHib"
  53.         Price: 10, 
  54.     }) 
  55.     return list, nil 

从实现上来说,需要多少服务,会开多少个 G,利用 sync.WaitGroup 的特性,

实现并发编排任务的效果。

好像,问题不大。

但是随着代号 996 业务场景的增加,你会发现,好多模块都有相似的功能,只是对应的业务场景不同而已。

那么我们能不能抽像出一套针对此业务场景的工具,而把具体业务实现交给业务方。

使用

本着不重复造轮子的原则,去搜了下开源项目,最终看上了 go-zero 里面的一个工具 mapreduce。

可以自行 Google 这个名词。

使用很简单。我们通过它改造一下上面的代码:

  1. package main 
  2.  
  3. import ( 
  4.     "fmt" 
  5.     "github.com/tal-tech/go-zero/core/mr" 
  6.     "time" 
  7.  
  8. func main() { 
  9.     var userInfo *User 
  10.     var productList []Product 
  11.     _ = mr.Finish(func() (err error) { 
  12.         userInfo, err = getUser() 
  13.         return err 
  14.     }, func() (err error) { 
  15.         productList, err = getProductList() 
  16.         return err 
  17.     }) 
  18.     fmt.Printf("用户信息:%+v\n", userInfo) 
  19.     fmt.Printf("商品信息:%+v\n", productList) 
  20. //打印 
  21. 用户信息:&{Name:wuqinqiang Age:18} 
  22. 商品信息:[{Title:SHib Price:10}] 

是不是舒服多了。

但是这里还需要注意一点,假设你调用的其中一个服务错误,并且你 return err 对应的错误,那么其他调用的服务会被取消。

比如我们修改 getProductList 直接响应错误。

  1. func getProductList() ([]Product, error) { 
  2.     return nil, errors.New("test error"
  3. //打印 
  4. // 用户信息:<nil> 
  5. // 商品信息:[] 

那么最终打印的时候连用户信息都会为空,因为出现一个服务错误,用户服务请求被取消了。

一般情况下,在请求服务错误的时候我们会有保底操作,一个服务错误不能影响其他请求的结果。

所以在使用的时候具体处理取决于业务场景。

源码

既然用了,那么就追下源码吧。

  1. func Finish(fns ...func() error) error { 
  2.     if len(fns) == 0 { 
  3.         return nil 
  4.     } 
  5.  
  6.     return MapReduceVoid(func(source chan<- interface{}) { 
  7.         for _, fn := range fns { 
  8.             source <- fn 
  9.         } 
  10.     }, func(item interface{}, writer Writer, cancel func(error)) { 
  11.         fn := item.(func() error) 
  12.         if err := fn(); err != nil { 
  13.             cancel(err) 
  14.         } 
  15.     }, func(pipe <-chan interface{}, cancel func(error)) { 
  16.         drain(pipe) 
  17.     }, WithWorkers(len(fns))) 
  18. }  
  1. func MapReduceVoid(generator GenerateFunc, mapper MapperFunc, reducer VoidReducerFunc, opts ...Option) error { 
  2.     _, err := MapReduce(generator, mapper, func(input <-chan interface{}, writer Writer, cancel func(error)) { 
  3.         reducer(input, cancel) 
  4.         drain(input) 
  5.         // We need to write a placeholder to let MapReduce to continue on reducer done, 
  6.         // otherwise, all goroutines are waiting. The placeholder will be discarded by MapReduce. 
  7.         writer.Write(lang.Placeholder) 
  8.     }, opts...) 
  9.     return err 

对于 MapReduceVoid函数,主要查看三个闭包参数。

  • 第一个 GenerateFunc 用于生产数据。
  • MapperFunc 读取生产出的数据,进行处理。
  • VoidReducerFunc 这里表示不对 mapper 后的数据做聚合返回。所以这个闭包在此操作几乎0作用。
  1. func MapReduce(generate GenerateFunc, mapper MapperFunc, reducer ReducerFunc, opts ...Option) (interface{}, error) { 
  2.     source := buildSource(generate)  
  3.     return MapReduceWithSource(source, mapper, reducer, opts...) 
  4.  
  5. func buildSource(generate GenerateFunc) chan interface{} { 
  6.     source := make(chan interface{})// 创建无缓冲通道 
  7.     threading.GoSafe(func() { 
  8.         defer close(source) 
  9.         generate(source) //开始生产数据 
  10.     }) 
  11.  
  12.     return source //返回无缓冲通道 

buildSource函数中,返回一个无缓冲的通道。并开启一个 G 运行 generate(source),往无缓冲通道塞数据。这个generate(source) 不就是一开始 Finish 传递的第一个闭包参数。

  1. return MapReduceVoid(func(source chan<- interface{}) { 
  2.     // 就这个 
  3.         for _, fn := range fns { 
  4.             source <- fn 
  5.         } 
  6.     }) 

然后查看 MapReduceWithSource 函数,

  1. func MapReduceWithSource(source <-chan interface{}, mapper MapperFunc, reducer ReducerFunc, 
  2.     opts ...Option) (interface{}, error) { 
  3.     options := buildOptions(opts...) 
  4.     //任务执行结束通知信号 
  5.     output := make(chan interface{}) 
  6.     //将mapper处理完的数据写入collector 
  7.     collector := make(chan interface{}, options.workers) 
  8.     // 取消操作信号 
  9.     done := syncx.NewDoneChan() 
  10.     writer := newGuardedWriter(output, done.Done()) 
  11.     var closeOnce sync.Once 
  12.     var retErr errorx.AtomicError 
  13.     finish := func() { 
  14.         closeOnce.Do(func() { 
  15.             done.Close() 
  16.             close(output
  17.         }) 
  18.     } 
  19.     cancel := once(func(err error) { 
  20.         if err != nil { 
  21.             retErr.Set(err) 
  22.         } else { 
  23.             retErr.Set(ErrCancelWithNil) 
  24.         } 
  25.  
  26.         drain(source) 
  27.         finish() 
  28.     }) 
  29.  
  30.     go func() { 
  31.         defer func() { 
  32.             if r := recover(); r != nil { 
  33.                 cancel(fmt.Errorf("%v", r)) 
  34.             } else { 
  35.                 finish() 
  36.             } 
  37.         }() 
  38.         reducer(collector, writer, cancel) 
  39.         drain(collector) 
  40.     }() 
  41.     // 真正从生成器通道取数据执行Mapper 
  42.     go executeMappers(func(item interface{}, w Writer) { 
  43.         mapper(item, w, cancel) 
  44.     }, source, collector, done.Done(), options.workers) 
  45.  
  46.     value, ok := <-output 
  47.     if err := retErr.Load(); err != nil { 
  48.         return nil, err 
  49.     } else if ok { 
  50.         return value, nil 
  51.     } else { 
  52.         return nil, ErrReduceNoOutput 
  53.     } 

这段代码挺长的,我们说下核心的点。这里使用一个G 调用 executeMappers 方法。

  1. go executeMappers(func(item interface{}, w Writer) { 
  2.         mapper(item, w, cancel) 
  3.     }, source, collector, done.Done(), options.workers) 
  1. func executeMappers(mapper MapFunc, input <-chan interface{}, collector chan<- interface{}, 
  2.     done <-chan lang.PlaceholderType, workers int) { 
  3.     var wg sync.WaitGroup 
  4.     defer func() { 
  5.         // 等待所有任务全部执行完毕 
  6.         wg.Wait() 
  7.         // 关闭通道 
  8.         close(collector) 
  9.     }() 
  10.    //根据指定数量创建 worker池 
  11.     pool := make(chan lang.PlaceholderType, workers)  
  12.     writer := newGuardedWriter(collector, done) 
  13.     for { 
  14.         select { 
  15.         case <-done: 
  16.             return 
  17.         case pool <- lang.Placeholder: 
  18.             // 从buildSource() 返回的无缓冲通道取数据 
  19.             item, ok := <-input  
  20.             // 当通道关闭,结束 
  21.             if !ok { 
  22.                 <-pool 
  23.                 return 
  24.             } 
  25.  
  26.             wg.Add(1) 
  27.             // better to safely run caller defined method 
  28.             threading.GoSafe(func() { 
  29.                 defer func() { 
  30.                     wg.Done() 
  31.                     <-pool 
  32.                 }() 
  33.                 //真正运行闭包函数的地方 
  34.                // func(item interface{}, w Writer) { 
  35.                // mapper(item, w, cancel) 
  36.                // } 
  37.                 mapper(item, writer) 
  38.             }) 
  39.         } 
  40.     } 

具体的逻辑已备注,代码很容易懂。

一旦 executeMappers 函数返回,关闭 collector 通道,那么执行 reducer 不再阻塞。

  1. go func() { 
  2.         defer func() { 
  3.             if r := recover(); r != nil { 
  4.                 cancel(fmt.Errorf("%v", r)) 
  5.             } else { 
  6.                 finish() 
  7.             } 
  8.         }() 
  9.         reducer(collector, writer, cancel) 
  10.         //这里 
  11.         drain(collector) 
  12.     }() 

这里的 reducer(collector, writer, cancel) 其实就是从 MapReduceVoid 传递的第三个闭包函数。

  1. func MapReduceVoid(generator GenerateFunc, mapper MapperFunc, reducer VoidReducerFunc, opts ...Option) error { 
  2.     _, err := MapReduce(generator, mapper, func(input <-chan interface{}, writer Writer, cancel func(error)) { 
  3.         reducer(input, cancel) 
  4.         //这里 
  5.         drain(input) 
  6.         // We need to write a placeholder to let MapReduce to continue on reducer done, 
  7.         // otherwise, all goroutines are waiting. The placeholder will be discarded by MapReduce. 
  8.         writer.Write(lang.Placeholder) 
  9.     }, opts...) 
  10.     return err 

然后这个闭包函数又执行了 reducer(input, cancel),这里的 reducer 就是我们一开始解释过的 VoidReducerFunc,从 Finish() 而来。

等等,看到上面三个地方的 drain(input)了吗?

  1. // drain drains the channel. 
  2. func drain(channel <-chan interface{}) { 
  3.     // drain the channel 
  4.     for range channel { 
  5.     } 

其实就是一个排空 channel 的操作,但是三个地方都对同一个 channel做同样的操作,也是让我费解。

还有更重要的一点。

  1. go func() { 
  2.         defer func() { 
  3.             if r := recover(); r != nil { 
  4.                 cancel(fmt.Errorf("%v", r)) 
  5.             } else { 
  6.                 finish() 
  7.             } 
  8.         }() 
  9.         reducer(collector, writer, cancel) 
  10.         drain(collector) 
  11.     }() 

上面的代码,假如执行 reducer,writer 写入引发 panic,那么drain(collector) 将没有机会执行。

不过作者已经修复了这个问题,直接把 drain(collector) 放入到 defer。

具体 issues[1]。

到这里,关于 Finish 的源码也就结束了。感兴趣的可以看看其他源码。

很喜欢 go-zero 里的一些工具,但是工具往往并不独立,依赖于其他文件包,导致明明只想使用其中一个工具却需要安装整个包。

所以最终的结果就是扒源码,创建无依赖库工具集,遵循 MIT 即可。

附录[1]https://github.com/tal-tech/go-zero/issues/676

 

责任编辑:武晓燕 来源: 吴亲强的深夜食堂
相关推荐

2020-12-08 08:08:51

Java接口数据

2024-05-16 17:58:30

线程任务线程通讯线程池

2021-03-24 10:20:50

Fonts前端代码

2024-09-09 15:09:30

2023-06-06 08:51:06

2020-07-07 07:33:12

Java单元集成

2020-03-26 11:04:00

Linux命令光标

2021-01-18 13:17:04

鸿蒙HarmonyOSAPP

2022-05-13 21:20:23

组件库样式选择器

2021-01-28 14:53:19

PHP编码开发

2022-05-24 06:07:48

JShack用户代码

2024-04-24 12:34:08

Spring事务编程

2021-07-07 07:47:10

浏览器CSS兼容

2020-03-27 15:10:23

SpringJava框架

2021-09-08 08:34:37

Go 文档Goland

2020-10-22 10:15:33

优化Windows电脑

2018-08-20 10:40:09

Redis位图操作

2023-02-13 14:37:13

开发web浏览器

2024-01-30 12:08:31

Go框架停止服务

2024-01-05 16:43:30

数据库线程
点赞
收藏

51CTO技术栈公众号