
本文旨在探讨在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 实例。
代码小浣熊 代码小浣熊是基于商汤大语言模型的软件智能研发助手,覆盖软件需求分析、架构设计、代码编写、软件测试等环节
51 查看详情
重构 Order 类
将 CreditCardProcessor 作为参数传递给 create 方法:
class Order { public function create(CreditCardProcessor $CCP): bool { // 现在 Order 类接收外部提供的 CreditCardProcessor 实例 $success = $CCP->chargeCreditCard(); return $success; }}登录后复制现在,Order 类不再关心 CreditCardProcessor 是如何创建的,它只知道会收到一个 CreditCardProcessor 的实例,并调用其 chargeCreditCard 方法。这使得 Order 类与 CreditCardProcessor 的具体实现解耦。
使用 PHPUnit 模拟注入的依赖
一旦 Order 类被重构以接受依赖,我们就可以在测试中轻松地注入一个模拟对象。
更新 OrderTest 类
use PHPUnit\framework\TestCase;class OrderTest extends TestCase { 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, '订单创建失败,尽管信用卡处理成功。'); } 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, '订单创建成功,尽管信用卡处理失败。'); }}登录后复制在这个更新后的测试中:
我们首先创建了 CreditCardProcessor 的一个模拟对象 ($mockCCP)。然后,我们告诉这个模拟对象,当它的 chargeCreditCard 方法被调用时,应该返回 true(或 false,取决于测试场景)。最后,在调用 Order 类的 create 方法时,我们将这个模拟对象作为参数传递进去。这样,Order 类在执行其逻辑时,实际上是与我们控制的模拟对象进行交互,而不是真实的 CreditCardProcessor。最佳实践与注意事项
依赖注入的优势: 除了提高可测试性,依赖注入还增强了代码的灵活性和可维护性。你可以轻松地替换 CreditCardProcessor 的不同实现(例如,测试支付网关、生产支付网关),而无需修改 Order 类的核心逻辑。接口优先: 更进一步的最佳实践是,让 Order 类依赖于一个 CreditCardProcessorInterface 接口,而不是具体的 CreditCardProcessor 类。这样,你可以创建实现了该接口的任何类(包括模拟对象),而 Order 类对此一无所知。构造函数注入 vs. 方法注入: 本例使用了方法注入。对于一个类的核心依赖,通常更推荐使用构造函数注入,因为它确保了对象在创建时就具备了所有必要的依赖,使其始终处于有效状态。方法注入适用于可选依赖或在特定操作中才需要的依赖。不为测试而改变设计? 有人可能不喜欢为了测试而改变代码结构。然而,通常情况下,为了测试性而进行的重构(如引入依赖注入)往往会使代码设计变得更好、更健壮、更易于维护和扩展。这通常是代码需要改进的信号,而不是一个妥协。总结
通过本教程,我们学习了在PHPUnit中测试依赖类时,如何克服紧密耦合带来的挑战。核心思想是采用依赖注入模式来解耦类之间的关系,从而允许我们在测试中轻松地注入模拟对象。这不仅使得单元测试更加有效和可靠,也促使我们编写出结构更优、更具扩展性的高质量PHP代码。掌握这一技巧是编写健壮、可维护应用程序的关键一步。
以上就是PHPUnit中解耦与模拟依赖:提升代码可测试性的详细内容,更多请关注php中文网其它相关文章!



