ASP.NET Core'da ile Farklı Configuration Provider Geliştirme

ASP.NET Core ile oluşturmuş olduğunuz bir uygulamaya ait belli başlı ayarları olabilir. ASP.NET Core’da varsayılan olarak File Configuration Provider (INI, JSON ve XML dosyaları) kullanılmaktadır. Ancak bazı durumlarda ayarlarımızı farklı ortamlarda saklayıp yüklememiz gerekebilir. Örneğin Redis’te, Vault’ta veya environment variable’da (ortam değişkenleri) saklayabiliriz. Bu gibi durumlarda kendi configuration provider’ımızı geliştirmemiz gerekmektedir.

Bugün yapacağımız örnekte uygulama ayarlarını Redis’te tutup uygulama başlatılırken ayarların okunmasını sağlayacağız.

Öncelikle aşağıdaki komutla yeni bir ASP.NET Core uygulaması oluşturup metin editörümüzle veya IDE’mizle açalım.

dotnet new mvc -n AspNetCoreCustomConfigSample -o aspnetcore-custom-config-sample

Uygulamamız üzerinden Redis’e bağlanabilmek için StackExchange.Redis paketini kullanacağız. Aşağıdaki komutu yazarak ilgili paketi projemize referans olarak ekliyoruz.

dotnet add package StackExchange.Redis

Ayarlarımızı Redis üzerinde Settings ismindeki anahtarda tutacağız. İçeriği aşağıdaki gibi JSON yapıda olacaktır.

{
  "AppName": "Redis Configuration Sample",
  "AppVersion": "1.0.0"
}

Geliştireceğimiz sınıflar aşağıdaki gibi olacaktır:

• Configuration Provider
• Configuration Source
• Extension Methods

İlk önce Configuration Provider sınıfımızı geliştirmeye başlayacağız. RedisConfigurationProvider isminde bir sınıf oluşturalım ve içeriğini aşağıdaki gibi değiştirelim.

using aspnetcore_custom_config_sample.Model;
using Microsoft.Extensions.Configuration;
using Newtonsoft.Json;
using StackExchange.Redis;
 
namespace aspnetcore_custom_config_sample.Configuration
{
    public class RedisConfigurationProvider : ConfigurationProvider
    {
        private readonly string _redisHost;
 
        public RedisConfigurationProvider(string redisHost)
        {
            _redisHost = redisHost;
        }
 
        public override void Load()
        {
            var options = ConfigurationOptions.Parse(_redisHost);
            var connectionMultiplexer = ConnectionMultiplexer.Connect(options);
            var redisSettings = connectionMultiplexer.GetDatabase().StringGet("Settings");
            var settings = JsonConvert.DeserializeObject(redisSettings);
 
            Data.Add("AppName", settings.AppName);
            Data.Add("AppVersion", settings.AppVersion);
        }
    }
}

Yazmış olduğumuz Configuration Provider sınıfında base sınıftaki Load metodunu ezmekteyiz. Load metodunun içerisinde Redis’e bağlanarak ilgili ayarları okuyoruz ve yine base sınıftan gelen Data ismindeki Dictionary‘nin içeriğini dolduruyoruz.

İkinci adımda ise Configuration Source sınıfımızı geliştireceğiz. RedisConfigurationSource isminde bir sınıf ekliyoruz ve içeriğini aşağıdaki şekilde değiştiriyoruz.

using Microsoft.Extensions.Configuration;
 
namespace aspnetcore_custom_config_sample.Configuration
{
    public class RedisConfigurationSource : IConfigurationSource
    {
        private readonly string _redisHost;
 
        public RedisConfigurationSource(string redisHost)
        {
            _redisHost = redisHost;
        }
 
        public IConfigurationProvider Build(IConfigurationBuilder builder)
        {
            return new RedisConfigurationProvider(_redisHost);
        }
    }
}

Configuration Source sınıfımız IConfigurationSource sınıfından türemektedir. IConfigurationSource interface’i Build isminde bir metot bulundurmaktadır. Bu sınıf bir configuration provider’ı temsil etmek için bulunmaktadır. Bizim Configuration Source sınıfımız ise RedisConfigurationProvider’ı temsil etmektedir. Constructor metottan parametre olarak Redis sunucumuzun adresini almaktadır.

Şimdi sıra extension metotları geliştirmeye geldi. ConfigurationExtensions isminde bir sınıf oluşturarak içeriğini aşağıdaki şekilde değiştirelim.

using Microsoft.Extensions.Configuration;
 
namespace aspnetcore_custom_config_sample.Configuration
{
    public static class ConfigurationExtensions
    {
        public static IConfigurationBuilder AddRedisConfiguration(this IConfigurationBuilder configuration, string redisHost)
        {
            configuration.Add(new RedisConfigurationSource(redisHost));
            return configuration;
        }
    }
}

Bu sınıfımızın amacı ise IConfigurationBuilder tipindeki bir nesne örneğine Configuration Source sınıfımızın nesne örneğini eklemektedir. Bu sayede ASP.NET Core uygulamamız artık Redis’ten uygulama ayarlarımızı okuyabilecek hale gelecektir.

Son adım olarak extension metodumuzu kullanmak kaldı. Bunun için Program.cs dosyamızı aşağıdaki şekilde değiştiriyoruz.

using aspnetcore_custom_config_sample.Configuration;
using Microsoft.AspNetCore;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
 
namespace AspNetCoreCustomConfigSample
{
    public class Program
    {
        public static void Main(string[] args)
        {
            BuildWebHost(args).Run();
        }
 
        public static IWebHost BuildWebHost(string[] args) =>
            WebHost.CreateDefaultBuilder(args)
                .ConfigureAppConfiguration(AddRedisConfiguration)
                .UseUrls("http://localhost:5000")
                .UseStartup()
                .Build();
 
        private static void AddRedisConfiguration(WebHostBuilderContext context, IConfigurationBuilder builder)
        {
            var configuration = builder.Build();
            builder.AddRedisConfiguration("localhost");
        }
    }
}

ConfigureAppConfiguration metodu parametre olarak bir delegate almaktadır. Delegate ettiğimiz metot ile AddRedisConfiguration extension metodunu kullanarak ASP.NET Core’un uygulamamız yüklenirken ayarlarımızı Redis’ten okumasını sağladık.

Şimdi ayarlarımızı okumaya geldi. Ayarlarımızı örnek olması açısından HomeController üzerinden okuyacağız. HomeController’ın içeriğini aşağıdaki şekilde değiştiriyoruz.

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using AspNetCoreCustomConfigSample.Models;
using aspnetcore_custom_config_sample.Model;
using Microsoft.Extensions.Options;
using Microsoft.Extensions.Configuration;
 
namespace AspNetCoreCustomConfigSample.Controllers
{
    public class HomeController : Controller
    {
        private readonly IConfiguration _appSettings;
 
        public HomeController(IConfiguration config)
        {
            _appSettings = config;
        }
 
        public IActionResult Index()
        {
            ViewBag.AppName = _appSettings.GetSection("AppName").Value;
            ViewBag.AppVersion = _appSettings.GetSection("AppVersion").Value;
 
            return View();
        }
    }
}

Dependency Injection yardımıyla IConfiguration tipinde bir nesne örneği alıyoruz. Index action’ında ise AppName ve AppVersion değerlerini okuyarak ViewBag‘lere atıyoruz. AppName ve AppVersion isimleri ise Configuration Provider sınıfımızda Data Dictionary‘sine eklemiş olduğumuz anahtar alanlardır.

Son olarak Home/Index.cshtml dosyamızı aşağıdaki şekilde düzenliyoruz.

@{
    ViewData["Title"] = "Home Page";
}
 
<h1>@ViewBag.AppName</h1>
<h2>@ViewBag.AppVersion</h2>

Uygulamızı tarayıcımızla ile açtığımızda aşağıdaki ekran görüntüsünü görmekteyiz.

Örnek proje dosyalarına https://github.com/mennan/aspnetcore-custom-config-sample adresinden ulaşabilirsiniz.