PHP单元测试不求人：手把手教你用Mock对象实现测试替身

还在为PHP单元测试中的依赖项困扰吗？本文教你摆脱困境！掌握PHP单元测试中Mock对象的使用，无需依赖真实环境，轻松隔离被测代码，专注核心逻辑验证，提升测试效率与可靠性。本文将深入讲解如何利用PHPUnit框架的`createMock()`方法创建Mock对象，并通过`method()`和`willReturn()`方法定义其行为，以及如何使用`expects()`方法验证方法调用次数和参数。此外，文章还阐述了Mock对象与Stub对象的区别，并指导你在合适的场景下选择使用Mock对象，例如依赖外部系统或API时，但同时提醒避免过度使用，保持测试的简洁性。告别繁琐的配置，让你的PHP单元测试更高效、更精准！

使用Mock对象进行单元测试是为了隔离被测代码与其他依赖项，确保测试专注于被测代码本身的逻辑是否正确。1. Mock对象模拟真实依赖项的行为，允许控制返回值和行为，提升测试的可靠性和可预测性；2. PHPUnit框架通过createMock()方法创建Mock对象，并使用method()和willReturn()定义其行为；3. 可通过expects()方法验证方法调用次数及参数，如once()表示调用一次，with()验证参数；4. Mock对象用于验证交互行为，而Stub对象仅提供预定义返回值；5. 适用于依赖外部系统、数据库或API等难以控制的组件时，但应避免过度使用以保持测试简洁。

PHP中使用Mock对象进行单元测试，是为了隔离被测代码与其他依赖项，确保测试的重点是被测代码本身的逻辑是否正确。Mock对象模拟了真实依赖项的行为，允许你控制依赖项的返回值和行为，从而编写更可靠、可预测的单元测试。

解决方案

使用PHPUnit框架，你可以轻松地创建和使用Mock对象。以下是一个基本示例：

假设你有一个类OrderService，它依赖于PaymentGateway来处理支付：

class OrderService {
    private $paymentGateway;

    public function __construct(PaymentGateway $paymentGateway) {
        $this->paymentGateway = $paymentGateway;
    }

    public function processOrder(Order $order) {
        if ($order->getTotal() > 100 && $this->paymentGateway->isAvailable()) {
            return $this->paymentGateway->processPayment($order->getTotal());
        }
        return false;
    }
}

class Order {
  private $total;

  public function __construct(float $total) {
    $this->total = $total;
  }

  public function getTotal(): float {
    return $this->total;
  }
}

interface PaymentGateway {
    public function isAvailable(): bool;
    public function processPayment(float $amount): bool;
}

现在，你想测试OrderService::processOrder()方法，但不想真正调用PaymentGateway。你可以创建一个PaymentGateway的Mock对象：

use PHPUnit\Framework\TestCase;

class OrderServiceTest extends TestCase {
    public function testProcessOrder_PaymentSuccessful() {
        // 1. 创建 Mock 对象
        $paymentGatewayMock = $this->createMock(PaymentGateway::class);

        // 2. 设置 Mock 对象的期望行为
        $paymentGatewayMock->method('isAvailable')
                           ->willReturn(true);
        $paymentGatewayMock->method('processPayment')
                           ->willReturn(true);

        // 3. 创建 OrderService 实例，并注入 Mock 对象
        $orderService = new OrderService($paymentGatewayMock);
        $order = new Order(150.0);

        // 4. 执行被测代码
        $result = $orderService->processOrder($order);

        // 5. 断言结果
        $this->assertTrue($result);
    }

    public function testProcessOrder_PaymentFailed() {
        $paymentGatewayMock = $this->createMock(PaymentGateway::class);
        $paymentGatewayMock->method('isAvailable')->willReturn(false);

        $orderService = new OrderService($paymentGatewayMock);
        $order = new Order(150.0);

        $result = $orderService->processOrder($order);

        $this->assertFalse($result);
    }
}

这个例子展示了如何使用createMock()方法创建Mock对象，并使用method()和willReturn()方法设置Mock对象的期望行为。 关键点在于：我们没有真正使用PaymentGateway，而是用一个可控的替身代替，这使得测试更加快速和可靠。

如何验证Mock对象的方法是否被调用？

除了设置返回值，你还可以验证Mock对象的方法是否被调用，以及被调用的次数和参数。 PHPUnit提供了expects()方法来完成这个任务。 例如：

public function testProcessOrder_PaymentCalledWithCorrectAmount() {
    $paymentGatewayMock = $this->createMock(PaymentGateway::class);

    $paymentGatewayMock->expects($this->once())
                       ->method('processPayment')
                       ->with($this->equalTo(150.0))
                       ->willReturn(true);

    $orderService = new OrderService($paymentGatewayMock);
    $order = new Order(150.0);
    $orderService->processOrder($order);
}

在这个例子中，expects($this->once())指定了processPayment()方法应该被调用一次。with($this->equalTo(150.0))指定了processPayment()方法应该被调用，并且参数应该等于150.0。 如果这些条件不满足，测试将会失败。

Mock对象和Stub对象的区别是什么？

Mock对象和Stub对象都是测试替身，但它们的目的不同。Stub对象主要用于提供预定义的返回值，以便被测代码可以正常运行。 Mock对象则更进一步，它不仅提供返回值，还可以验证被测代码是否以正确的方式调用了依赖项。 简单来说，Stub用于提供数据，Mock用于验证行为。 通常情况下，如果你的测试需要验证交互，那么应该使用Mock对象。 如果你只需要提供一些数据，那么可以使用Stub对象。

何时应该使用Mock对象？

使用Mock对象的最佳时机是当你的代码依赖于外部系统、数据库、API或其他难以控制的组件时。 使用Mock对象可以让你隔离被测代码，确保测试的重点是被测代码本身的逻辑是否正确。 此外，当外部组件的行为不稳定或难以预测时，使用Mock对象可以使测试更加可靠。 但是，过度使用Mock对象也会使测试变得复杂和难以维护。 因此，应该谨慎使用Mock对象，只在必要时使用。

以上就是《PHP单元测试不求人：手把手教你用Mock对象实现测试替身》的详细内容，更多关于单元测试,PHPUnit,Mock对象,测试替身,依赖隔离的资料请关注golang学习网公众号！