conch

`conc`：Go 语言更好的结构化并发

conc 是您在 Go 中进行结构化并发的工具箱，使常见任务更容易、更安全。

go get github.com/sourcegraph/conc

概览

使用 conc.WaitGroup 如果您只想要 sync.WaitGroup 的更安全版本
使用 pool.Pool 如果您想要一个并发限制的任务运行器
使用 pool.ResultPool 如果您想要一个收集任务结果的并发任务运行器
使用 pool.(Result)?ErrorPool 如果您的任务可能失败
使用 pool.(Result)?ContextPool 如果您的任务应在失败时取消
使用 stream.Stream 如果您想并行处理有序任务流，并进行串行回调
使用 iter.Map 如果您想并发地映射切片
使用 iter.ForEach 如果您想并发地遍历切片
使用 panics.Catcher 如果您想在自己的 goroutine 中捕获 panic

所有池都通过 pool.New() 或 pool.NewWithResults[T]() 创建，然后使用以下方法进行配置：

p.WithMaxGoroutines() 配置池中的最大 goroutine 数
p.WithErrors() 配置池以运行返回错误的任务
p.WithContext(ctx) 配置池以运行在第一个错误时应取消的任务
p.WithFirstError() 配置错误池仅保留第一个返回的错误，而不是聚合错误
p.WithCollectErrored() 配置结果池以在任务出错时仍收集结果

目标

该包的主要目标是：

使泄漏 goroutine 变得更困难
优雅地处理 panic
使并发代码更易读

目标 #1：使泄漏 goroutine 变得更困难

使用 goroutine 时的一个常见痛点是清理它们。很容易发出一个 go 语句而未能正确等待它完成。

conc 采取了一个有争议的立场，即所有并发都应该是有范围的。也就是说，goroutine 应该有一个所有者，该所有者应该始终确保其拥有的 goroutine 正确退出。

在 conc 中，goroutine 的所有者始终是 conc.WaitGroup。Goroutine 通过 (*WaitGroup).Go() 在 WaitGroup 中生成，并且在 WaitGroup 超出范围之前应始终调用 (*WaitGroup).Wait()。

在某些情况下，您可能希望生成的 goroutine 比调用者的范围存活更长。在这种情况下，您可以将 WaitGroup 传递给生成函数。

func main() {
    var wg conc.WaitGroup
    defer wg.Wait()

    startTheThing(&wg)
}

func startTheThing(wg *conc.WaitGroup) {
    wg.Go(func() { ... })
}

有关为什么范围并发很好的更多讨论，请查看这篇博客文章。

目标 #2：优雅地处理 panic

在长时间运行的应用程序中，处理 goroutine 的 panic 是一个常见问题。没有 panic 处理程序的 goroutine 在发生 panic 时会崩溃整个进程。这通常是不希望的。

然而，如果您确实为 goroutine 添加了 panic 处理程序，一旦捕获到 panic，您该怎么处理？一些选项：

忽略它
记录它
将其转换为错误并返回给 goroutine 生成器
将 panic 传播给 goroutine 生成器

忽略 panic 是个坏主意，因为 panic 通常意味着确实出了问题，应该有人修复它。

仅仅记录 panic 也不太好，因为这样生成器就没有任何迹象表明发生了不好的事情，它可能会继续正常运行，即使您的程序处于非常糟糕的状态。

(3) 和 (4) 都是合理的选项，但两者都要求 goroutine 有一个实际可以接收出错信息的所有者。这通常不适用于用 go 生成的 goroutine，但在 conc 包中，所有 goroutine 都有一个必须收集生成的 goroutine 的所有者。在 conc 包中，如果任何生成的 goroutine 发生了 panic，任何对 Wait() 的调用都会 panic。此外，它用子 goroutine 的堆栈跟踪装饰 panic 值，这样您就不会丢失有关导致 panic 的信息。

每次用 go 生成东西时都正确地做到这一点并不容易，而且它需要大量的样板代码，使代码中重要的部分更难阅读，所以 conc 为您做了这些。

<table> <tr> <th><code>stdlib</code></th> <th><code>conc</code></th> </tr> <tr> <td>

type caughtPanicError struct {
    val   any
    stack []byte
}
func (e *caughtPanicError) Error() string {
    return fmt.Sprintf(
        "panic: %q\n%s",
        e.val,
        string(e.stack)
    )
}

func main() {
    done := make(chan error)
    go func() {
        defer func() {
            if v := recover(); v != nil {
                done <- &caughtPanicError{
                    val: v,
                    stack: debug.Stack()
                }
            } else {
                done <- nil
            }
        }()
        doSomethingThatMightPanic()
    }()
    err := <-done
    if err != nil {
        panic(err)
    }
}

</td> <td>

func main() {
    var wg conc.WaitGroup
    wg.Go(doSomethingThatMightPanic)
    // 以良好的堆栈跟踪方式panic
    wg.Wait()
}

</td> </tr> </table>

目标 #3：使并发代码更易于阅读

正确实现并发是困难的。以不会模糊代码实际功能的方式实现并发更加困难。conc包试图通过抽象尽可能多的样板复杂性来使常见操作更容易。

想要使用有限数量的goroutine运行一组并发任务吗？使用pool.New()。想要并发处理有序结果流，但仍保持顺序吗？试试stream.New()。想要对切片进行并发映射吗？看看iter.Map()。

浏览下面的一些示例，比较手动实现的方式。

示例

为简单起见，这些示例都省略了传播panic的处理。要了解这会增加什么样的复杂性，请查看上面的"目标 #2"标题。

生成一组goroutine并等待它们完成：

<table> <tr> <th><code>stdlib</code></th> <th><code>conc</code></th> </tr> <tr> <td>

func main() {
    var wg sync.WaitGroup
    for i := 0; i < 10; i++ {
        wg.Add(1)
        go func() {
            defer wg.Done()
            // panic时会崩溃！
            doSomething()
        }()
    }
    wg.Wait()
}

</td> <td>

func main() {
    var wg conc.WaitGroup
    for i := 0; i < 10; i++ {
        wg.Go(doSomething)
    }
    wg.Wait()
}

</td> </tr> </table>

在静态goroutine池中处理流的每个元素：

<table> <tr> <th><code>stdlib</code></th> <th><code>conc</code></th> </tr> <tr> <td>

func process(stream chan int) {
    var wg sync.WaitGroup
    for i := 0; i < 10; i++ {
        wg.Add(1)
        go func() {
            defer wg.Done()
            for elem := range stream {
                handle(elem)
            }
        }()
    }
    wg.Wait()
}

</td> <td>

func process(stream chan int) {
    p := pool.New().WithMaxGoroutines(10)
    for elem := range stream {
        elem := elem
        p.Go(func() {
            handle(elem)
        })
    }
    p.Wait()
}

</td> </tr> </table>

在静态goroutine池中处理切片的每个元素：

<table> <tr> <th><code>stdlib</code></th> <th><code>conc</code></th> </tr> <tr> <td>

func process(values []int) {
    feeder := make(chan int, 8)

    var wg sync.WaitGroup
    for i := 0; i < 10; i++ {
        wg.Add(1)
        go func() {
            defer wg.Done()
            for elem := range feeder {
                handle(elem)
            }
        }()
    }

    for _, value := range values {
        feeder <- value
    }
    close(feeder)
    wg.Wait()
}

</td> <td>

func process(values []int) {
    iter.ForEach(values, handle)
}

</td> </tr> </table>

并发映射切片：

<table> <tr> <th><code>stdlib</code></th> <th><code>conc</code></th> </tr> <tr> <td>

func concMap(
    input []int,
    f func(int) int,
) []int {
    res := make([]int, len(input))
    var idx atomic.Int64

    var wg sync.WaitGroup
    for i := 0; i < 10; i++ {
        wg.Add(1)
        go func() {
            defer wg.Done()

            for {
                i := int(idx.Add(1) - 1)
                if i >= len(input) {
                    return
                }

                res[i] = f(input[i])
            }
        }()
    }
    wg.Wait()
    return res
}

</td> <td>

func concMap(
    input []int,
    f func(*int) int,
) []int {
    return iter.Map(input, f)
}

</td> </tr> </table>

并发处理有序流：

<table> <tr> <th><code>stdlib</code></th> <th><code>conc</code></th> </tr> <tr> <td>

func mapStream(
    in chan int,
    out chan int,
    f func(int) int,
) {
    tasks := make(chan func())
    taskResults := make(chan chan int)

    // 工作goroutine
    var workerWg sync.WaitGroup
    for i := 0; i < 10; i++ {
        workerWg.Add(1)
        go func() {
            defer workerWg.Done()
            for task := range tasks {
                task()
            }
        }()
    }

    // 有序读取goroutine
    var readerWg sync.WaitGroup
    readerWg.Add(1)
    go func() {
        defer readerWg.Done()
        for result := range taskResults {
            item := <-result
            out <- item
        }
    }()

    // 向工作者提供任务
    for elem := range in {
        resultCh := make(chan int, 1)
        taskResults <- resultCh
        tasks <- func() {
            resultCh <- f(elem)
        }
    }

    // 输入已耗尽。
    // 等待所有内容完成
    close(tasks)
    workerWg.Wait()
    close(taskResults)
    readerWg.Wait()
}

</td> <td>

func mapStream(
    in chan int,
    out chan int,
    f func(int) int,
) {
    s := stream.New().WithMaxGoroutines(10)
    for elem := range in {
        elem := elem
        s.Go(func() stream.Callback {
            res := f(elem)
            return func() { out <- res }
        })
    }
    s.Wait()
}