fx 是一个完备的流式处理组件。 和 MapReduce 类似的,fx 也存在并发处理的函数:Parallel(fn, options)。但同时它也不只有并发处理。From(chan) ,Map(fn),Filter(fn),Reduce(fn) 等,从数据源读取成流,到处理流数据,最后聚合流数据。是不是有点像 Java Lambda ,如果你之前是 Java 开发者,看到这也就明白整个基本设计。

整体API

还是从整体上概览 fx 到底是怎么构建的: image.png
被标注的部分就是整个 fx 最重要的部分:

  1. 由 From(fn) 这类API,产生数据流 Stream
  2. 对Stream 转换,聚合,求值的API集合

所以列举出目前支持的 Stream API:

API 作用
Distinct(fn) fn中选定特定item类型,对其去重
Filter(fn, option) fn指定具体规则,满足规则的element传递给下一个 stream
Group(fn) 根据fn把stream中的element分到不同的组中
Head(num) 取出stream中前 num 个element ,生成一个新的stream
Map(fn, option) 将每个ele转换为另一个对应的ele, 传递给下一个 stream
Merge() 将所有ele合并到一个slice中并生成一个新stream
Reverse() 反转stream中的element。【使用双指针】
Sort(fn) 按照 fn 排序stream中的element
Tail(num) 取出stream最后的 num 个element,生成一个新 stream。【使用双向环状链表】
Walk(fn, option) 把 fn 作用在 source 的每个元素。生成新的 stream

不再生成新的 stream,做最后的求值操作:

API 作用
ForAll(fn) 按照fn处理stream,且不再产生stream【求值操作】
ForEach(fn) 对 stream 中所有 element 执行fn【求值操作】
Parallel(fn, option) 将给定的fn与给定的worker数量并发应用于每个element【求值操作】
Reduce(fn) 直接处理stream【求值操作】
Done() 啥也不做,等待所有的操作完成

如何使用

  1. result := make(map[string]string)
  2. fx.From(func(source chan<- interface{}) {
  3. for _, item := range data {
  4. source <- item
  5. }
  6. }).Walk(func(item interface{}, pipe chan<- interface{}) {
  7. each := item.(*model.ClassData)
  8. class, err := l.rpcLogic.GetClassInfo()
  9. if err != nil {
  10. l.Errorf("get class %s failed: %s", each.ClassId, err.Error())
  11. return
  12. }
  13. students, err := l.rpcLogic.GetUsersInfo(class.ClassId)
  14. if err != nil {
  15. l.Errorf("get students %s failed: %s", each.ClassId, err.Error())
  16. return
  17. }
  18. pipe <- &classObj{
  19. classId: each.ClassId
  20. studentIds: students
  21. }
  22. }).ForEach(func(item interface{}) {
  23. o := item.(*classObj)
  24. result[o.classId] = o.studentIds
  25. })
  1. From() 从一个 slice 生成 stream
  2. Walk() 接收与一个 stream ,对流中每个 ele 转换重组,生成新的 stream
  3. 最后由 求值操作 把 stream 输出(fmt.Println),存储(map,slice),持久化(db操作)

简要分析

fx 中的函数命名语义化,开发者只需要知道业务逻辑需要什么样的转换,调用与之匹配的函数即可。
所以这里只简要分析几个比较典型的函数。

Walk()

Walk() 在整个 fx 被多个函数当成底层实现,Map(), Filter() 等。

所以本质就是:Walk() 负责并发将传进来的函数作用在 输入流 的每个 ele,并 生成新的 stream。

跟到源码,分成两个子函数:自定义 worker 数,默认 worker 数

  1. // 自定义 workder 数
  2. func (p Stream) walkLimited(fn WalkFunc, option *rxOptions) Stream {
  3. pipe := make(chan interface{}, option.workers)
  4. go func() {
  5. var wg sync.WaitGroup
  6. // channel<- 如果达到设定workers数,channel阻塞,从而达到控制并发数。
  7. // 简易的 goroutine pool
  8. pool := make(chan lang.PlaceholderType, option.workers)
  9. for {
  10. // 每一次for循环都会开启一个goroutine。如果达到workers数,从而阻塞
  11. pool <- lang.Placeholder
  12. item, ok := <-p.source
  13. if !ok {
  14. <-pool
  15. break
  16. }
  17. // 使用 waitgroup 保证任务完成的完整性
  18. wg.Add(1)
  19. threading.GoSafe(func() {
  20. defer func() {
  21. wg.Done()
  22. // 归还
  23. <-pool
  24. }()
  25. fn(item, pipe)
  26. })
  27. }
  28. wg.Wait()
  29. close(pipe)
  30. }()
  31. return Range(pipe)
  32. }
  • 使用 有缓冲channel 做并发队列,限制并发数
  • waitgroup 保证任务完成的完整性

另外一个 walkUnlimited():也使用了 waitgroup 做并发控制,因为没有自定义并发数限制,所以也就没有另外一个 channel 做并发数控制。

Tail()

介绍这个主要是里面运用了 ring 这个双向链表,其中的简单算法还是很有意思的。

  1. func (p Stream) Tail(n int64) Stream {
  2. source := make(chan interface{})
  3. go func() {
  4. ring := collection.NewRing(int(n))
  5. // “顺序”插入,源的顺序和ring的顺序一致
  6. for item := range p.source {
  7. ring.Add(item)
  8. }
  9. // 取出 ring 中全部的 item
  10. for _, item := range ring.Take() {
  11. source <- item
  12. }
  13. close(source)
  14. }()
  15. return Range(source)
  16. }

至于为什么 Tail() 可以做到把源的后n个取出来,这个就留给大家去细品了。这里给出我的理解: image.png

Tip 假设有以下这个场景,Tail(5)

  • stream size :7
  • ring size:5

这里可以使用把环状链表拉开的方式,环转线,此时以全部长度划分对称轴,翻转多余的元素,之后的元素就是 Tail(5) 需要的部分了。

Tip 这里采用图的方式更清晰的表现,不过代码大家也要看看。算法要考的 fx - 图3

Stream Transform Design

分析整个 fx ,会发现整体设计遵循一个设计模版:

  1. func (p Stream) Transform(fn func(item interface{}) interface{}) Stream {
  2. // make channel
  3. source := make(chan interface{})
  4. // goroutine worker
  5. go func() {
  6. // tranform
  7. for item := range p.source {
  8. ...
  9. source <- item
  10. ...
  11. }
  12. ...
  13. // 关闭输入,但是依然可以从这个 stream 输出。防止内存泄漏
  14. close(source)
  15. }()
  16. // channel -> stream
  17. return Range(source)
  18. }
  • channel 作为流的容器
  • 开 goroutine 对 source 做转换,聚合,输送到 channel
  • 处理完毕,close(outputStream)
  • channel -> stream

    总结

    到这就把 fx 基本介绍完了,如果你对其他API源码感兴趣,可以跟着上面的 API 列表挨个读一读。

同时也建议大家把 java streamAPI大致看看,对这种 stream call 理解可以更加深 。

同时在 go-zero 中还有很多实用的组件工具,用好工具对于提升服务性能和开发效率都有很大的帮助,希望本篇文章能给大家带来一些收获。

参考资料

示例

  1. package main
  2. import (
  3. "fmt"
  4. "github.com/tal-tech/go-zero/core/fx"
  5. )
  6. func main() {
  7. result, err := fx.From(func(source chan<- interface{}) {
  8. for i := 0; i < 10; i++ {
  9. source <- i
  10. }
  11. }).Map(func(item interface{}) interface{} {
  12. i := item.(int)
  13. return i * i
  14. }).Filter(func(item interface{}) bool {
  15. i := item.(int)
  16. return i%2 == 0
  17. }).Distinct(func(item interface{}) interface{} {
  18. return item
  19. }).Reduce(func(pipe <-chan interface{}) (interface{}, error) {
  20. var result int
  21. for item := range pipe {
  22. i := item.(int)
  23. result += i
  24. }
  25. return result, nil
  26. })
  27. if err != nil {
  28. fmt.Println(err)
  29. } else {
  30. fmt.Println(result)
  31. }
  32. }
  1. PS D:\Projects\Github\NoobWu\zero-examples\fx> go run .\square.go
  2. 120

原文链接

https://go-zero.dev/cn/fx.html