Objektwiederverwendung mit ObjectPool in ASP.NET Core

Von Günther Foidl, Steve Gordon und Samson Amaugo

Microsoft.Extensions.ObjectPool ist Teil der ASP.NET Core-Infrastruktur, wodurch eine Gruppe von Objekten zur Wiederverwendung im Speicher gehalten werden kann, anstatt sie per Garbage Collection zu bereinigen. Alle statischen Methoden und Instanzmethoden in Microsoft.Extensions.ObjectPool sind threadsicher.

Für Apps kann die Verwendung des Objektpools erwogen werden, wenn auf die verwalteten Objekte Folgendes zutrifft:

• Ihre Zuordnung/Initialisierung ist kostenintensiv.
• Sie stellen eine begrenzte Ressource dar.
• Sie werden vorhersagbar und häufig verwendet.

Das ASP.NET Core-Framework verwendet beispielsweise den Objektpool in manchen Bereichen zur Wiederverwendung von StringBuilder-Instanzen. StringBuilder weist eigene Puffer zu und verwaltet sie, um Zeichendaten zu speichern. ASP.NET Core nutzt regelmäßig StringBuilder, um Features zu implementieren, und deren Wiederverwendung bietet einen Leistungsvorteil.

Das Objektpooling verbessert nicht immer die Leistung:

• Sofern die Initialisierungskosten eines Objekts nicht hoch sind, dauert es in der Regel länger, das Objekt aus dem Pool abzurufen.
• Durch den Pool verwaltete Objekte werden erst wieder freigegeben, wenn der Pool freigegeben wird.

Setzen Sie das Objektpooling erst ein, nachdem Sie anhand realistischer Szenarien Leistungsdaten für Ihre App oder Bibliothek gesammelt haben.

HINWEIS: Der ObjectPool legt keinen Grenzwert für die Anzahl der von ihm zugewiesenen Objekte fest, sondern nur für die Anzahl der beibehaltenen Objekte.

ObjectPool-Konzepte

Wenn DefaultObjectPoolProvider verwendet wird und TIDisposable implementiert:

• Objekte, die nicht an den Pool zurückgegeben werden, werden verworfen.
• Wenn der Pool per Abhängigkeitsinjektion verworfen wird, werden alle Elemente im Pool verworfen.

HINWEIS: Nachdem der Pool verworfen wurde:

• Der Aufruf von Get löst eine ObjectDisposedException aus.
• Der Aufruf von Return verwirft das angegebene Element.

Wichtige ObjectPool-Typen und Schnittstellen:

• ObjectPool<T>: Die grundlegende Abstraktion des Objektpools. Wird verwendet, um Objekte abzurufen und zurückzugeben.
• PooledObjectPolicy<T>: Durch die Implementierung dieses Typs können Sie festlegen, wie ein Objekt erstellt und wie es zurückgesetzt wird, wenn es an den Pool zurückgegeben wird. Dies kann an einen Objektpool übergeben werden, der direkt konstruiert wird.
• IResettable: Setzt das Objekt automatisch zurück, wenn es an einen Objektpool zurückgegeben wird.

Der ObjectPool kann in einer App auf verschiedene Weise verwendet werden:

• Instanziieren eines Pools
• Registrieren eines Pools bei der Abhängigkeitsinjektion als Instanz
• Registrieren von ObjectPoolProvider<> bei der Abhängigkeitsinjektion und Verwendung als Factory

Verwenden von ObjectPool

Rufen Sie Get auf, um ein Objekt zu erhalten und Return, um das Objekt zurückzugeben. Es ist nicht erforderlich, jedes Objekt zurückzugeben. Wird ein Objekt nicht zurückgegeben, wird es per Garbage Collection bereinigt.

ObjectPool-Beispiel

Der folgende Code führt folgende Aktionen aus:

• Fügt ObjectPoolProvider dem Container für die Abhängigkeitsinjektion hinzu.
• Implementiert die IResettable-Schnittstelle, um den Inhalt des Puffers bei der Rückgabe an den Objektpool automatisch zu löschen.

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;
    }
}

HINWEIS: Wenn der gepoolte Typ T nicht IResettable implementiert, kann der Zustand der Objekte mit einer benutzerdefinierten PooledObjectPolicy<T> zurückgesetzt werden, bevor sie an den Pool zurückgegeben werden.