ASP.NET Core での ObjectPool によるオブジェクト再利用

作成者 : Günther Foidl、 Steve Gordon、 Samson Amaugo

Microsoft.Extensions.ObjectPool は、オブジェクトのガベージ コレクションを許可するのではなく、オブジェクトのグループをメモリに保持して再利用できるようにする ASP.NET Core インフラストラクチャの一部です。 Microsoft.Extensions.ObjectPool のすべての静的メソッドとインスタンス メソッド は、スレッド セーフです。

管理されているオブジェクトが次のような場合、オブジェクト プールを使用できます:

• 割り当て/初期化が高額になる。
• リソースが限られていることを表します。
• 予測的かつ頻繁に使用する

たとえば、ASP.NET Core フレームワークでは、StringBuilder インスタンスを再利用するために、いくつかの場所でオブジェクト プールを使用します。 StringBuilder によって、独自のバッファーを割り当て、管理し、文字データを保持します。 ASP.NET Core では定期的に StringBuilder を使用し、機能を実装します。それを再利用することでパフォーマンスの恩恵があります。

オブジェクト プーリングで常にパフォーマンスが向上するわけではありません。

• オブジェクトの初期化コストが高い場合を除き、通常、プールからオブジェクトを取得する方が遅くなります。
• プールによって管理されるオブジェクトは、プールが割り当て解除されるまで割り当て解除されません。

オブジェクト プーリングは、アプリまたはライブラリに現実的なシナリオを使用してパフォーマンス データを取得した後にのみ使用します。

注: ObjectPool では、割り当てるオブジェクト数に制限がありません。保持するオブジェクト数に制限があります。

ObjectPool の概念

DefaultObjectPoolProvider が使用され、T で IDisposable を実装する場合:

• プールに返されないアイテムは破棄されます。
• プールが DI によって破棄されると、プール内のすべての項目が破棄されます。

注: プールの破棄後:

• Get を呼び出すと ObjectDisposedException がスローされます。
• Return を呼び出すと所与の項目が破棄されます。

重要な ObjectPool 型とインターフェイス:

• ObjectPool<T> : 基本的なオブジェクト プール抽象化。 オブジェクトを取得して返すために使用します。
• PooledObjectPolicy<T> : これを実装し、オブジェクトの作成方法と、プールに返されるときのリセット方法をカスタマイズします。 これは直接構築されるオブジェクト プールに渡すことができます。
• IResettable : オブジェクト プールに戻ったときに、オブジェクトを自動的にリセットします。

ObjectPool は、次のような複数の方法でアプリで使用できます。

• プールをインスタンス化する。
• 依存関係の挿入 (DI) でプールをインスタンスとして登録する。
• DI で ObjectPoolProvider<> を登録し、ファクトリとしてそれを使用する。

ObjectPool の使用方法

Get を呼び出してオブジェクトを取得し、Return を呼び出してオブジェクトを返します。 すべてのオブジェクトを返す必要はありません。 オブジェクトを返されない場合、ガベージ コレクションが実行されます。

ObjectPool サンプル

コード例を次に示します。

• ObjectPoolProvider を 依存関係の挿入 (DI) コンテナーに追加します。
• オブジェクト プールに返されたときにバッファーの内容を自動的にクリアする IResettable インターフェイスを実装します。

using Microsoft.Extensions.DependencyInjection.Extensions;
using Microsoft.Extensions.ObjectPool;
using System.Security.Cryptography;

var builder = WebApplication.CreateBuilder(args);

builder.Services.TryAddSingleton<ObjectPoolProvider, DefaultObjectPoolProvider>();

builder.Services.TryAddSingleton<ObjectPool<ReusableBuffer>>(serviceProvider =>
{
    var provider = serviceProvider.GetRequiredService<ObjectPoolProvider>();
    var policy = new DefaultPooledObjectPolicy<ReusableBuffer>();
    return provider.Create(policy);
});

var app = builder.Build();

app.MapGet("/", () => "Hello World!");

// return the SHA256 hash of a word 
// https://localhost:7214/hash/SamsonAmaugo
app.MapGet("/hash/{name}", (string name, ObjectPool<ReusableBuffer> bufferPool) =>
{

    var buffer = bufferPool.Get();
    try
    {
        // Set the buffer data to the ASCII values of a word
        for (var i = 0; i < name.Length; i++)
        {
            buffer.Data[i] = (byte)name[i];
        }

        Span<byte> hash = stackalloc byte[32];
        SHA256.HashData(buffer.Data.AsSpan(0, name.Length), hash);
        return "Hash: " + Convert.ToHexString(hash);
    }
    finally
    {
        // Data is automatically reset because this type implemented IResettable
        bufferPool.Return(buffer); 
    }
});
app.Run();

public class ReusableBuffer : IResettable
{
    public byte[] Data { get; } = new byte[1024 * 1024]; // 1 MB

    public bool TryReset()
    {
        Array.Clear(Data);
        return true;
    }
}

メモ： プールされた型 T が IResettable を実装していない場合は、カスタム PooledObjectPolicy<T> を使用して、オブジェクトがプールに返される前に状態をリセットできます。