推荐开源项目：PHP-VCR - 虚拟HTTP录制回放库-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00071/article/details/138892405

推荐开源项目：PHP-VCR - 虚拟HTTP录制回放库

php-vcrRecord your test suite's HTTP interactions and replay them during future test runs for fast, deterministic, accurate tests.项目地址:https://gitcode.com/gh_mirrors/ph/php-vcr

PHP-VCR Logo

1、项目介绍

PHP-VCR 是一个基于 PHP 的开源工具，灵感来源于 Ruby 的 VCR 库，用于在测试中记录和重播 HTTP 交互，以实现快速、确定性和精确的测试。通过这个库，你可以让测试避免实际的网络延迟，提升测试效率，并保证测试的一致性。

2、项目技术分析

PHP-VCR 支持多种常见的 HTTP 功能和扩展：

使用 streamWrapper（如 fopen()、file_get_contents() 等）无需任何修改即可直接工作。
自动支持 SoapClient，只需在 tests/bootstrap.php 中添加 \VCR\VCR::turnOn();
集成 curl()，同样只需在 tests/bootstrap.php 添加 \VCR\VCR::turnOn();

此外，它还具备以下特性：

可配置的请求匹配机制，基于 HTTP 方法、URI、主机、路径、正文和头部等进行匹配。
通过设置记录模式，可以控制哪些请求被拦截并允许执行。
存储和读取已记录的请求和响应数据，支持 YAML 和 JSON 格式，并可自定义序列化器。
内置对 PHPUnit 注解的支持，方便单元测试。

3、项目及技术应用场景

PHP-VCR 主要适用于以下场景：

测试套件中的 HTTP API 客户端，例如调用外部 RESTful API 或 Web Service。
快速回归测试，特别是那些依赖网络资源但不需要实时数据的测试。
想要模拟特定网络环境，如缓慢的网络连接或错误响应的情况。

4、项目特点

自动化录制与回放：开启 VCR 后，所有的 HTTP 请求都将被自动记录和重播，无需大量额外配置。
多响应管理：同个请求可以在不同测试中产生不同的响应，只需使用不同的“磁带”（cassettes）文件。
安全可控：通过设定记录模式，可防止未授权的 HTTP 请求发出。
高度定制：提供自定义请求匹配器和序列化器的接口，满足复杂需求。
易用性：支持 PHPUnit 注解，简化代码编写。
兼容性好：支持 PHP 8，并依赖 symfony/event-dispatcher、symfony/yaml 和 beberlei/assert 等库。

安装与使用示例

通过 Composer 安装：

composer require --dev php-vcr/php-vcr

然后在测试代码中使用：

// 开启 VCR
\VCR\VCR::turnOn();

// 插入“example”磁带
\VCR\VCR::insertCassette('example');

// 记录请求
$result = file_get_contents('http://example.com');
$this->assertNotEmpty($result);

// 关闭 VCR 并停止记录
\VCR\VCR::eject();
\VCR\VCR::turnOff();

或者利用 PHPUnit 注解：

/**
 * @vcr unittest_annotation_test
 */
public function testInterceptsWithAnnotations()
{
    // 请求被拦截并存储到 tests/fixtures/unittest_annotation_test
    $result = file_get_contents('http://google.com');
    
    $this->assertEquals('This is a annotation test dummy.', $result);
}