Flutter视频处理插件dartvcr的使用

Flutter视频处理插件dartvcr的使用

DartVCR

DartVCR 是一个用于录制和回放 HTTP 交互的库，适用于测试套件。它基于 EasyPost 的的 EasyVCR for C# 转换而来。

安装

DartVCR 可以在 pub.dev 上找到。

pubspec.yaml
dependencies:
  dartvcr: ^<version>

使用示例

Step 1

运行你的测试套件本地针对真实的 HTTP 端点，在录制模式下进行

import 'package:dartvcr/dartvcr.dart';

// 创建一个处理 HTTP 交互的磁带
var cassette = Cassette("path/to/cassettes", "my_cassette");

// 使用磁带走创建 DartVCRClient
DartVCRClient client = DartVCRClient(cassette, Mode.record);

// 在任何需要 HTTP 调用的类中使用这个 DartVCRClient
var response = await client.post(Uri.parse('https://api.example.com/v1/users'));

实际的 HTTP 调用将被记录到磁带文件中。

Step 2

切换到回放模式：

import 'package:dartvcr/dartvcr.dart';

// 创建一个处理 HTTP 交互的磁带
var cassette = Cassette("path/to/cassettes", "my_cassette");

// 使用磁带走创建 DartVCRClient
DartVCRClient client = DartVCRClient(cassette, Mode.replay);

现在当测试运行时，不会进行真实的 HTTP 调用。相反，HTTP 响应将从磁带文件中回放。

可用模式

• Mode.auto: 如果有匹配的录制，则播放请求；否则录制新请求。（默认为 VCR 模式）
• Mode.record: 录制请求，包括覆盖任何现有的匹配录制。
• Mode.replay: 回放请求。如果找不到匹配的录制则会抛出异常。
• Mode.bypass: 不录制也不回放任何请求（客户端将像普通的 BaseClient 行为一样）。

特性

DartVCR 提供了许多特性，许多都可以通过 AdvancedOptions 类自定义。

隐私保护

隐藏敏感数据，如 API 密钥和认证令牌。

默认: 关闭

import 'package:dartvcr/dartvcr.dart';

var cassette = Cassette("path/to/cassettes", "my_cassette");

var censors = Censors().censorHeaderElementsByKeys(["authorization"]); // 隐藏 Authorization 头部
censors.censorBodyElements([CensorElement("table", caseSensitive: true)]); // 隐藏表格元素（区分大小写）在请求和响应体中

var advancedOptions = AdvancedOptions(censors: censors);

var client = DartVCRClient(cassette, Mode.record, advancedOptions: advancedOptions);

延迟

模拟回放录制请求时的延迟，可以指定延迟或原始请求持续时间。

默认: 无延迟

import 'package:dartvcr/dartvcr.dart';

var cassette = Cassette("path/to/cassettes", "my_cassette");

// 当回放时模拟原始请求持续时间的延迟（覆盖手动延迟）
// 当回放时模拟 1000 毫秒的延迟
var advancedOptions = AdvancedOptions(simulateDelay: true, manualDelay: 1000);

var client = DartVCRClient(cassette, Mode.replay, advancedOptions: advancedOptions);

过期日期

设置录制请求的过期日期，并 决定如何处理过期的录制。

默认: 无过期

import 'package:dartvcr/dartvcr.dart';

var cassette = Cassette("path/to/cassettes", "my_cassette");

// 如果录制是在 30 天前录制的，则认为是过期的
// 如果录制过期则抛出异常
var advancedOptions = AdvancedOptions(validTimeFrame: TimeFrame(days: 30), whenExpired: ExpirationAction.throwException);

var client = DartVCRClient(cassette, Mode.replay, advancedOptions: advancedOptions);

匹配规则

自定义确定录制请求是否与当前请求匹配的方式。

默认: 方法和完整 URL 必须匹配

import 'package:dartvcr/dartvcr.dart';

var cassette = Cassette("path/to/cassettes", "my_cassette");

// 匹配录制请求的 body 和特定 header
var matchRules = MatchRules().byBody().byHeader("x-my-header");
var advancedOptions = AdvancedOptions(matchRules: matchRules);

var client = DartVCRClient(cassette, Mode.replay, advancedOptions: advancedOptions);

VCR

除了可单独录制的 HttpClient 实例外，DartVCR 还提供了一个内置的 VCR，可以轻松地在多个磁带和/或模式之间切换。应用于 VCR 的的任何高级设置都将应用于使用 VCR 的 HttpClient 的每个请求。

import 'package:dartvcr/dartvcr.dart';

// 隐藏 api_key 查询参数
var advancedOptions = AdvancedOptions(
    censors: Censors().censorQueryElementsByKeys(["api_key"]));

// 创建一个应用了高级选项的 VCR
var vcr = VCR(advancedOptions: advanced_options);

// 创建一个磁带并将其添加到 VCR 中
var cassette = Cassette("path/to/cassettes", "my_cassette");
vcr.insert(cassette);

// 将 VCR 设置为录制模式
vcr.record();

// 获取配置为使用 VCR 的的客户端
var client = vcr.client;

// 发送请求

// 移除磁带从 VCR 中
vcr.eject();

示例代码

import 'package:dartvcr/dartvcr.dart';

Future<void> useClientDirectly() async {
  // 创建一个处理 HTTP 交互的磁带
  var cassette = Cassette("path/to/cassettes", "my_cassette");

  // 隐藏 api_key 查询参数对于所有由客户端录制的请求
  var advancedOptions = AdvancedOptions(
      censors: Censors().censorQueryElementsByKeys(["api_key"]));

  // 使用磁带走创建 DartVCRClient
  DartVCRClient client =
      DartVCRClient(cassette, Mode.record, advancedOptions: advanced_options);

  // 在任何需要 HTTP 调叫的类中使用这个 DartVCRClient
  await client.post(Uri.parse('https://api.example.com/v1/users'));
}

Future<void> useClientViaVCR() async {
  // 隐藏 api_key 查询参数对于所有由 VCR 录制的请求
  var advanced_options = AdvancedOptions(
      censors: Censors().censorQueryElementsByKeys(["api_key"]));

  // 创建一个应用了高级选项的 VCR
  var vcr = VCR(advanced_options: advanced_options);

  // 创建一个磁带并将其添加到 VCR 中
  var cassette = Cassette("path/to/cassettes", "my_cassette");
  vcr.insert(cassette);

  // 将 VCR 设置为录制模式
  vcr.record();

  // 获取配置为使用 VCR 的的客户端
  var client = vcr.client;

  // 发送请求
  await client.post(Uri.parse('https://api.example.com/v1/users'));

  // 移除磁带从 VCR 中
  vcr.eject();
}