SizedWaitGroup 项目使用教程

SizedWaitGroup 项目使用教程

sizedwaitgroupSizedWaitGroup has the same role and close to the same API as the Golang sync.WaitGroup but it adds a limit on the amount of goroutines started concurrently.项目地址:https://gitcode.com/gh_mirrors/si/sizedwaitgroup

1. 项目的目录结构及介绍

SizedWaitGroup 项目的目录结构相对简单，主要包含以下文件和目录：

sizedwaitgroup/
├── LICENSE
├── README.md
├── sizedwaitgroup.go
└── sizedwaitgroup_test.go

• LICENSE: 项目的许可证文件，采用 MIT 许可证。
• README.md: 项目的说明文档，包含项目的基本介绍、使用方法和示例代码。
• sizedwaitgroup.go: 项目的主要源代码文件，定义了 SizedWaitGroup 结构体及其方法。
• sizedwaitgroup_test.go: 项目的测试文件，包含对 SizedWaitGroup 功能进行测试的代码。

2. 项目的启动文件介绍

SizedWaitGroup 项目没有传统意义上的“启动文件”，因为它是一个库项目，旨在被其他 Go 项目导入和使用。主要的逻辑代码位于 sizedwaitgroup.go 文件中。

sizedwaitgroup.go 文件中定义了 SizedWaitGroup 结构体及其方法，包括：

• New(limit int) SizedWaitGroup: 创建一个新的 SizedWaitGroup 实例，并设置并发限制。
• Add(): 增加一个等待的 goroutine。
• AddWithContext(ctx context.Context) error: 增加一个带有上下文的等待的 goroutine。
• Done(): 完成一个等待的 goroutine。
• Wait(): 等待所有 goroutine 完成。

3. 项目的配置文件介绍

SizedWaitGroup 项目没有专门的配置文件。其主要配置是通过在创建 SizedWaitGroup 实例时传入的参数来完成的。例如：

swg := sizedwaitgroup.New(8)

这里的 8 就是并发限制的配置参数，表示最多同时启动 8 个 goroutine。

示例代码

以下是一个简单的示例代码，展示了如何使用 SizedWaitGroup：

package main

import (
    "fmt"
    "math/rand"
    "time"
    "github.com/remeh/sizedwaitgroup"
)

func main() {
    rand.Seed(time.Now().UnixNano())

    // 设置并发限制为 8
    swg := sizedwaitgroup.New(8)

    for i := 0; i < 50; i++ {
        swg.Add()
        go func(i int) {
            defer swg.Done()
            query(i)
        }(i)
    }

    swg.Wait()
}

func query(i int) {
    fmt.Println(i)
    ms := i + 500 + rand.Intn(500)
    time.Sleep(time.Duration(ms) * time.Millisecond)
}

在这个示例中，我们创建了一个 SizedWaitGroup 实例，并设置了最多同时启动 8 个 goroutine。然后我们启动了 50 个 goroutine，每个 goroutine 执行 query 函数。最后，我们调用 swg.Wait() 等待所有 goroutine 完成。

sizedwaitgroupSizedWaitGroup has the same role and close to the same API as the Golang sync.WaitGroup but it adds a limit on the amount of goroutines started concurrently.项目地址:https://gitcode.com/gh_mirrors/si/sizedwaitgroup