如何用PHPUnit测试函数调用过程中事件是否被调度？

好问题！在PHPUnit中验证事件调度（同时避免触发真实业务逻辑比如发送邮件），最干净的方式分两种情况——如果你用的是Laravel这类自带事件系统的框架，或者是自定义的事件实现，下面分别给出方案：

一、Laravel框架下的最优方案：事件伪造（Event Fake） #

Laravel提供了Event::fake()方法，能彻底隔离事件的实际执行，让你专注于验证事件是否被正确调度、参数是否准确，完全不会触发监听器里的发邮件逻辑。

步骤1：伪造目标事件 #

在测试方法开头，先伪造你要验证的UserUpdated事件（或者直接伪造所有事件）：

use Illuminate\Support\Facades\Event;
use App\Events\UserUpdated;

// 只伪造UserUpdated事件，其他事件正常执行
Event::fake(UserUpdated::class);

// 或者伪造所有事件，适合只关注当前方法的事件调度时用
// Event::fake();

步骤2：执行待测试的方法 #

调用你的updateUser方法，记得传入测试所需的用户、邮箱等参数：

// 先准备测试数据，比如创建一个测试用户
$user = User::factory()->create();
$newEmail = 'new-user@example.com';
$oldEmail = 'old-user@example.com';

// 假设updateUser属于某个服务类，实例化后调用方法
$userService = new \App\Services\UserService();
$userService->updateUser($user, $newEmail, $oldEmail);

步骤3：断言事件的调度情况 #

用Laravel提供的断言方法，验证事件是否被调度、参数是否正确：

// 基础断言：UserUpdated事件至少被调度一次
Event::assertDispatched(UserUpdated::class);

// 精确断言：事件被调度了恰好1次（符合你的业务逻辑）
Event::assertDispatched(UserUpdated::class, 1);

// 深入断言：验证事件携带的用户参数是否正确
Event::assertDispatched(UserUpdated::class, function ($event) use ($user) {
    // 检查事件中的用户是否和我们创建的测试用户一致
    return $event->user->is($user);
});

// 可选：断言其他无关事件没有被误调度
// Event::assertNotDispatched(\App\Events\OtherEvent::class);

二、自定义事件系统的测试方案：Mock事件类 #

如果你的事件系统是自己实现的（不是Laravel自带的），可以用PHPUnit的Mock功能来验证事件的attach和dispatch方法是否被正确调用：

测试代码示例： #

use App\Events\UserUpdated;
use App\Listeners\SendEmailAddressChangeEmail;
use PHPUnit\Framework\TestCase;

class UserServiceTest extends TestCase
{
    public function test_update_user_dispatches_event_with_correct_listeners()
    {
        // 准备测试用户
        $user = new \App\Models\User();
        $newEmail = 'new@example.com';
        $oldEmail = 'old@example.com';

        // 创建UserUpdated事件的Mock，只监听attach和dispatch方法
        $eventMock = $this->getMockBuilder(UserUpdated::class)
            ->setConstructorArgs([$user])
            ->onlyMethods(['attach', 'dispatch'])
            ->getMock();

        // 断言attach方法被调用一次，且传入了两个正确的监听器实例
        $eventMock->expects($this->once())
            ->method('attach')
            ->with([
                $this->isInstanceOf(SendEmailAddressChangeEmail::class),
                $this->isInstanceOf(SendEmailAddressChangeEmail::class),
            ]);

        // 断言dispatch方法被调用一次
        $eventMock->expects($this->once())
            ->method('dispatch');

        // 这里需要把Mock的事件注入到你的服务类中
        // 假设你的updateUser方法通过依赖注入获取事件实例
        $userService = new \App\Services\UserService($eventMock);
        $userService->updateUser($newEmail, $oldEmail);
    }
}

额外说明 #

• 为什么推荐事件伪造/Mock？这样能彻底隔离测试，不用依赖邮件服务、第三方API等外部资源，让测试更快、更稳定，也更专注于验证updateUser方法的核心逻辑——是否正确触发了事件。
• 监听器的逻辑（比如发邮件）应该单独写测试，不用和事件调度的测试混在一起，保持单一职责原则。

内容的提问来源于stack exchange，提问作者Aaron Bar