
本文旨在探讨在phpunit测试中,如何通过解耦设计模式,特别是依赖注入,来解决对内部实例化依赖进行模拟的难题。我们将通过一个具体的php类测试案例,演示如何重构代码以实现更好的可测试性,并利用phpunit的模拟功能来验证业务逻辑,从而提升代码质量和维护性。
在编写单元测试时,我们经常会遇到需要测试一个类的方法,而该方法又依赖于其他类的行为。当被测试的类在其内部直接实例化这些依赖时,就会产生紧密耦合。这种耦合使得我们难以在测试环境中隔离被测试的类,因为我们无法控制其内部创建的依赖对象的行为。
考虑以下PHP代码示例:
class CreditCardProcessor {
public function chargeCreditCard(): bool {
// 实际的信用卡处理逻辑,可能涉及外部API调用
return false; // 默认返回失败
}
}
class Order {
public function create(): bool {
// Order类内部直接实例化 CreditCardProcessor
$CCP = new CreditCardProcessor();
$success = $CCP->chargeCreditCard();
return $success;
}
}在这种设计下,Order 类的 create 方法直接创建了 CreditCardProcessor 的实例。如果在测试 Order::create() 方法时,我们希望模拟 CreditCardProcessor::chargeCreditCard() 方法的行为(例如,强制它返回 true 或 false),这是非常困难的,因为 Order 类内部的 new CreditCardProcessor() 始终会创建一个真实的实例。
尝试使用PHPUnit的Mocking功能直接模拟这种内部依赖会遇到障碍,如下面的测试代码所示:
立即学习“PHP免费学习笔记(深入)”;
use PHPUnit\Framework\TestCase;
class OrderTest extends TestCase {
public function testCreate() {
// 尝试模拟 CreditCardProcessor
$mockCCP = $this->getMockBuilder(CreditCardProcessor::class)
->onlyMethods(['chargeCreditCard']) // PHPUnit 9+ 推荐 onlyMethods
->getMock();
$mockCCP
->method('chargeCreditCard')
->willReturn(true);
$O = new Order();
// 问题在于:Order 内部仍然创建了真实的 CreditCardProcessor 实例
// 而不是我们注入的 mockCCP
$success = $O->create();
$this->assertTrue($success, 'Was not able to create order.');
}
}运行上述测试,$success 仍然会是 false,因为 Order 内部调用的 chargeCreditCard() 是真实 CreditCardProcessor 实例的方法,而不是我们模拟的 $mockCCP。
解决上述问题的关键在于解耦,最常用的方法是依赖注入 (Dependency Injection, DI)。依赖注入是一种设计模式,它允许一个类从外部接收其所依赖的对象,而不是在内部创建它们。这极大地提高了代码的模块化、可测试性和可维护性。
我们可以通过修改 Order 类,使其不再内部实例化 CreditCardProcessor,而是通过其方法参数(或构造函数)接收一个 CreditCardProcessor 实例。
将 CreditCardProcessor 作为参数传递给 create 方法:
class Order {
/**
* 创建订单。
*
* @param CreditCardProcessor $CCP 用于处理信用卡支付的处理器实例。
* @return bool 订单创建是否成功。
*/
public function create(CreditCardProcessor $CCP): bool {
// 现在 Order 类接收外部提供的 CreditCardProcessor 实例
$success = $CCP->chargeCreditCard();
return $success;
}
}现在,Order 类不再关心 CreditCardProcessor 是如何创建的,它只知道会收到一个 CreditCardProcessor 的实例,并调用其 chargeCreditCard 方法。这使得 Order 类与 CreditCardProcessor 的具体实现解耦。
一旦 Order 类被重构以接受依赖,我们就可以在测试中轻松地注入一个模拟对象。
use PHPUnit\Framework\TestCase;
class OrderTest extends TestCase {
/**
* 测试 Order::create 方法在信用卡处理成功时的行为。
*/
public function testCreateWhenCreditCardProcessingSucceeds(): void {
// 1. 创建 CreditCardProcessor 的模拟对象
$mockCCP = $this->getMockBuilder(CreditCardProcessor::class)
->onlyMethods(['chargeCreditCard']) // 指定要模拟的方法
->getMock();
// 2. 定义模拟对象的行为:当调用 chargeCreditCard 时返回 true
$mockCCP
->method('chargeCreditCard')
->willReturn(true);
// 3. 实例化 Order 类
$order = new Order();
// 4. 调用 Order::create 方法,并注入模拟对象
$success = $order->create($mockCCP);
// 5. 断言订单创建成功
$this->assertTrue($success, '订单创建失败,尽管信用卡处理成功。');
}
/**
* 测试 Order::create 方法在信用卡处理失败时的行为。
*/
public function testCreateWhenCreditCardProcessingFails(): void {
$mockCCP = $this->getMockBuilder(CreditCardProcessor::class)
->onlyMethods(['chargeCreditCard'])
->getMock();
// 定义模拟行为:当调用 chargeCreditCard 时返回 false
$mockCCP
->method('chargeCreditCard')
->willReturn(false);
$order = new Order();
$success = $order->create($mockCCP);
// 断言订单创建失败
$this->assertFalse($success, '订单创建成功,尽管信用卡处理失败。');
}
}在这个更新后的测试中:
通过本教程,我们学习了在PHPUnit中测试依赖类时,如何克服紧密耦合带来的挑战。核心思想是采用依赖注入模式来解耦类之间的关系,从而允许我们在测试中轻松地注入模拟对象。这不仅使得单元测试更加有效和可靠,也促使我们编写出结构更优、更具扩展性的高质量PHP代码。掌握这一技巧是编写健壮、可维护应用程序的关键一步。
以上就是PHPUnit中解耦与模拟依赖:提升代码可测试性的详细内容,更多请关注php中文网其它相关文章!
PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号