Reutilização de objeto com ObjectPool no ASP.NET Core

Por Günther Foidl, Steve Gordon e Samson Amaugo

Microsoft.Extensions.ObjectPool faz parte da infraestrutura do ASP.NET Core que dá suporte à manutenção de um grupo de objetos na memória para reutilização, em vez de permitir que os objetos sejam coletados como lixo. Todos os métodos estáticos e de instância em Microsoft.Extensions.ObjectPool são thread-safe.

Talvez os aplicativos queiram usar o pool de objetos se os objetos que estão sendo gerenciados forem:

• Caro para alocar/inicializar.
• Representa um recurso limitado.
• Usado previsivelmente e com frequência.

Por exemplo, a estrutura ASP.NET Core usa o pool de objetos em alguns locais para reutilizar instâncias do StringBuilder. StringBuilder aloca e gerencia seus próprios buffers para armazenar dados de caracteres. O ASP.NET Core usa StringBuilder regularmente para implementar recursos e reutilizá-los oferece um benefício de desempenho.

O pool de objetos nem sempre melhora o desempenho:

• A menos que o custo de inicialização de um objeto seja alto, geralmente é mais lento obter o objeto do pool.
• Os objetos gerenciados pelo pool não são desalocados até que o pool seja desalocado.

Use o pool de objetos somente depois de coletar dados de desempenho usando cenários realistas para seu aplicativo ou biblioteca.

OBSERVAÇÃO: o ObjectPool não coloca um limite no número de objetos alocados, coloca um limite no número de objetos que ele retém.

Conceitos de ObjectPool

Quando DefaultObjectPoolProvider é usado e T implementa IDisposable:

• Os itens que não forem retornados ao pool serão descartados.
• Quando o pool é descartado pela DI, todos os itens no pool são descartados.

OBSERVAÇÃO: depois que o pool é descartado:

• Chamar Get gera um ObjectDisposedException.
• Chamar Return descarta o item especificado.

Tipos e interfaces importantes do ObjectPool:

• ObjectPool<T>: a abstração básica do pool de objetos. Usado para obter e retornar objetos.
• PooledObjectPolicy<T>: implemente isso para personalizar como um objeto é criado e como ele é redefinido quando retornado ao pool. Isso pode ser passado para um pool de objetos que é construído diretamente.
• IResettable: redefine automaticamente o objeto quando retornado para um pool de objetos.

O ObjectPool pode ser usado em um aplicativo de várias maneiras:

• Instanciando um pool.
• Registrar um pool na Injeção de dependência(DI) como uma instância.
• Registrando o ObjectPoolProvider<> na DI e usando-o como uma fábrica.

Como usar ObjectPool

Chame Get para obter um objeto e Return para retornar o objeto . Não há nenhum requisito para retornar todos os objetos. Se um objeto não for retornado, ele será coletado como lixo.

Exemplo de ObjectPool

O seguinte código:

• Adiciona ObjectPoolProvider ao contêiner de Injeção de dependência(DI).
• Implementa a interface do IResettable para limpar automaticamente o conteúdo do buffer quando retornado ao pool de objetos.

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

OBSERVAÇÃO: Quando o tipo T em pool não implementa IResettable, um PooledObjectPolicy<T> personalizado pode ser usado para redefinir o estado dos objetos antes que eles sejam retornados ao pool.