首页 > 后端开发 > Golang > 正文

Go并发编程:利用WaitGroup实现Goroutine的优雅同步

心靈之曲
发布: 2025-10-31 13:37:33
原创
975人浏览过

Go并发编程:利用WaitGroup实现Goroutine的优雅同步

go语言并发编程中,主goroutine常常会在子goroutine完成前退出,导致程序无法按预期执行。本文将深入探讨这一常见问题,并详细介绍如何使用`sync.waitgroup`这一标准库提供的同步原语,来确保所有并发任务都能被正确等待和协调,从而构建健壮的并发应用。

理解Goroutine并发执行中的同步挑战

在Go语言中,通过go关键字启动的Goroutine是轻量级的并发执行单元。然而,当主Goroutine启动了多个子Goroutine后,它并不会自动等待这些子Goroutine完成。如果主Goroutine在子Goroutine执行完毕之前就退出了,那么所有尚未完成的子Goroutine也会被强制终止,这通常会导致程序行为不符合预期,例如数据未处理、日志未打印等。

考虑以下示例代码片段,它尝试使用Goroutine实现生产者-消费者模式来处理文件列表:

package main

import (
    "fmt"
    "os"
    "time" // 用于演示问题
)

type uniprot struct {
    namesInDir chan string
}

func (u *uniprot) produce(n string) {
    u.namesInDir <- n
}

func (u *uniprot) consume() {
    fmt.Println(<-u.namesInDir)
}

func (u *uniprot) readFilenames(dirname string) {
    u.namesInDir = make(chan string, 15) // 创建一个带缓冲的通道
    dir, err := os.Open(dirname)
    if err != nil {
        // errorCheck(err) // 假设这里有错误处理
        fmt.Printf("Error opening directory: %v\n", err)
        return
    }
    defer dir.Close()

    names, err := dir.Readdirnames(0)
    if err != nil {
        // errorCheck(err) // 假设这里有错误处理
        fmt.Printf("Error reading directory names: %v\n", err)
        return
    }

    for _, n := range names {
        go u.produce(n) // 启动生产者Goroutine
        go u.consume()  // 启动消费者Goroutine
    }
    // 在这里,主Goroutine可能会立即退出,而不等待produce和consume完成
    // time.Sleep(time.Second) // 演示:短暂等待可以观察到输出
}

func main() {
    u := &uniprot{}
    // 创建一个临时目录和文件用于测试
    testDir := "test_dir"
    os.Mkdir(testDir, 0755)
    defer os.RemoveAll(testDir) // 清理
    for i := 0; i < 5; i++ {
        os.WriteFile(fmt.Sprintf("%s/file%d.txt", testDir, i), []byte("content"), 0644)
    }

    u.readFilenames(testDir)
    fmt.Println("Main Goroutine finished.") // 这句话可能在任何输出之前打印
    time.Sleep(time.Millisecond * 100) // 给予一点时间观察,但不是可靠的同步方式
}
登录后复制

上述代码中,readFilenames函数在循环中为每个文件名启动了一个produce Goroutine和一个consume Goroutine。然而,由于主Goroutine没有等待这些子Goroutine完成,程序很可能在任何文件名被打印出来之前就结束了,导致控制台没有任何输出。通过在readFilenames函数末尾添加一个time.Sleep可以暂时“解决”这个问题,但这并非一个可靠或推荐的同步机制,因为你无法预知需要等待多长时间。

使用sync.WaitGroup实现可靠的Goroutine同步

Go标准库提供了sync.WaitGroup类型,它是解决此类并发同步问题的理想工具。WaitGroup允许你等待一组Goroutine完成。它的工作原理非常简单:

立即进入豆包AI人工智官网入口”;

立即学习豆包AI人工智能在线问答入口”;

  • Add(delta int):将计数器增加delta。通常在启动Goroutine之前调用,以告知WaitGroup有多少个任务需要等待。
  • Done():将计数器减1。通常在Goroutine完成其工作后调用,通常通过defer wg.Done()确保即使Goroutine发生panic也能正确计数。
  • Wait():阻塞当前Goroutine,直到计数器归零。

下面是使用sync.WaitGroup改进后的代码示例:

豆包AI编程
豆包AI编程

豆包推出的AI编程助手

豆包AI编程483
查看详情 豆包AI编程
package main

import (
    "fmt"
    "os"
    "sync" // 导入sync包
)

type uniprot struct {
    namesInDir chan string
}

// produce函数现在接受一个WaitGroup指针
func (u *uniprot) produce(n string, wg *sync.WaitGroup) {
    defer wg.Done() // Goroutine完成后调用Done()
    u.namesInDir <- n
    fmt.Printf("Produced: %s\n", n) // 增加日志以观察
}

// consume函数现在接受一个WaitGroup指针
func (u *uniprot) consume(wg *sync.WaitGroup) {
    defer wg.Done() // Goroutine完成后调用Done()
    val := <-u.namesInDir
    fmt.Printf("Consumed: %s\n", val)
}

func (u *uniprot) readFilenames(dirname string) {
    u.namesInDir = make(chan string, 15) // 创建一个带缓冲的通道
    dir, err := os.Open(dirname)
    if err != nil {
        // errorCheck(err)
        fmt.Printf("Error opening directory: %v\n", err)
        return
    }
    defer dir.Close()

    names, err := dir.Readdirnames(0)
    if err != nil {
        // errorCheck(err)
        fmt.Printf("Error reading directory names: %v\n", err)
        return
    }

    var wg sync.WaitGroup // 声明一个WaitGroup
    for _, n := range names {
        wg.Add(2) // 每次循环启动两个Goroutine,所以计数器加2
        go u.produce(n, &wg) // 将WaitGroup的地址传递给Goroutine
        go u.consume(&wg)   // 将WaitGroup的地址传递给Goroutine
    }

    wg.Wait() // 阻塞直到所有Goroutine都调用了Done()
    close(u.namesInDir) // 所有生产者和消费者都完成后,关闭通道
}

func main() {
    u := &uniprot{}
    // 创建一个临时目录和文件用于测试
    testDir := "test_dir"
    os.Mkdir(testDir, 0755)
    defer os.RemoveAll(testDir) // 清理
    for i := 0; i < 5; i++ {
        os.WriteFile(fmt.Sprintf("%s/file%d.txt", testDir, i), []byte("content"), 0644)
    }

    u.readFilenames(testDir)
    fmt.Println("Main Goroutine finished, all tasks completed.")
}
登录后复制

在修正后的代码中,我们做了以下关键改动:

  1. 声明sync.WaitGroup: 在readFilenames函数内部声明了一个sync.WaitGroup实例 wg。
  2. 增加计数器: 在for循环内部,每次启动一对生产者和消费者Goroutine之前,调用wg.Add(2)。这会告诉WaitGroup,我们期望有两个Goroutine需要完成。
  3. 传递WaitGroup指针: produce和consume方法现在都接受一个*sync.WaitGroup参数。这是因为WaitGroup是一个结构体,需要通过指针传递才能在不同的Goroutine之间共享状态并正确修改其内部计数器。
  4. 调用Done(): 在produce和consume函数的开头,使用defer wg.Done()。这确保了无论Goroutine是正常完成还是发生panic,WaitGroup的计数器都会被正确递减。
  5. 等待所有Goroutine: 在for循环结束后,调用wg.Wait()。这会阻塞readFilenames函数(以及调用它的主Goroutine),直到WaitGroup的内部计数器归零,即所有预期的Goroutine都调用了Done()。

通过这些改动,程序现在能够可靠地等待所有文件处理Goroutine完成,然后才打印“Main Goroutine finished, all tasks completed.”,并在此之前打印所有生产和消费的消息。

注意事项与最佳实践

  • Add()的调用时机: 务必在启动Goroutine之前调用wg.Add()。如果在Goroutine启动之后才调用Add(),可能会出现竞态条件,导致Wait()在Add()之前被调用,从而无法正确等待。
  • WaitGroup的传递方式: sync.WaitGroup实例应该通过指针传递给Goroutine,以确保所有Goroutine操作的是同一个WaitGroup对象。
  • defer wg.Done(): 这是一个非常重要的模式。它保证了即使Goroutine内部发生错误或panic,Done()也会被调用,从而避免死锁(Wait()永远无法返回)。
  • 通道的关闭: 在所有生产者都完成任务后,关闭通道是一个好习惯。这会通知所有消费者没有更多数据会写入通道,它们可以安全地退出。在上述例子中,由于消费者数量与生产者数量相同且一一对应,我们可以选择在wg.Wait()之后关闭通道。
  • 错误处理: 示例中的errorCheck(err)是一个占位符。在实际应用中,应实现健壮的错误处理机制,例如返回错误、记录日志或使用panic(如果错误是不可恢复的)。

总结

sync.WaitGroup是Go语言中用于协调并发Goroutine的强大工具。它提供了一种简单而有效的方式,确保主Goroutine能够等待所有子Goroutine完成其工作,从而避免因主Goroutine过早退出而导致的不可预测行为。掌握WaitGroup的使用是编写健壮、高效Go并发程序的关键一步。通过正确地使用Add()、Done()和Wait(),开发者可以构建出更加可靠和可维护的并发系统。

以上就是Go并发编程:利用WaitGroup实现Goroutine的优雅同步的详细内容,更多请关注php中文网其它相关文章!

编程速学教程(入门课程)
编程速学教程(入门课程)

编程怎么学习?编程怎么入门?编程在哪学?编程怎么学才快?不用担心,这里为大家提供了编程速学教程(入门课程),有需要的小伙伴保存下载就能学习啦!

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习
PHP中文网抖音号
发现有趣的

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号