为PHP业务代码编写单元测试,如何用依赖替身验证邮件发送而不实际发信?

发布人:A5数据发布时间:2026-11-17 09:13阅读量:1

验证邮件业务时,可以把“构造邮件并调用发送”与真实网络投递分开。业务服务依赖 Mailer 接口,测试注入PHPUnit生成的mock,检查收件人、主题、正文和调用次数。只要测试没有创建真实邮件适配器,也没有其他隐藏的发信入口,就不会实际发信。

下面使用PHP 8.2及以上与PHPUnit 11,保留订单回执这个具体场景,不安装SMTP客户端,也不配置邮箱密码。

业务服务只依赖发信接口

将下面代码保存为 src/Receipt.php。为便于直接运行,相关声明放在一个文件;已有项目可以按原目录和自动加载规则拆分。

<?php
declare(strict_types=1);

final readonly class EmailMessage
{
    public function __construct(
        public string $to, public string $subject, public string $body
    ) {}
}

interface Mailer
{
    public function send(EmailMessage $message): void;
}

final class OrderReceiptService
{
    public function __construct(private Mailer $mailer) {}

    public function sendReceipt(string $to, string $orderId, int $amountCents): void
    {
        if (!filter_var($to, FILTER_VALIDATE_EMAIL)) {
            throw new InvalidArgumentException('邮箱地址无效');
        }
        if ($orderId === '' || $amountCents < 0) {
            throw new InvalidArgumentException('订单数据无效');
        }
        $amount = intdiv($amountCents, 100) . '.'
            . str_pad((string)($amountCents % 100), 2, '0', STR_PAD_LEFT);
        $this->mailer->send(new EmailMessage(
            $to,
            "订单{$orderId}回执",
            "订单{$orderId}已完成,金额{$amount}元。"
        ));
    }
}

金额以整数分传入,再拆出元和分,避免测试样例本身依赖浮点金额计算。服务没有在方法内部调用 mail() 或创建SMTP客户端,发送这个副作用只有注入的接口一个出口。

用mock检查参数与次数

保存为 tests/OrderReceiptServiceTest.php。这里直接引入业务文件,不依赖框架容器或额外自动加载配置。

<?php
declare(strict_types=1);

use PHPUnit\Framework\TestCase;

require_once __DIR__ . '/../src/Receipt.php';

final class OrderReceiptServiceTest extends TestCase
{
    public function testSendsOneReceiptWithExpectedContent(): void
    {
        $mailer = $this->createMock(Mailer::class);
        $mailer->expects($this->once())
            ->method('send')
            ->with($this->equalTo(new EmailMessage(
                'reader@example.test',
                '订单A001回执',
                '订单A001已完成,金额12.50元。'
            )));

        (new OrderReceiptService($mailer))->sendReceipt(
            'reader@example.test', 'A001', 1250
        );
    }

    public function testInvalidAddressNeverCallsMailer(): void
    {
        $mailer = $this->createMock(Mailer::class);
        $mailer->expects($this->never())->method('send');
        $this->expectException(InvalidArgumentException::class);

        (new OrderReceiptService($mailer))->sendReceipt('invalid', 'A001', 1250);
    }
}

第一个测试同时约束发送一次及邮件对象中的三个字段。漏调用、重复调用或参数变化都会让预期不成立。第二个测试验证无效地址在业务层被拒绝,并且发信接口不被调用。mock实现了同一接口,但不会执行任何真实发信实现。

在项目中安装PHPUnit后执行测试:

composer require --dev phpunit/phpunit:^11
vendor/bin/phpunit tests/OrderReceiptServiceTest.php

Windows命令行可使用 vendor\bin\phpunit.bat tests\OrderReceiptServiceTest.php。已有测试依赖时继续使用项目兼容版本,不必为了示例重复安装;本文用到的是 createMock、expects 和参数匹配这些接口测试能力。

什么时候改用fake

如果要一次发送多封邮件,再按订单或收件人检查全部结果,可以写一个实现 Mailer 的内存fake,将每次调用的邮件对象存入数组,最后对数组断言。它仍不连接SMTP。单封回执用上面的mock已经足够,不必在同一篇示例里再搭一套相同的实现。

图中的生产路径以 SymfonyMailerAdapter 和Symfony Mailer传输组件作例子;这不是本测试要创建的对象,也无需在此实现。EmailMessage 只在业务服务与接口替身之间传递。

什么时候改用fake配图

这些测试证明的是业务向发信接口提交了什么,不证明SMTP认证、模板在真实客户端中的显示或最终送达。真实邮件适配器应单独做受控集成测试;不要在这组单元测试的初始化流程中载入生产发信配置,也不要把真实邮箱收件情况作为单元测试断言。

A5idc数据提供可用于PHP业务应用及独立开发测试环境的服务器资源,涵盖多档CPU、内存与SSD/NVMe存储组合。中国香港、美国、日本等地区的物理服务器,为业务程序、测试任务与数据服务提供独立的运行资源,可按项目规模组织应用环境。

本文由A5数据原创发布,转载请注明出处:https://www.a5idc.com/helpcontent/9859.html

相关推荐