使用System.Text.Json序列化JSON至GZipStream与MemoryStream的问题

1. 正确将压缩内容保存到本地文件 #

你的现有代码存在两个核心问题，导致生成的.gz文件无效：

• GZipStream仅调用Flush无法完成完整的压缩流程，必须等待其释放以完成压缩收尾
• 压缩完成后MemoryStream的读写指针停留在末尾，直接写入文件会导致空内容

修正后的完整代码：

// 1. 序列化并压缩到内存流
await using var memoryStream = new MemoryStream();
// 使用leaveOpen: true，确保GZipStream关闭时不销毁底层MemoryStream
await using (var gzipStream = new GZipStream(memoryStream, CompressionLevel.Optimal, leaveOpen: true))
{
    await JsonSerializer.SerializeAsync(gzipStream, myObject);
} // 此处gzipStream自动释放，完成压缩流程

// 2. 重置内存流的读写指针到起始位置
memoryStream.Seek(0, SeekOrigin.Begin);

// 3. 写入本地文件
await using var fileStream = new FileStream("output.gz", FileMode.Create, FileAccess.Write);
await memoryStream.CopyToAsync(fileStream);

2. 指定GZIP包内的文件名 #

.NET原生的GZipStream不直接支持设置压缩包内的文件名——标准GZIP格式允许在头部存储文件名，但GZipStream仅实现了基础压缩功能，未暴露元数据设置API。你有两种可行方案：

方案一：手动构建GZIP头部（原生实现） #

严格遵循GZIP格式规范，手动写入包含文件名的头部信息，再写入压缩内容：

await using var memoryStream = new MemoryStream();

// 手动写入GZIP头部（包含文件名）
var fileNameBytes = Encoding.UTF8.GetBytes("my-data.json");
memoryStream.WriteByte(0x1F); // GZip魔数1
memoryStream.WriteByte(0x8B); // GZip魔数2
memoryStream.WriteByte(0x08); // 压缩方法（DEFLATE）
memoryStream.WriteByte(0x08); // 标志位：包含文件名
memoryStream.WriteByte(0x00); // 修改时间（忽略，设为0）
memoryStream.WriteByte(0x00);
memoryStream.WriteByte(0x00);
memoryStream.WriteByte(0x00);
memoryStream.WriteByte(0x00); // 额外标志
memoryStream.WriteByte(0x03); // 操作系统标识（Unix）

// 写入文件名，末尾加0作为终止符
await memoryStream.WriteAsync(fileNameBytes);
await memoryStream.WriteAsync(new byte[] { 0 });

// 写入压缩内容
await using (var gzipStream = new GZipStream(memoryStream, CompressionLevel.Optimal, leaveOpen: true))
{
    await JsonSerializer.SerializeAsync(gzipStream, myObject);
}

// 重置指针后即可用于文件保存或S3上传
memoryStream.Seek(0, SeekOrigin.Begin);

方案二：使用第三方库（更简单可靠） #

使用成熟的压缩库SharpZipLib（NuGet包ICSharpCode.SharpZipLib），它直接支持设置GZIP的文件名元数据：

await using var memoryStream = new MemoryStream();
await using (var gzipOutputStream = new GZipOutputStream(memoryStream))
{
    // 设置压缩包内的目标文件名
    gzipOutputStream.SetFileName("my-data.json");
    await JsonSerializer.SerializeAsync(gzipOutputStream, myObject);
}

memoryStream.Seek(0, SeekOrigin.Begin);
// 后续可直接用于文件写入或S3上传

S3上传注意事项 #

无论采用哪种方案，将memoryStream传入S3的TransferUtility时，必须确保：

• 内存流的读写指针已重置到起始位置（Seek(0, SeekOrigin.Begin)）
• 所有流操作均已完成（异步操作需等待await结束）

内容的提问来源于stack exchange，提问作者Zdeněk