🪄
C# の ReadOnlySpan で文字列操作を最適化する方法

2024/10/23に公開
バッチ処理の開発で大量かつ長い文字列の連続して操作する機会があり、パフォーマンスとメモリ効率の最適化について調査しました。この記事では、C#のReadOnlySpan<T>を活用して文字列操作のパフォーマンスを向上させる方法について、具体的なコード例とともに説明します。

 ReadOnlySpan<T>が重要な理由ReadOnlySpan<T>は、メモリ上の連続した領域を表す構造体であり、配列や文字列の一部をコピーせずに参照できます。これにより、以下のメリットが得られます。

メモリ効率の向上: 不要なメモリコピーを削減

ガベージコレクション（GC）の負荷軽減: 一時的なオブジェクトの生成を抑制

パフォーマンスの向上: データへの高速なアクセス

 ReadOnlySpan<T>のライフタイムと注意点ReadOnlySpan<T>は一時的なメモリ領域を指すため、そのライフタイムに注意が必要です。例えば、ReadOnlySpan<T>が指す元のデータがガベージコレクションによって回収されると、参照が無効になります。そのため、ReadOnlySpan<T>は元のデータが生存している間にのみ使用する必要があります。
※この記事のコード例では、元の文字列データがメソッド内で保持されているため、この問題は発生しません。

 従来の文字列操作の問題点まず、一般的な文字列操作がパフォーマンスにどのような影響を与えるかを再確認します。
string data = "ID:12345;Name:名無しの権兵衛;Age:30";

// コロンの位置を探して、その後の値を取得
int index = data.IndexOf("Name:");
string namePart = data.Substring(index + "Name:".Length);
int semicolonIndex = namePart.IndexOf(';');
string name = namePart.Substring(0, semicolonIndex);

Console.WriteLine(name); // 出力: 名無しの権兵衛
このコードでは、Substringメソッドを使用して文字列を分割しています。しかし、Substringは新しい文字列オブジェクトを生成するため、メモリ効率が悪く、GCの負荷も増加します。

 ReadOnlySpan<T>を使用した改善ReadOnlySpan<char>を使用すると、文字列をコピーせずに部分文字列を参照できます。
string data = "ID:12345;Name:名無しの権兵衛;Age:30";
ReadOnlySpan<char> dataSpan = data.AsSpan();

// コロンの位置を探して、その後の値を取得
int index = dataSpan.IndexOf("Name:");
ReadOnlySpan<char> nameSpan = dataSpan.Slice(index + "Name:".Length);
int semicolonIndex = nameSpan.IndexOf(';');
ReadOnlySpan<char> name = nameSpan.Slice(0, semicolonIndex);

Console.WriteLine(name.ToString()); // 出力: 名無しの権兵衛
このコードでは、新しい文字列オブジェクトを生成せずに、元の文字列内の部分を参照しています。

 APIとの互換性について既存のAPIの多くはstring型を受け取るため、ReadOnlySpan<T>からstringへの変換が必要になる場合があります。この際、ToString()メソッドを呼び出すことで新たな文字列オブジェクトが生成され、メモリ効率のメリットが減少する可能性があります。可能であれば、ReadOnlySpan<T>を受け取るオーバーロードが提供されているAPIを利用すると、さらなる効率化が可能です。

 メリットの詳細
 メモリ効率の向上ReadOnlySpan<T>はヒープ上にオブジェクトを生成しないため、一時的なメモリ使用量が減少します。これにより、大量の文字列操作が頻繁に発生する状況においても、メモリ使用量が抑えられます。

 GCへの影響の軽減一時的な文字列オブジェクトを生成しないため、GCが回収するオブジェクトの数が減少します。これにより、GCによるパフォーマンス低下を防げます。

 コピー操作の削減データをコピーせずに参照するため、CPU時間の節約にもなります。特に大きな文字列を扱う場合、この効果は大きくなります。

 パフォーマンス測定の重要性最適化の効果はケースバイケースであり、実際のアプリケーションでパフォーマンス測定を行うことが重要です。ReadOnlySpan<T>を使用することでオーバーヘッドが増える場面も稀にありますので、ベンチマークテストを行って効果を確認することが公式でもおすすめされています。

 実際の活用例
 ログ解析ツール大量のログファイルを解析するアプリケーションを考えてみます。
public void ProcessLog(string logLine)
{
    // 従来の方法
    string[] parts = logLine.Split(',');
    string timestamp = parts[0];
    string level = parts[1];
    string message = parts[2];
}
この方法では、Splitメソッドによって複数の文字列オブジェクトが生成されます。ReadOnlySpan<T>を使うと、以下のように最適化できます。
public void ProcessLog(ReadOnlySpan<char> logLine)
{
    int firstComma = logLine.IndexOf(',');
    var timestamp = logLine.Slice(0, firstComma);

    var rest = logLine.Slice(firstComma + 1);
    int secondComma = rest.IndexOf(',');
    var level = rest.Slice(0, secondComma);

    var message = rest.Slice(secondComma + 1);

    // 必要に応じて.ToString()で文字列に変換
}

 MemoryExtensionsの活用System.MemoryExtensionsクラスには、ReadOnlySpan<T>向けの便利な拡張メソッドが多数用意されています。例えば、Contains、StartsWith、EndsWith、Trimなどのメソッドがあります。これらを活用することで、ReadOnlySpan<T>を使った文字列操作がより簡単になります。
ReadOnlySpan<char> text = "Hello, World!".AsSpan();

if (text.StartsWith("Hello"))
{
    Console.WriteLine("挨拶が見つかりました。");
}

if (text.Contains("World"))
{
    Console.WriteLine("世界が見つかりました。");
}
これらの拡張メソッドを利用することで、コードの可読性と効率が向上します。

 ReadOnlySequence<T>の検討巨大なデータやストリームを扱う場合、ReadOnlySpan<T>だけでなく、ReadOnlySequence<T>の使用も検討すると良いとされています。これは複数のバッファにまたがるデータを効率的に処理するための型であり、System.IO.Pipelinesなどで活用されています。
以下の例では、PipeReaderを使って非同期にデータを読み込み、ReadOnlySequence<byte>で効率的に処理します。
using System;
using System.IO.Pipelines;
using System.Buffers;
using System.Text;
using System.Threading.Tasks;

public class SimplePipelineProcessor
{
    public async Task ProcessAsync(PipeReader reader)
    {
        while (true)
        {
            ReadResult result = await reader.ReadAsync();
            ReadOnlySequence<byte> buffer = result.Buffer;

            if (result.IsCompleted && buffer.Length == 0)
                break;

            foreach (var segment in buffer)
            {
                // 各セグメントを処理
                string text = Encoding.UTF8.GetString(segment.Span);
                Console.WriteLine(text);
            }

            // 読み取ったデータを消費したことを通知
            reader.AdvanceTo(buffer.End);
        }
    }
}

PipeReaderはストリームやソケットから非同期にデータを読み取ります。

ReadOnlySequence<byte>を使ってバッファ内のデータを効率的に処理し、メモリコピーを避けます。
各セグメントをReadOnlySpan<byte>として処理し、Encoding.UTF8.GetString()で文字列に変換しています。

 ファイルのパース大きなテキストファイルを行単位で読み込み、各行を解析する場合にも効果的です。
foreach (var line in File.ReadLines("data.txt"))
{
    ReadOnlySpan<char> lineSpan = line.AsSpan();
    // ReadOnlySpanを使用した解析処理
}

 C# 8.0 以降の機能の活用C# 8.0以降では、RangeやIndex構文が導入され、Spanと組み合わせることでコードをより簡潔にできます。
int semicolonIndex = nameSpan.IndexOf(';');
ReadOnlySpan<char> name = nameSpan[..semicolonIndex];
このように、Sliceメソッドの代わりに範囲指定を使うことで、コードの可読性が向上します。

 まとめReadOnlySpan<T>を使用することで、文字列操作のパフォーマンスを大幅に向上させることができます。メモリ効率の向上、GCへの影響の軽減、コピー操作の削減といったメリットは、特に大量のデータを扱うアプリケーションで大きくなります。ただし、最適化の効果はケースバイケースであるため、実際のアプリケーションでパフォーマンス測定を行うことが重要とのことでした。
既存のコードでも、SubstringやSplitなどのメソッドをReadOnlySpan<T>に置き換えることで、簡単に最適化が可能です。また、MemoryExtensionsや最新のC#機能を活用することで、さらに効率的で読みやすいコードを書くことができます。
今後もパフォーマンスセンシティブな開発する際には、ReadOnlySpan<T>の活用を検討したいと思います。

 参考資料Microsoft Docs: ReadOnlySpan<T> 構造体
System.MemoryExtensions クラス
C# 8.0 の新機能: インデックスと範囲
C# の ReadOnlySpan で文字列操作を最適化する方法

`ReadOnlySpan<T>`が重要な理由

`ReadOnlySpan<T>`のライフタイムと注意点

従来の文字列操作の問題点

ReadOnlySpan<T>を使用した改善

APIとの互換性について

メリットの詳細

メモリ効率の向上

GCへの影響の軽減

コピー操作の削減

パフォーマンス測定の重要性

実際の活用例

ログ解析ツール

`MemoryExtensions`の活用

ReadOnlySequence<T>の検討

ファイルのパース

C# 8.0 以降の機能の活用

まとめ

参考資料

Discussion
