ASP.NET Core에서 ObjectPool로 개체 다시 사용

귄터 포이들, 스티브 고든, 삼손 아마우고

Microsoft.Extensions.ObjectPool은 개체들이 가비지 수집되지 않고 메모리에 계속 남아 재사용될 수 있도록 지원하는 ASP.NET Core 인프라의 일부입니다. Microsoft.Extensions.ObjectPool의 모든 정적 및 인스턴스 메서드는 스레드로부터 안전합니다.

관리형 개체가 다음과 같은 경우 앱에서 개체 풀을 사용할 수 있습니다.

• 할당/초기화 비용이 많이 듭니다.
• 제한된 리소스를 나타냅니다.
• 예측 가능하고 자주 사용됩니다.

예를 들어 ASP.NET Core 프레임워크는 일부 위치에 있는 개체 풀을 사용하여 StringBuilder 인스턴스를 다시 사용합니다. StringBuilder는 문자 데이터를 보관할 자체 버퍼를 할당하고 관리합니다. ASP.NET Core는 정기적으로 StringBuilder를 사용하여 기능을 구현하고, 재사용으로 성능 이점을 제공합니다.

개체 풀링이 항상 성능을 향상시키는 것은 아닙니다.

• 개체의 초기화 비용이 높지 않으면 일반적으로 풀에서 개체를 얻는 것이 더 느립니다.
• 풀에서 관리하는 개체는 풀이 할당 해제될 때까지 할당이 해제되지 않습니다.

앱 또는 라이브러리에 대한 현실적인 시나리오를 사용하여 성능 데이터를 수집한 후에만 개체 풀링을 사용합니다.

참고: ObjectPool은 할당 개체 수에 제한을 두지 않고 보존 개체 수에 제한을 둡니다.

ObjectPool 개념

DefaultObjectPoolProvider가 사용되고 T가 IDisposable을 구현하는 경우:

• 풀에 반환되지 않는 항목은 삭제됩니다.
• DI에서 풀이 삭제되면 풀의 모든 항목이 삭제됩니다.

참고: 풀이 폐기된 후:

• Get을 호출하면 ObjectDisposedException이 throw됩니다.
• Return을 호출하면 지정된 항목이 삭제됩니다.

중요한 ObjectPool 형식 및 인터페이스:

• ObjectPool<T> : 기본 개체 풀 추상화입니다. 이 메서드는 개체를 얻고 반환하는 데 사용됩니다.
• PooledObjectPolicy<T> : 개체를 만드는 방법과 풀로 반환할 때 개체를 다시 설정하는 방법을 사용자 지정하도록 구현합니다. 직접 생성된 객체 풀에 이를 전달할 수 있습니다.
• IResettable : 개체 풀로 반환되면 개체를 자동으로 다시 설정합니다.

ObjectPool은 다음과 같은 여러 가지 방법으로 앱에서 사용할 수 있습니다.

• 풀을 생성합니다.
• DI(종속성 주입)에서 풀을 인스턴스로 등록합니다.
• DI에 ObjectPoolProvider<>를 등록하고 팩터리로 사용합니다.

ObjectPool을 사용하는 방법

Get을 호출하여 개체를 얻고 Return을 호출하여 개체를 반환합니다. 모든 개체를 반환할 필요가 없습니다. 개체가 반환되지 않으면 가비지 수집됩니다.

ObjectPool 예제

코드는 다음과 같습니다.

• ObjectPoolProvider를 DI(종속성 주입) 컨테이너에 추가합니다.
• 개체 풀로 IResettable 반환되는 경우 버퍼의 내용을 자동으로 지우는 인터페이스를 구현합니다.

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

참고: 풀된 형식 T 이 구현 IResettable되지 않는 경우 풀로 반환되기 전에 사용자 지정 PooledObjectPolicy<T> 을 사용하여 개체의 상태를 다시 설정할 수 있습니다.