ASP.NET Core'da ObjectPool ile nesne yeniden kullanımı

Tarafından Günther Foidl, Steve Gordon ve Samson Amaugo

Microsoft.Extensions.ObjectPool , nesnelerin çöp toplanmasına izin vermek yerine bir grup nesnenin yeniden kullanılmak üzere bellekte tutulmasını destekleyen ASP.NET Core altyapısının bir parçasıdır. içindeki Microsoft.Extensions.ObjectPool tüm statik ve örnek yöntemleri iş parçacığı açısından güvenlidir.

Yönetilen nesneler şunlarsa uygulamalar nesne havuzunu kullanmak isteyebilir:

• Ayırmak/başlatmak pahalıdır.
• Sınırlı bir kaynağı temsil eder.
• Tahmin edilebilir ve sık kullanılan.

Örneğin, ASP.NET Core çerçevesi örnekleri yeniden kullanmak StringBuilder için bazı yerlerde nesne havuzunu kullanır. StringBuilder karakter verilerini tutmak için kendi arabelleklerini ayırır ve yönetir. ASP.NET Core, özellikleri uygulamak için düzenli olarak kullanır StringBuilder ve bunları yeniden kullanmak bir performans avantajı sağlar.

Nesne havuzu her zaman performansı iyileştirmez:

• Bir nesnenin başlatma maliyeti yüksek olmadığı sürece, nesneyi havuzdan almak genellikle daha yavaştır.
• Havuz tarafından yönetilen nesneler, havuz kaldırılana kadar ayrılmaz.

Nesne havuzu oluşturmayı yalnızca uygulamanız veya kitaplığınız için gerçekçi senaryoları kullanarak performans verilerini topladıktan sonra kullanın.

NOT: ObjectPool, ayırdığı nesne sayısına bir sınır yerleştirmez, koruduğu nesne sayısına bir sınır yerleştirir.

ObjectPool kavramları

Ne zaman DefaultObjectPoolProvider kullanılır ve T uygulanır IDisposable:

• Havuza döndürülmeyen öğeler atılır.
• Havuz DI tarafından atıldığında havuzdaki tüm öğeler atılır.

NOT: Havuz atıldıktan sonra:

• Çağrısı Get bir ObjectDisposedExceptionoluşturur.
• Çağrısı Return , verilen öğeyi atılır.

Önemli ObjectPool türler ve arabirimler:

• ObjectPool<T> : Temel nesne havuzu soyutlaması. Nesneleri almak ve döndürmek için kullanılır.
• PooledObjectPolicy<T> : Bir nesnenin nasıl oluşturulduğunu ve havuza geri döndürülürken nasıl sıfırlanıp sıfırlanamını özelleştirmek için bunu uygulayın. Bu, doğrudan oluşturulacak bir nesne havuzuna geçirilebilir.
• IResettable : Nesne havuzuna döndürülürken nesneyi otomatik olarak sıfırlar.

ObjectPool bir uygulamada birden çok şekilde kullanılabilir:

• Havuz örneği oluşturma.
• Bağımlılık ekleme (DI) içinde bir havuzu örnek olarak kaydetme.
• 'yi ObjectPoolProvider<> DI'ye kaydetme ve fabrika olarak kullanma.

ObjectPool'u kullanma

Bir nesneyi almak ve Return nesneyi döndürmek için çağrısı Get yapın. Her nesneyi döndürme gereksinimi yoktur. Bir nesne döndürülmezse, çöp toplanır.

ObjectPool örneği

Aşağıdaki kod:

• Bağımlılık ekleme (DI) kapsayıcısına eklerObjectPoolProvider.
• Nesne havuzuna IResettable döndürülürken arabelleğin içeriğini otomatik olarak temizlemek için arabirimini uygular.

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

NOT: Havuza alınan tür T uygulamadığında IResettable, nesnelerin havuza döndürülmeden önce durumunu sıfırlamak için bir özel PooledObjectPolicy<T> kullanılabilir.