ASP.NET Core 中的 ObjectPool 重複使用物件

作者：Günther Foidl、Steve Gordon 和 Samson Amaugo

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。
• 呼叫 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> 來重設物件的狀態，再將其傳回集區。