はじめに

.NET10 Preview4 で、ZIP アーカイブの非同期処理が追加されました。

New async Zip APIs

var stream = new MemoryStream();
{
    await using var zip = await ZipArchive.CreateAsync(stream, ZipArchiveMode.Create, leaveOpen: true, entryNameEncoding: Encoding.UTF8);
    for (var n = 0; n < 5; n++)
    {
        var entry = zip.CreateEntry($"test{n}.txt");
        await using var entryStream = await entry.OpenAsync();
        using var writer = new StreamWriter(entryStream);
        writer.Write($"Hello, World! {n}");
    }
}

stream.Position = 0;
{
    await using var zip = await ZipArchive.CreateAsync(stream, ZipArchiveMode.Read, leaveOpen: false, entryNameEncoding: Encoding.UTF8);
    var got = new List<(string name, string content)>();
    foreach (var n in zip.Entries)
    {
        await using var entryStream = await n.OpenAsync();
        using var reader = new StreamReader(entryStream);
        var content = await reader.ReadToEndAsync();
        got.Add((n.FullName, content));
    }

    Assert.Equal([
        ("test0.txt","Hello, World! 0"),
        ("test1.txt","Hello, World! 1"),
        ("test2.txt","Hello, World! 2"),
        ("test3.txt","Hello, World! 3"),
        ("test4.txt","Hello, World! 4"),
    ], got);
}

テストコード

テストコード

using System.IO.Compression;
using System.Text;
using Xunit;

public class __NewAsyncZipAPIsTest
{
    [Fact]
    async Task HowToUse()
    {
        var stream = new MemoryStream();
        {
            await using var zip = await ZipArchive.CreateAsync(stream, ZipArchiveMode.Create, leaveOpen: true, entryNameEncoding: Encoding.UTF8);
            for (var n = 0; n < 5; n++)
            {
                var entry = zip.CreateEntry($"test{n}.txt");
                await using var entryStream = await entry.OpenAsync();
                using var writer = new StreamWriter(entryStream);
                writer.Write($"Hello, World! {n}");
            }
        }

        stream.Position = 0;
        {
            await using var zip = await ZipArchive.CreateAsync(stream, ZipArchiveMode.Read, leaveOpen: false, entryNameEncoding: Encoding.UTF8);
            var got = new List<(string name, string content)>();
            foreach (var n in zip.Entries)
            {
                await using var entryStream = await n.OpenAsync();
                using var reader = new StreamReader(entryStream);
                var content = await reader.ReadToEndAsync();
                got.Add((n.FullName, content));
            }

            Assert.Equal([
                ("test0.txt","Hello, World! 0"),
                ("test1.txt","Hello, World! 1"),
                ("test2.txt","Hello, World! 2"),
                ("test3.txt","Hello, World! 3"),
                ("test4.txt","Hello, World! 4"),
            ], got);
        }
    }

    async void HowToUse2()
    {
        // Extract a Zip archive
        await ZipFile.ExtractToDirectoryAsync("archive.zip", "destinationFolder", overwriteFiles: true);

        // Create a Zip archive
        await ZipFile.CreateFromDirectoryAsync("sourceFolder", "archive.zip", CompressionLevel.SmallestSize, includeBaseDirectory: true, entryNameEncoding: Encoding.UTF8);

        // Open an archive
        await using ZipArchive archive = await ZipFile.OpenReadAsync("archive.zip");
    }
}

つかいどころ

例えば今までだと画面 UI が固まるのを避けるために Task.Run() で実行していた圧縮ファイル関係の処理を、素直に書けるようになるかもしれません。
データ処理の部分をフロントに書くなという話なのですが、適当にコードを書くときはやったりします。
ストリームリーダーも非同期メソッドが用意されているのでうまいこと非同期処理を活用して Task.Run({...}) のネストをなくせば、コードが少し見やすくなるかもしれません。例外処理も簡単になります。

おわりに

ZipArchive は Preview1 でパフォーマンスが向上しています。世の中的に使用頻度が高そうなので優先度も高そうです。
Preview4 では GZipStream のパフォーマンス向上もあるようです。

.NET10 Preview4

関連
【C#】.NET10 Preview1 ｷﾀ━━(ﾟ∀ﾟ)━━!!
【C# .NET10 Preview1】値型の配列をスタックに作成する最適化の検証
 【C# .NET10 Preview2】参照型がスタックに置かれる最適化
 【C# .NET10 Preview3】null 条件付き代入
 【C# .NET10 Preview3】参照型の小さな配列のスタック割り当て
 【C# .NET10 Preview3】拡張メソッドの機能追加
 【C# .NET10 Preview4】try-finally をインライン化する最適化の追加