PHP 怎么测试覆盖率目标

wen PHP项目 2026-08-03 159

本文目录导读：

PHP 怎么测试覆盖率目标

工具选择
设置覆盖率目标
运行覆盖率测试
CI/CD 集成（GitHub Actions 示例）
覆盖率阈值检查工具
常见覆盖率类型及目标
覆盖率目标设置策略
提升覆盖率的技巧
监控与报告工具
最佳实践建议

在 PHP 中测试覆盖率目标,通常涉及以下几个层面：

工具选择

Xdebug（最常用）

# 安装 Xdebug
pecl install xdebug
# 或在 Linux 上
apt-get install php-xdebug

PCOV（更轻量）

pecl install pcov

PHPUnit 配置

<!-- phpunit.xml -->
<phpunit bootstrap="vendor/autoload.php">
    <coverage>
        <include>
            <directory suffix=".php">src</directory>
        </include>
        <exclude>
            <directory>vendor</directory>
            <directory>tests</directory>
        </exclude>
        <report>
            <html outputDirectory="coverage-report"/>
            <clover outputFile="coverage.xml"/>
            <text outputFile="php://stdout" showUncoveredFiles="true"/>
        </report>
    </coverage>
</phpunit>

设置覆盖率目标

配置 PHPUnit 覆盖率阈值

<!-- phpunit.xml -->
<coverage>
    <report>
        <html outputDirectory="coverage-report"/>
        <text outputFile="php://stdout" showUncoveredFiles="true"/>
    </report>
    <php>
        <ini name="xdebug.mode" value="coverage"/>
    </php>
    <thresholds>
        <coverage>
            <low>40</low>
            <high>90</high>
        </coverage>
        <line>
            <low>50</low>
            <high>80</high>
        </line>
        <class>
            <low>30</low>
            <high>70</high>
        </class>
        <method>
            <low>40</low>
            <high>80</high>
        </method>
    </thresholds>
</coverage>

常见覆盖率目标配置

<coverage>
    <!-- 全局目标 -->
    <report>
        <clover outputFile="coverage.xml"/>
    </report>
    <!-- 设置最低覆盖率 80% -->
    <include>
        <directory>src</directory>
    </include>
    <!-- 排除特定文件/目录 -->
    <exclude>
        <file>src/Exceptions/XxxException.php</file>
        <directory>src/Adapters</directory>
    </exclude>
</coverage>

运行覆盖率测试

# 基础运行
phpunit --coverage-text
# 生成报告
phpunit --coverage-html coverage/
phpunit --coverage-xml coverage/coverage.xml
phpunit --coverage-clover coverage/coverage.clover.xml
# 带阈值检查（失败则退出非0）
phpunit --coverage-text --fail-on-warning --fail-on-risky

CI/CD 集成（GitHub Actions 示例）

# .github/workflows/ci.yml
name: PHP CI
on: [push, pull_request]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: Setup PHP
      uses: shivammathur/setup-php@v2
      with:
        php-version: '8.1'
        extensions: xdebug
        coverage: xdebug
    - name: Install dependencies
      run: composer install
    - name: Run PHPUnit with coverage
      run: |
        vendor/bin/phpunit --coverage-clover coverage.xml
        vendor/bin/phpunit --coverage-text
    - name: Upload coverage to Codecov
      uses: codecov/codecov-action@v3
      with:
        files: ./coverage.xml
        flags: phpunit

覆盖率阈值检查工具

使用 PHP-MD

composer require --dev pdepend/pdepend
vendor/bin/pdepend --coverage-report=coverage.xml --jdepend-chart=jdepend.svg src/

自定义覆盖率检查脚本

<?php
// scripts/check-coverage.php
$xml = simplexml_load_file('coverage.xml');
$metrics = $xml->project->metrics;
$coverage = (float) $metrics['covered'] / $metrics['elements'] * 100;
$threshold = 80.0;
if ($coverage < $threshold) {
    echo "覆盖率不达标: {$coverage}% < {$threshold}%\n";
    exit(1);
}
echo "覆盖率达标: {$coverage}% >= {$threshold}%\n";

常见覆盖率类型及目标

类型	说明	常见目标
语句/行覆盖率	被执行的语句比例	80-90%
分支覆盖率	条件分支被执行比例	70-80%
方法覆盖率	被调用的方法比例	90-100%
类覆盖率	被实例化的类比例	90-100%
路径覆盖率	所有路径被执行比例	60-80%

覆盖率目标设置策略

<!-- phpunit.xml 完整示例 -->
<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         bootstrap="vendor/autoload.php"
         colors="true"
         failOnWarning="true"
         failOnRisky="true">
    <testsuites>
        <testsuite name="Application Test Suite">
            <directory>./tests</directory>
        </testsuite>
    </testsuites>
    <source>
        <include>
            <directory>./src</directory>
        </include>
        <exclude>
            <directory>./src/Migrations</directory>
            <directory>./src/Config</directory>
        </exclude>
    </source>
    <coverage>
        <report>
            <html outputDirectory="build/coverage"/>
            <clover outputFile="build/coverage.xml"/>
        </report>
    </coverage>
    <php>
        <ini name="error_reporting" value="-1"/>
        <server name="APP_ENV" value="testing"/>
        <env name="DB_DATABASE" value=":memory:"/>
    </php>
</phpunit>

提升覆盖率的技巧

// 1. 数据提供器生成多种测试数据
/**
 * @dataProvider additionProvider
 */
public function testAddition(int $a, int $b, int $expected): void
{
    $this->assertEquals($expected, $a + $b);
}
public function additionProvider(): array
{
    return [
        [0, 0, 0],
        [1, 1, 2],
        [5, 5, 10],
        [-1, -1, -2],
    ];
}
// 2. 测试异常路径
public function testInvalidInput(): void
{
    $this->expectException(InvalidArgumentException::class);
    $service->process('invalid');
}
// 3. Mock 外部依赖
$mock = $this->createMock(ExternalService::class);
$mock->method('callApi')
     ->willReturn('mock_response');