PHPUnit Mock Objects 项目使用教程

PHPUnit Mock Objects 项目使用教程

【免费下载链接】phpunit-mock-objects Mock Object library for PHPUnit 项目地址: https://gitcode.com/gh_mirrors/ph/phpunit-mock-objects

概述

PHPUnit Mock Objects 是 PHPUnit 测试框架的默认 Mock Object（模拟对象）库，专门用于创建测试替身（Test Doubles）来隔离测试代码与依赖组件。通过模拟对象，开发者可以专注于测试特定单元的行为，而无需关心外部依赖的实际实现。

核心概念

Mock Object（模拟对象）是什么？

Mock Object 是一种特殊的测试替身，它能够：

• 模拟真实对象的行为
• 验证方法调用情况
• 控制方法返回值
• 记录方法调用参数

安装与配置

通过 Composer 安装

composer require --dev phpunit/phpunit-mock-objects

基本配置

确保在 phpunit.xml 中正确配置：

<phpunit bootstrap="vendor/autoload.php">
    <testsuites>
        <testsuite name="Application Test Suite">
            <directory>./tests/</directory>
        </testsuite>
    </testsuites>
</phpunit>

核心功能详解

1. 创建基本模拟对象

模拟接口

<?php
use PHPUnit\Framework\TestCase;

class MockObjectTest extends TestCase
{
    public function testMockInterface()
    {
        // 创建接口模拟对象
        $mock = $this->getMockBuilder(AnInterface::class)
                     ->getMock();
        
        // 设置方法期望
        $mock->expects($this->once())
             ->method('doSomething');
        
        // 执行测试
        $mock->doSomething();
    }
}

模拟具体类

public function testMockConcreteClass()
{
    $mock = $this->getMockBuilder(SomeClass::class)
                 ->getMock();
    
    $mock->expects($this->any())
         ->method('doSomething')
         ->willReturn('mocked result');
    
    $result = $mock->doSomething('param1', 'param2');
    $this->assertEquals('mocked result', $result);
}

2. 方法调用验证

PHPUnit Mock Objects 提供了多种验证器来检查方法调用情况：

验证器	描述	示例
once()	方法被调用一次	$this->once()
never()	方法从未被调用	$this->never()
any()	方法被调用任意次数	$this->any()
exactly($count)	方法被调用指定次数	$this->exactly(3)
at($index)	方法在指定索引位置被调用	$this->at(0)

public function testMethodCallVerification()
{
    $mock = $this->getMockBuilder(SomeClass::class)
                 ->getMock();
    
    // 验证方法被调用 exactly 2 次
    $mock->expects($this->exactly(2))
         ->method('doSomething');
    
    $mock->doSomething();
    $mock->doSomething();
}

3. 返回值控制

固定返回值

public function testReturnFixedValue()
{
    $mock = $this->getMockBuilder(SomeClass::class)
                 ->getMock();
    
    $mock->expects($this->any())
         ->method('doSomething')
         ->willReturn('fixed_value');
    
    $this->assertEquals('fixed_value', $mock->doSomething());
}

回调返回值

public function testReturnCallback()
{
    $mock = $this->getMockBuilder(SomeClass::class)
                 ->getMock();
    
    $mock->expects($this->any())
         ->method('doSomething')
         ->willReturnCallback(function($a, $b) {
             return $a + $b;
         });
    
    $this->assertEquals(5, $mock->doSomething(2, 3));
}

返回值映射

public function testReturnValueMap()
{
    $mock = $this->getMockBuilder(SomeClass::class)
                 ->getMock();
    
    $valueMap = [
        [1, 2, 3],
        [3, 4, 7],
        [5, 6, 11]
    ];
    
    $mock->expects($this->any())
         ->method('doSomething')
         ->will($this->returnValueMap($valueMap));
    
    $this->assertEquals(7, $mock->doSomething(3, 4));
}

4. 参数匹配

public function testParameterMatching()
{
    $mock = $this->getMockBuilder(SomeClass::class)
                 ->getMock();
    
    // 使用 with() 进行参数匹配
    $mock->expects($this->once())
         ->method('doSomething')
         ->with($this->equalTo('expected_param'))
         ->willReturn('success');
    
    $result = $mock->doSomething('expected_param');
    $this->assertEquals('success', $result);
}

常用的参数匹配器：

匹配器	描述	示例
equalTo($value)	等于指定值	$this->equalTo(42)
identicalTo($value)	与指定值相同（===）	$this->identicalTo($obj)
isEmpty()	为空值	$this->isEmpty()
isType($type)	指定类型	$this->isType('string')
contains($value)	包含指定值	$this->contains('substring')

高级用法

1. 部分模拟（Partial Mock）

public function testPartialMock()
{
    // 只模拟部分方法，其他方法保持原样
    $mock = $this->getMockBuilder(SomeClass::class)
                 ->setMethods(['doSomething'])
                 ->getMock();
    
    $mock->expects($this->once())
         ->method('doSomething')
         ->willReturn('mocked');
    
    // doSomethingElse 方法保持原样
    $result = $mock->doSomethingElse('param');
}

2. 模拟抽象类

public function testMockAbstractClass()
{
    $mock = $this->getMockBuilder(AbstractMockTestClass::class)
                 ->getMockForAbstractClass();
    
    $mock->expects($this->any())
         ->method('abstractMethod')
         ->willReturn('implemented');
    
    $this->assertEquals('implemented', $mock->abstractMethod());
}

3. 模拟 Trait

public function testMockTrait()
{
    $mock = $this->getMockBuilder(ExampleTrait::class)
                 ->getMockForTrait();
    
    $mock->expects($this->once())
         ->method('traitMethod')
         ->willReturn('trait_mocked');
    
    $this->assertEquals('trait_mocked', $mock->traitMethod());
}

最佳实践

1. 测试流程设计

2. 避免过度模拟

// 不好的实践：过度模拟
public function testOverMocking()
{
    $mock = $this->getMockBuilder(SomeService::class)
                 ->setMethods(['method1', 'method2', 'method3'])
                 ->getMock();
    
    // 设置大量不必要的模拟
}

// 好的实践：只模拟必要的依赖
public function testProperMocking()
{
    $dependencyMock = $this->getMockBuilder(ExternalDependency::class)
                           ->getMock();
    
    $dependencyMock->expects($this->once())
                   ->method('criticalMethod')
                   ->willReturn('expected');
    
    $service = new MyService($dependencyMock);
    $result = $service->process();
    
    $this->assertEquals('expected_result', $result);
}

3. 使用数据提供器

/**
 * @dataProvider methodCallDataProvider
 */
public function testMethodCallsWithDataProvider($expectedCalls, $methodName)
{
    $mock = $this->getMockBuilder(SomeClass::class)
                 ->getMock();
    
    $mock->expects($this->exactly($expectedCalls))
         ->method($methodName);
    
    // 根据测试数据调用方法
    for ($i = 0; $i < $expectedCalls; $i++) {
        $mock->$methodName();
    }
}

public function methodCallDataProvider()
{
    return [
        [1, 'doSomething'],
        [3, 'doSomethingElse'],
        [0, 'nonExistentMethod']
    ];
}

常见问题与解决方案

1. 模拟静态方法

public function testStaticMethodMocking()
{
    // 注意：需要 PHPUnit 8+ 版本支持
    $mock = $this->getMockBuilder(ClassWithStaticMethod::class)
                 ->setMethods(['staticMethod'])
                 ->getMock();
    
    $mock::staticMethod(); // 静态方法调用
}

2. 处理异常情况

public function testExceptionThrowing()
{
    $mock = $this->getMockBuilder(SomeClass::class)
                 ->getMock();
    
    $mock->expects($this->once())
         ->method('doSomething')
         ->will($this->throwException(new \RuntimeException('Test exception')));
    
    $this->expectException(\RuntimeException::class);
    $this->expectExceptionMessage('Test exception');
    
    $mock->doSomething();
}

3. 验证调用顺序

public function testCallOrderVerification()
{
    $mock = $this->getMockBuilder(SomeClass::class)
                 ->getMock();
    
    $mock->expects($this->at(0))
         ->method('method1');
    
    $mock->expects($this->at(1))
         ->method('method2');
    
    $mock->method1();
    $mock->method2();
}

性能优化技巧

1. 重用模拟对象

protected function setUp(): void
{
    parent::setUp();
    
    // 在 setUp 中创建可重用的模拟对象
    $this->sharedMock = $this->getMockBuilder(SharedDependency::class)
                             ->getMock();
}

public function testOne()
{
    $this->sharedMock->expects($this->once())
                     ->method('sharedMethod');
    // ...
}

public function testTwo()
{
    $this->sharedMock->expects($this->never())
                     ->method('sharedMethod');
    // ...
}

2. 禁用自动返回值生成

public function testDisableAutoReturnValue()
{
    $mock = $this->getMockBuilder(SomeClass::class)
                 ->disableAutoReturnValueGeneration()
                 ->getMock();
    
    // 需要显式设置所有方法的返回值
    $mock->expects($this->any())
         ->method('doSomething')
         ->willReturn('explicit_value');
}

总结

PHPUnit Mock Objects 是一个强大的测试工具，通过熟练掌握其各种功能，可以显著提高测试代码的质量和可维护性。关键要点包括：

1. 正确使用模拟对象来隔离测试依赖
2. 合理设置方法期望和返回值
3. 充分利用参数匹配器进行精确验证
4. 遵循最佳实践避免过度模拟
5. 优化性能通过对象重用和适当配置

通过本教程的学习，您应该能够熟练运用 PHPUnit Mock Objects 来编写高质量、可维护的单元测试代码。

【免费下载链接】phpunit-mock-objects Mock Object library for PHPUnit 项目地址: https://gitcode.com/gh_mirrors/ph/phpunit-mock-objects