Opakované použití objektů s ObjectPool v ASP.NET Core

Od Günther Foidl, Steve Gordon a Samson Amaugo

Microsoft.Extensions.ObjectPool je součástí ASP.NET Core infrastruktury, která podporuje zachování skupiny objektů v paměti pro opětovné využití místo uvolnění objektů z paměti. Všechny statické a instanční metody v Microsoft.Extensions.ObjectPool jsou bezpečné pro přístup z více vláken.

Aplikace můžou chtít fond objektů používat, pokud jsou spravované objekty:

• Je nákladné přidělit nebo inicializovat.
• Představuje omezený prostředek.
• Používá se předvídatelně a často.

Například architektura ASP.NET Core používá fond objektů na některých místech k opakovanému použití StringBuilder instancí. StringBuilder přiděluje a spravuje vlastní vyrovnávací paměť pro ukládání charakterových dat. ASP.NET Core pravidelně používá StringBuilder k implementaci funkcí a jejich opakované použití poskytuje výhodu výkonu.

Poolování objektů ne vždy zlepší výkon.

• Pokud nejsou náklady na inicializaci objektu vysoké, obvykle trvá déle získat objekt ze zásobníku.
• Objekty spravované fondem nejsou uvolněny, dokud není fond uvolněn.

Sdružování objektů používejte pouze po shromáždění dat o výkonu pomocí realistických scénářů pro vaši aplikaci nebo knihovnu.

POZNÁMKA: ObjectPool neumisťuje limit počtu objektů, které přiděluje, umístí limit počtu objektů, které si zachová.

Koncepty fondu objektů

Když se použije DefaultObjectPoolProvider a T implementuje IDisposable:

• Položky, které se nevrátí do rezervního zásobníku, budou odstraněny.
• Když se fond odstraní pomocí DI, všechny položky ve fondu se vyřadí.

POZNÁMKA: Po likvidaci fondu:

• Volání Get vyvolá chybu ObjectDisposedException.
• Volání Return zlikviduje danou položku.

Důležité ObjectPool typy a rozhraní:

• ObjectPool<T> : Základní abstrakce fondu objektů. Slouží k získání a vrácení objektů.
• PooledObjectPolicy<T> : Implementujte to k přizpůsobení způsobu vytvoření objektu a jeho resetování při vrácení do fondu. Ten lze předat přímo do přímo vytvořeného fondu objektů.
• IResettable : Automaticky resetuje objekt při vrácení do fondu objektů.

Fond objektů lze v aplikaci použít několika způsoby:

• Vytvoření instance fondu
• Registrace fondu jako instance v Dependency Injection (DI)
• Registrace ObjectPoolProvider<> v DI a jeho používání jako továrny.

Jak používat ObjectPool

Zavolejte Get pro získání objektu a Return k vrácení objektu. Není nutné vracet všechny objekty. Pokud se objekt nevrátí, bude odstraněn z paměti.

Ukázka objektového poolu

Následující kód:

• Přidá ObjectPoolProvider do kontejneru injekce závislostí (DI).
• Implementuje rozhraní IResettable k automatickému vymazání obsahu vyrovnávací paměti při vrácení do fondu objektů.

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

POZNÁMKA: Pokud typ T fondu neimplementuje IResettable, lze vlastní PooledObjectPolicy<T> použít pro resetování stavu objektů před jejich vrácením do fondu.