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

Por Günther Foidl, Steve Gordone Samson Amaugo

Microsoft.Extensions.ObjectPool faz parte da infraestrutura ASP.NET Core que suporta manter 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.

Os aplicativos podem querer usar o pool de objetos se os objetos que estão sendo gerenciados forem:

• Caro para alocar/inicializar.
• Representam um recurso limitado.
• Usado de forma previsível e frequente.

Por exemplo, o framework ASP.NET Core utiliza o pool de objetos em algumas partes para reutilizar instâncias StringBuilder. StringBuilder aloca e gerencia seus próprios buffers para armazenar dados de caracteres. ASP.NET Core usa regularmente StringBuilder 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.

NOTA: O ObjectPool não coloca um limite no número de objetos que aloca, ele coloca um limite no número de objetos que retém.

Conceitos de ObjectPool

Quando DefaultObjectPoolProvider é usado e T implementa IDisposable:

• Os itens que não são devolvidos à piscina serão descartados.
• Quando a piscina é descartada pela DI, todos os itens da piscina são descartados.

NOTA: Depois de a piscina ser descartada:

• Chamar Get gera um ObjectDisposedException.
• Chamar Return elimina o item fornecido.

Tipos de ObjectPool e interfaces importantes:

• ObjectPool<T> : A abstração básica do pool de objetos. Usado para obter e devolver 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 a um pool de objetos.

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

• Instanciando um pool.
• Registrando um pool no de injeção de dependência (DI) como uma instância.
• Registar o ObjectPoolProvider<> no DI e utilizá-lo como recurso.

Como usar o ObjectPool

Chame Get para obter um objeto e Return para retornar o objeto. Não há necessidade de devolver todos os objetos. Se um objeto não for devolvido, será recolhido lixo.

Exemplo de ObjectPool

O seguinte código:

• Adiciona ObjectPoolProvider ao contêiner de de injeção de dependência (DI) do.
• Implementa a interface 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;
    }
}

NOTA: Quando o tipo agrupado T não implementa IResettable, então um PooledObjectPolicy<T> personalizado pode ser usado para redefinir o estado dos objetos antes que eles sejam retornados ao pool.