‫راهنمای جامع مدیریت تنظیمات در دات‌نت کور: IConfiguration, IOptions

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning"
    }
  },
  "MySettings": {
    "ApiKey": "abc-123",
    "MaxRetries": 3
  }
}

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Logging;

public class MyService
{
    private readonly IConfiguration _configuration;
    private readonly ILogger<MyService> _logger;

    public MyService(IConfiguration configuration, ILogger<MyService> logger)
    {
        _configuration = configuration;
        _logger = logger;
    }

    public void DoSomething()
    {
        string apiKey = _configuration["MySettings:ApiKey"];
        _logger.LogInformation($"API Key: {apiKey}");
    }
}

• ایمنی نوع (Type Safety) پایین: تمامی مقادیر به صورت رشته (string) خوانده می‌شوند و تبدیل نوع (type casting) دستی لازم است که می‌تواند منجر به خطاهای زمان اجرا (runtime errors) شود.
• عدم به‌روزرسانی خودکار: IConfiguration به طور پیش‌فرض، تغییرات در فایل‌های تنظیمات را در زمان اجرا منعکس نمی‌کند.
• وابستگی مستقیم: هر سرویسی که به IConfiguration وابسته است، به تمامی تنظیمات دسترسی دارد که این امر اصل تفکیک مسئولیت‌ها (Separation of Concerns) را نقض می‌کند.

public class MySettings
{
    public const string SectionName = "MySettings";
    public string ApiKey { get; set; }
    public int MaxRetries { get; set; }
}

builder.Services.Configure<MySettings>(
    builder.Configuration.GetSection(MySettings.SectionName));

using Microsoft.Extensions.Options;

public class MyService
{
    private readonly MySettings _settings;

    public MyService(IOptions<MySettings> settings)
    {
        _settings = settings.Value;
    }

    public void DoSomething()
    {
        string apiKey = _settings.ApiKey;
        // استفاده از مقادیر
    }
}

• <IOptionsSnapshot<T: این رابط، در هر درخواست وب (web request) یک "عکس لحظه‌ای" (snapshot) از تنظیمات را فراهم می‌کند. این بدان معناست که اگر فایل appsettings.json در حین اجرای برنامه تغییر کند، هر درخواست جدید، مقدار به‌روزرسانی شده را دریافت می‌کند. این رابط به طور خاص برای برنامه‌های وب مناسب است و به عنوان یک سرویس با عمر scoped ثبت می‌شود، بنابراین هر درخواست، نسخه‌ی مستقل و تازه‌ای از تنظیمات را دریافت می‌کند.
• <IOptionsMonitor<T: این رابط، برای سناریوهایی مانند سرویس‌های طولانی‌مدت (long-running services) یا تسک‌های پس‌زمینه (background tasks) که به به‌روزرسانی بلادرنگ (real-time updates) نیاز دارند، طراحی شده است. IOptionsMonitor به عنوان یک سرویس تک‌گانه (singleton) عمل کرده و همیشه آخرین مقدار تنظیمات را از طریق ویژگی CurrentValue ارائه می‌دهد. علاوه بر این، IOptionsMonitor به شما اجازه می‌دهد تا به تغییرات تنظیمات مشترک شوید و اقداماتی را در پاسخ به آن‌ها انجام دهید.

using Microsoft.Extensions.Options;

public class BackgroundWorker
{
    private readonly IOptionsMonitor<MySettings> _settingsMonitor;

    public BackgroundWorker(IOptionsMonitor<MySettings> settingsMonitor)
    {
        _settingsMonitor = settingsMonitor;
        _settingsMonitor.OnChange((updatedSettings, name) =>
        {
            // این کد در زمان تغییر تنظیمات اجرا می‌شود
            Console.WriteLine($"Settings changed. New API Key: {updatedSettings.ApiKey}");
        });
    }

    public void DoWorkContinuously()
    {
        // دسترسی به آخرین مقدار در هر لحظه
        string currentApiKey = _settingsMonitor.CurrentValue.ApiKey;
        // استفاده از currentApiKey
    }
}

• IConfiguration
• IOptions<T>
• IOptionsSnapshot<T>
• IOptionsMonitor<T>

• IOptionsSnapshot به طور خاص برای سناریوهای وب طراحی شده و در هر درخواست یک کپی تازه از تنظیمات را ارائه می‌دهد، که این امر به اطمینان از دریافت جدیدترین مقادیر در هر درخواست کمک می‌کند. IOptionsMonitor نیز از به‌روزرسانی پشتیبانی می‌کند اما به عنوان یک سرویس تک‌گانه (singleton) عمل کرده و برای سرویس‌های طولانی‌مدت مناسب‌تر است.