VCR项目中的preserve_exact_body_bytes配置详解-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00630/article/details/148488416

VCR项目中的preserve_exact_body_bytes配置详解

问题背景

在HTTP通信过程中，我们经常会遇到一些不符合规范的服务器响应。这些响应可能存在以下问题：

响应体的实际编码与HTTP头中声明的编码不一致
响应体包含不符合指定编码的字节数据
序列化/反序列化过程中编码信息丢失

这些问题会导致在使用VCR录制和回放HTTP交互时出现错误，因为YAML和JSON序列化器通常无法优雅地处理这些异常情况。

preserve_exact_body_bytes配置的作用

VCR提供了preserve_exact_body_bytes配置选项来解决这些问题。该配置允许开发者指定哪些请求或响应的正文应该以Base64编码形式保存，从而确保字节数据的精确保存。

为什么需要Base64编码？

Base64编码可以：

确保二进制数据的完整性
避免编码转换过程中的数据损坏
保留原始字节序列

但默认情况下VCR不启用此功能，因为Base64编码会降低录制文件的可读性。

配置方法

全局配置方式

可以在VCR的配置块中使用preserve_exact_body_bytes方法，传入一个判断逻辑块：

VCR.configure do |c|
  c.preserve_exact_body_bytes do |http_message|
    http_message.body.encoding.name == 'ASCII-8BIT' ||
    !http_message.body.valid_encoding?
  end
end

这个判断块接收一个HTTP消息对象(请求或响应)，返回true则表示该消息体应该使用Base64编码保存。

单个Cassette配置方式

如果只想对特定的Cassette启用此功能，可以在插入Cassette时指定选项：

VCR.use_cassette('example', :preserve_exact_body_bytes => true) do
  # HTTP交互代码
end

实际应用示例

处理无效编码的响应

当服务器返回包含无效编码字符的响应时：

string = "abc \xFA"  # 包含无效UTF-8字符
puts "Valid encoding: #{string.valid_encoding?}"  # 输出 false

VCR.configure do |c|
  c.preserve_exact_body_bytes do |http_message|
    http_message.body.encoding.name == 'ASCII-8BIT' ||
    !http_message.body.valid_encoding?
  end
end

录制后，Cassette文件会以Base64形式保存响应体：

"body": {
  "encoding": "ASCII-8BIT",
  "base64_string": "YWJjIPo=\n"
}

强制保留原始字节

即使响应编码有效，也可以强制保留原始字节：

VCR.use_cassette('preserve_bytes', :preserve_exact_body_bytes => true) do
  # 请求代码
end

与不保留字节的Cassette对比：

// 保留字节的Cassette
"body": {
  "encoding": "US-ASCII",
  "base64_string": "SGVsbG8gV29ybGQ=\n"
}

// 不保留字节的Cassette
"body": {
  "encoding": "US-ASCII",
  "string": "Hello World"
}