Swoole协程WaitGroup：等待协程完成 - 智猿学院-IT界的百科全书

Swoole协程WaitGroup：一场优雅的协程交响乐的指挥家

各位观众老爷们，大家好！我是你们的老朋友，一位在代码海洋里摸爬滚打多年的老水手。今天，咱们不聊风花雪月，不谈人生哲学，就来聊聊Swoole协程中一个非常实用，却又常常被忽略的宝贝——WaitGroup。

想象一下，你正在指挥一场盛大的交响乐演出。各种乐器，各种声部，就像一个个协程，各自演奏着自己的旋律。但是，作为一个优秀的指挥家，你不能让所有的乐器各自为政，乱成一锅粥。你需要确保每个声部，每个乐器都演奏完毕，才能最终呈现出完美的乐章。

而Swoole的WaitGroup，就像这位优雅的指挥家，它负责协调和等待所有协程完成，确保整个程序的完整性和协调性。

1. 协程的并发狂想曲：为何我们需要WaitGroup？

在Swoole的世界里，协程就像一个个轻盈的精灵，它们自由地穿梭于代码之间，并发执行，极大地提升了程序的性能。但是，这种自由也带来了一个问题：如何知道所有的精灵都完成了自己的任务？

设想一个场景：你需要同时下载10个文件，每个文件下载都是一个协程。如果主协程不等所有下载协程完成就直接退出，那么很可能你只下载了几个文件，甚至一个都没下载成功，就匆匆结束了。这就像你精心准备了一桌丰盛的晚餐，结果客人还没来，你就把菜都倒掉了，岂不可惜？

这时候，WaitGroup就闪亮登场了。它可以帮助主协程等待所有子协程完成，确保程序的逻辑完整性。它就像一个可靠的管家，时刻关注着所有协程的进度，直到它们全部完成任务，才会通知主协程继续执行。

2. WaitGroup的神秘面纱：它的工作原理是啥？

WaitGroup的工作原理其实非常简单，但却非常有效。它主要包含三个核心方法：

add(int $delta = 1): 这个方法就像一个登记员，每当创建一个新的协程需要等待时，就调用这个方法，增加WaitGroup内部的计数器。$delta参数表示增加的计数，默认为1。你可以一次性增加多个计数，比如你要同时等待5个协程，就可以直接调用$wg->add(5);。
done(): 这个方法就像一个销户员，当一个协程完成任务时，就调用这个方法，减少WaitGroup内部的计数器。每调用一次，计数器就减1。
wait(): 这个方法就像一个守望者，它会一直阻塞，直到WaitGroup内部的计数器变为0。只有当所有被等待的协程都调用了done()方法，计数器归零，wait()方法才会解除阻塞，主协程才能继续执行。

可以用一个表格来形象地描述这个过程：

方法	作用	比喻
`add()`	增加`WaitGroup`的计数器，表示需要等待的协程数量。	登记需要等待的协程
`done()`	减少`WaitGroup`的计数器，表示一个协程已经完成任务。	注销已完成的协程
`wait()`	阻塞当前协程，直到`WaitGroup`的计数器变为0，表示所有需要等待的协程都已完成。	守望者，等待所有协程完成，解除阻塞

3. WaitGroup的实战演练：代码示例，一睹芳容

光说不练假把式，接下来，我们用几个简单的代码示例，来感受一下WaitGroup的魅力。

示例1：简单的协程等待

<?php

use SwooleCoroutine;
use SwooleCoroutineWaitGroup;

$wg = new WaitGroup();

$wg->add(2); // 增加计数器，表示需要等待2个协程

Coroutine::create(function () use ($wg) {
    Coroutine::sleep(1); // 模拟耗时操作
    echo "协程1完成!n";
    $wg->done(); // 协程完成，减少计数器
});

Coroutine::create(function () use ($wg) {
    Coroutine::sleep(2); // 模拟耗时操作
    echo "协程2完成!n";
    $wg->done(); // 协程完成，减少计数器
});

$wg->wait(); // 等待所有协程完成

echo "所有协程都完成了，主协程继续执行!n";

在这个例子中，我们创建了两个协程，分别模拟耗时1秒和2秒的操作。通过$wg->add(2);，我们告诉WaitGroup需要等待2个协程。每个协程完成任务后，都调用$wg->done();来减少计数器。主协程通过$wg->wait();来等待所有协程完成。

运行结果如下：

协程1完成!
协程2完成!
所有协程都完成了，主协程继续执行!

可以看到，主协程是在所有子协程都完成后才继续执行的。

示例2：下载多个文件

<?php

use SwooleCoroutine;
use SwooleCoroutineWaitGroup;
use SwooleCoroutineHttpClient;

function downloadFile(string $url, string $filename, WaitGroup $wg): void
{
    $cli = new Client('example.com', 80); // 替换为你实际的域名和端口
    $cli->get($url);
    file_put_contents($filename, $cli->body);
    echo "下载文件 {$filename} 完成!n";
    $wg->done();
}

$urls = [
    '/image1.jpg',
    '/image2.jpg',
    '/image3.jpg',
];

$wg = new WaitGroup();
$wg->add(count($urls));

foreach ($urls as $index => $url) {
    Coroutine::create(function () use ($url, $index, $wg) {
        downloadFile($url, "image{$index}.jpg", $wg);
    });
}

$wg->wait();

echo "所有文件下载完成!n";

这个例子展示了如何使用WaitGroup来等待多个文件下载协程完成。我们定义了一个downloadFile函数，用于下载单个文件。然后，我们遍历一个URL列表，为每个URL创建一个协程，并调用downloadFile函数进行下载。

示例3：结合通道（Channel）使用

WaitGroup常常和通道（Channel）一起使用，来实现更复杂的数据同步和通信。

<?php

use SwooleCoroutine;
use SwooleCoroutineWaitGroup;
use SwooleCoroutineChannel;

$wg = new WaitGroup();
$channel = new Channel(10); // 创建一个容量为10的通道

$wg->add(3);

Coroutine::create(function () use ($wg, $channel) {
    Coroutine::sleep(1);
    $channel->push("数据1");
    echo "协程1发送了数据1!n";
    $wg->done();
});

Coroutine::create(function () use ($wg, $channel) {
    Coroutine::sleep(2);
    $channel->push("数据2");
    echo "协程2发送了数据2!n";
    $wg->done();
});

Coroutine::create(function () use ($wg, $channel) {
    Coroutine::sleep(3);
    $channel->push("数据3");
    echo "协程3发送了数据3!n";
    $wg->done();
});

Coroutine::create(function () use ($wg, $channel) {
    $wg->wait(); // 等待所有发送协程完成
    echo "所有发送协程都完成了，开始接收数据!n";
    while (!$channel->isEmpty()) {
        $data = $channel->pop();
        echo "接收到数据：{$data}n";
    }
    echo "数据接收完毕!n";
});

在这个例子中，我们创建了三个协程，分别向通道发送数据。另一个协程负责接收通道中的数据。通过WaitGroup，我们确保了接收协程在所有发送协程都完成后才开始接收数据。

4. WaitGroup的注意事项：细节决定成败

虽然WaitGroup使用起来非常简单，但是在实际应用中，还是有一些需要注意的地方：

add()和done()必须成对出现。 如果你调用了add()，但没有相应的done()调用，那么wait()方法将永远阻塞，导致程序死锁。这就像借钱不还，迟早要出问题的！
不要在wait()方法之后再次调用add()。 wait()方法的设计初衷就是等待所有已知的协程完成。如果在wait()方法之后又增加了新的协程，那么wait()方法可能无法正确等待这些新的协程。
避免死锁。 死锁是并发编程中常见的问题。在使用WaitGroup时，需要仔细考虑协程之间的依赖关系，避免出现循环等待的情况。就像两个人都想先打电话，结果谁也不让，电话就永远打不出去。
错误处理。 在协程中进行错误处理非常重要。如果一个协程发生错误，并且没有正确处理，那么可能会导致done()方法没有被调用，从而导致wait()方法永远阻塞。

5. WaitGroup的进阶用法：超越基本，探索更多可能性

除了上述基本用法，WaitGroup还可以结合其他Swoole组件，实现更高级的功能。

结合定时器： 你可以使用定时器来设置wait()方法的超时时间。如果在指定的时间内，所有协程没有完成，那么可以提前结束等待，并进行相应的处理。

<?php

use SwooleCoroutine;
use SwooleCoroutineWaitGroup;
use SwooleTimer;

$wg = new WaitGroup();
$wg->add(1);

Coroutine::create(function () use ($wg) {
    Coroutine::sleep(5); // 模拟耗时操作
    echo "协程完成!n";
    $wg->done();
});

$timeout = 3000; // 超时时间为3秒

Timer::after($timeout, function () use ($wg) {
    echo "等待超时!n";
    // 这里可以进行一些错误处理，比如记录日志，或者强制结束协程
    $wg->done(); // 强制调用done()，解除wait()的阻塞
});

$wg->wait();

echo "主协程继续执行!n";

结合信号量： 你可以使用信号量来控制并发的数量，避免同时启动过多的协程，导致资源耗尽。
自定义WaitGroup： 虽然Swoole提供的WaitGroup已经足够强大，但是你也可以根据自己的需求，自定义一个WaitGroup类，添加一些额外的功能，比如回调函数，或者更精细的错误处理机制。

6. 总结：WaitGroup，协程世界的可靠伙伴

总而言之，WaitGroup是Swoole协程编程中一个非常实用，也非常重要的工具。它就像一位经验丰富的指挥家，能够协调和等待所有协程完成，确保程序的逻辑完整性和协调性。

掌握了WaitGroup的使用，你就能更好地掌控协程的并发执行，编写出更加健壮，更加高效的Swoole应用程序。

希望这篇文章能够帮助大家更好地理解和使用WaitGroup。记住，代码的世界充满了乐趣，只要你愿意探索，就一定能发现更多的惊喜！

最后，祝大家编程愉快，bug永不相见！ (^_^)