‫بهبود عملکرد سریال‌سازی XML در مذاکره محتوا در ASP.NET با استفاده از RecyclableMemoryStream

Install-Package Microsoft.IO.RecyclableMemoryStream

public class ItemController : ControllerBase
{
    [HttpGet]
    public IActionResult GetItems()
    {
        var items = new List<Item>
        {
            new Item { Id = 1, Name = "Item 1" },
            new Item { Id = 2, Name = "Item 2" }
        };

        var serializer = new XmlSerializer(typeof(List<Item>));
        using var memoryStream = new MemoryStream();
        serializer.Serialize(memoryStream, items);
        memoryStream.Position = 0;

        return File(memoryStream, "application/xml");
    }
}

public class Item
{
    public int Id { get; set; }
    public string Name { get; set; }
}

public class ItemController : ControllerBase
{
    private readonly RecyclableMemoryStreamManager _streamManager;

    public ItemController()
    {
        _streamManager = new RecyclableMemoryStreamManager();
    }

    [HttpGet]
    public IActionResult GetItems()
    {
        var items = new List<Item>
        {
            new Item { Id = 1, Name = "Item 1" },
            new Item { Id = 2, Name = "Item 2" }
        };

        var serializer = new XmlSerializer(typeof(List<Item>));
        using var recyclableStream = _streamManager.GetStream();
        serializer.Serialize(recyclableStream, items);
        recyclableStream.Position = 0;

        return File(recyclableStream, "application/xml");
    }
}

1. کاهش تخصیص در LOH: با استفاده از استخرسازی، از تخصیص‌های بزرگ و پراکنده در حافظه جلوگیری می‌شود.
2. بهبود عملکرد جمع‌آوری زباله: تعداد دفعات اجرای جمع‌آوری زباله کاهش می‌یابد، زیرا حافظه به صورت مداوم بازیافت می‌شود.
3. افزایش مقیاس‌پذیری: در برنامه‌هایی با بار بالا، این روش به سرور اجازه می‌دهد درخواست‌های بیشتری را با منابع کمتر پردازش کند.

• تنظیمات استخر: می‌توانید اندازه بلوک‌ها و حداکثر ظرفیت استخر را با استفاده از پارامترهای RecyclableMemoryStreamManager تنظیم کنید. به عنوان مثال:

_streamManager = new RecyclableMemoryStreamManager(
    blockSize: 128 * 1024, // 128 KB
    largeBufferMultiple: 1024 * 1024, // 1 MB
    maximumBufferSize: 16 * 1024 * 1024); // 16 MB

• مدیریت منابع: همیشه از using استفاده کنید تا مطمئن شوید جریان‌ها به درستی آزاد می‌شوند و به استخر بازمی‌گردند.
• تست عملکرد: قبل از اعمال تغییرات در محیط تولید، عملکرد را با ابزارهایی مانند BenchmarkDotNet آزمایش کنید.

1. اشتراک استخر حافظه:
   • اگر چندین نمونه از RecyclableMemoryStreamManager ایجاد شود (مثلاً با طول عمر Transient یا Scoped)، هر نمونه یک استخر حافظه جداگانه خواهد داشت. این کار باعث تکه‌تکه شدن حافظه (Fragmentation) و افزایش مصرف حافظه می‌شود، زیرا هر استخر به صورت مستقل بلوک‌های حافظه را تخصیص و مدیریت می‌کند.
   • با استفاده از طول عمر Singleton، یک نمونه واحد از RecyclableMemoryStreamManager در کل برنامه به اشتراک گذاشته می‌شود و تمام درخواست‌ها از یک استخر حافظه مشترک استفاده می‌کنند. این رویکرد کارایی بیشتری دارد و از هدررفت منابع جلوگیری می‌کند.
2. پایداری حالت استخر:
   • استخر حافظه در RecyclableMemoryStreamManager با استفاده مداوم "گرم" می‌شود، به این معنی که بلوک‌های حافظه از قبل تخصیص داده‌شده و آماده استفاده هستند. اگر هر بار یک نمونه جدید ایجاد شود (مثلاً با Transient)، این مزیت از دست می‌رود و هر نمونه باید از ابتدا استخر خود را بسازد.
   • Singleton تضمین می‌کند که استخر حافظه در طول عمر برنامه پایدار باقی بماند و بهینه عمل کند.
3. مدیریت منابع:
   • RecyclableMemoryStreamManager به گونه‌ای طراحی شده که نیازی به Dispose کردن ندارد، زیرا خود یک شیء مدیریتی است و جریان‌های ایجادشده توسط آن (مانند RecyclableMemoryStream) را باید Dispose کرد. استفاده از Singleton این اطمینان را می‌دهد که یک نمونه مرکزی بدون نیاز به مدیریت دستی طول عمر، در دسترس باقی بماند.

public class Program
{
    public static void Main(string[] args)
    {
        var builder = WebApplication.CreateBuilder(args);

        // ثبت RecyclableMemoryStreamManager به عنوان Singleton
        builder.Services.AddSingleton<RecyclableMemoryStreamManager>();

        builder.Services.AddControllers();
        var app = builder.Build();
        app.UseRouting();
        app.MapControllers();
        app.Run();
    }
}

public class ItemController : ControllerBase
{
    private readonly RecyclableMemoryStreamManager _streamManager;

    public ItemController(RecyclableMemoryStreamManager streamManager)
    {
        _streamManager = streamManager;
    }

    [HttpGet]
    public IActionResult GetItems()
    {
        var items = new List<Item> { new Item { Id = 1, Name = "Item 1" } };
        var serializer = new XmlSerializer(typeof(List<Item>));
        using var stream = _streamManager.GetStream();
        serializer.Serialize(stream, items);
        stream.Position = 0;
        return File(stream, "application/xml");
    }
}

public class Item
{
    public int Id { get; set; }
    public string Name { get; set; }
}

1. چندین استخر با تنظیمات مختلف:
   • اگر برنامه شما نیاز به چندین نمونه از RecyclableMemoryStreamManager با تنظیمات مختلف (مثلاً blockSize یا maximumBufferSize متفاوت) دارد، استفاده از Singleton مناسب نیست. در این صورت، می‌توانید از الگوی Factory یا ثبت چندین سرویس با نام (Named Services) استفاده کنید.
   • مثال با Factory:

builder.Services.AddSingleton<Func<RecyclableMemoryStreamManager>>(_ => 
    () => new RecyclableMemoryStreamManager(
        blockSize: 64 * 1024,
        largeBufferMultiple: 512 * 1024,
        maximumBufferSize: 32 * 1024 * 1024));

public class ItemController : ControllerBase
{
    private readonly RecyclableMemoryStreamManager _streamManager;

    public ItemController(Func<RecyclableMemoryStreamManager> streamManagerFactory)
    {
        _streamManager = streamManagerFactory();
    }
}

1. کنترل دقیق‌تر طول عمر:
   • در موارد نادر که بخواهید استخر حافظه را در محدوده خاصی (مثلاً یک درخواست خاص) مدیریت کنید، می‌توانید از طول عمر Scoped استفاده کنید. اما این معمولاً توصیه نمی‌شود، زیرا مزایای استخرسازی را کاهش می‌دهد.
2. تست‌پذیری:
   • اگر برنامه شما نیاز به تست واحد (Unit Testing) دارد و می‌خواهید رفتار RecyclableMemoryStreamManager را در هر تست جدا کنید، ممکن است ترجیح دهید آن را به صورت دستی در تست‌ها ایجاد کنید تا از تزریق Singleton استفاده نکنید.