Web Config Custom Section

WebConfig Asp.Net tabanlı projelerde istemci tarafında ilk çalıştırılan XML tabanlı bir sayfadır diyebiliriz. İçerisinde bir çok bilgi barındırır ve bir istemci yani kullanıcı websitenize erişmeye çallıştığında ilk webconfig çalışır ve içerisinde set edilen bilgilere göre projenizi çalıştırır & ayağa kaldırır. Nedir bu bilgile diye soracak olursa;  Debug, Release mode ayarı, .Net Framework bilgisi, Varsa Database conn string bilgisi, Kullanılan .Net Kütüphanelerinin versiyon bilgileri, Uygulama Debug modda nasıl Release modda nasıl çalışacak bunun bilgisi, Site içi ve dışı yönlendirme ayarları vs. Görüldüğü üzre uygulama ile ilgili bir çok ayar mevcut kısacası uygulamanın configurasyonu ile ilgili sayısızca özellik & ayar set edilebilir. Bunun gibi ayarların dışında web.config içerisinde uygulama içi kullanılan çeşitli özel bilgiler & ayarlar da saklayabilir. Peki neden bu bilgileri burda saklıyoruz veya turuyoruz ?? Uygulamada Constant diye herhangi bir class oluşturup bunun içerisinde de tutabiliriz. Ama bu sefer ne olur derseniz. Orda tuttuğunuz bilgiyi değiştirmek için tekrardan projeyi açıp class içerisinde set edilen değeri değiştirip uygulamayı tekrardan ilgili yere deploy etmemiz gerekmekte. İşte aslında WeConfig bizi bu durumdan kurtarıyor. Webconfig dosyası deploy edildiği yerde projede ki tanımlı olduğu haliyle XML formatında tutuluyor yani uygulama içinde tanımlı olan class gibi dll'e çevrilip içini tekrardan açamayacağımız bir türde durum değil. Bu nedenle değişme olasılığı yüksek olan bilgileri WebConfig içerisinde tutup ihtiyaç duyulduğunda deploy edildiği dosyada ki folder e giderek çok rahat bir şekilde içini açıp ilgili ayarı değiştirebiliriz. Örnek olarak; uygulama kullanılan iletişim sayfasında ki email adresi veya uygulamaın herhangi bir yerinde kullanılan ve sonradan değiştirmeye açık olan bir text/metin.  <?xml version="1.0" encoding="utf-8" ?> <configuration> <system.web> <compilation defaultLanguage="c#" debug="true" /> </system.web> <appSettings> <add key="ContanctEmailAddress" value="info@canertosuner.com" /> </appSettings> </configuration> Yukarıda da görüldüğü gibi uygulama içerisinde yönetmek istediğimiz değerleri <appSettings> içerisinde unique bir key vererek value alanlarına değerleri set edebiliriz. Bu değeri code tarafından okumak istediğimizde de bilindiği üzre şu şekilde yapıyoruz; string emailAddress= ConfigurationSettings.AppSettings["ContactEmailAddress"]; Peki ya kendimiz aynı <appSettings> section'ı olduğu gibi bir custom secton yapmak istersek.. Case şu şekilde olsun. Kredi faizi hesaplayan bir uygulamamız var ve bu uygulamadaki faiz oranlarını webconfig den okuyup hesaplıyor. Aslında bu gibi bilgiler direkt olarak DB den de alınabilir ama bizim rojemizde webConfig den alalım.  1.Adım WebConfigde section tanımı yapma <configuration> <configSections> <section name="KrediFaizleri" type="MyProject.KrediFaizleriSection" /> </configSections> </configuration> Yukarıda da görültüğü gibi KrediFaizleri adında bir section ımızın olacağı bilgisini verdik.   2.Adım Section ve içerisindeki elementleri yazma </configSections>  tag'inin altında aşağıdaki gibi kodumuzu yazalım <KrediFaizleri> <Krediler> <add tip="ihtiyac" oran="1.65"/> <add tip="tasit" oran="1.96"/> <add tip="konut" oran="1.20"/> </Krediler> </KrediFaizleri> Burda Krediler diye bir array var ve içerisinde Kredi objesi olduğunu düşünelim. Bu obje içerisinde de tip ve oran adında 2 tane string property var. Aslında yukarıda ki xml kodunun tam karşılığı bu. Yukarıda 3 adet kredi için oran bilgisi girdik şimdi sırada bu değerleri webconfigden okumamızı sağlayacak C# kodlarını yazmaya geldi   3.Adım KrediFaizleri elementini tanımlama Yukarıda Krediler arrayinin içerisinde Kredi objesi olduğunu söylemiştik.Aslında bu bir element. Biz adına KrediFaizleriElement diyelim ve classımız aşağıdaki gibi olacaktır. public class KrediFaizleriElement : ConfigurationElement { [ConfigurationProperty("tip", IsKey = true, IsRequired = true)] public string KrediTipi { get { return (string)this["tip"]; } set { this["tip"] = value; } } [ConfigurationProperty("oran", IsKey = true, IsRequired = true)] public string Oran { get { return (string)this["oran"]; } set { this["oran"] = value; } } }   4.Adım KrediFaizleri array'ini tanımlama Bu adımda webconfig de ki array'i almamızı sağlayan ConfigurationElementCollection den türeyen bir class yazıyoruz. Bu class'ı kullanarak tanımladığımız section içerisinde ki collection'ı içerisindeki Element ler ile birlikte alıyoruz. [ConfigurationCollection(typeof(KrediFaizleriElement))] public class KrediFaizleriCollection : ConfigurationElementCollection { protected override ConfigurationElement CreateNewElement() { return new KrediFaizleriElement(); } protected override object GetElementKey(ConfigurationElement element) { return ((KrediFaizleriElement)element).KrediTipi; } }    5.Adım KrediFaizleriSection class ını oluşturma Fark ettiyseniz  en içten en dışa doğru ilerliyoruz. İlk olarak Element sonra Collection şimdide sırada Section var. Aşağıda yazılan KrediFaizleriSection webconfigde tanımladığımız KrediFaizleri tag'ini okumamızı sağlayacak olan class. İçerisinde Faizler array i var ve bu array'in içerisindede KrediFaizleriElement objeleri bulunacak. public class KrediFaizleriSection: ConfigurationSection { [ConfigurationProperty("KrediFaizleri", IsDefaultCollection = true)] public KrediFaizleriCollection Faizler { get { return (KrediFaizleriCollection )this["KrediFaizleri"]; } set { this["KrediFaizleri"] = value; } } }     Son Adım Webconfig de tanımlı değerleri okuma ve filtreleme işlemi. Bu adıma kadar şu sırayla lerledik; WebConfig de Section tanımlama, WebConfig de Section içerisindeki Collection ve Elementleri tanımlama, C# tarafında Element&Model class'ını oluşturma, C# tarafında Collection class'ını oluşturma, C# tarafında Section class'ını oluşturma, Şimdi ise sırada bu class ları kullanarak WebConfig de tanımlı değerleri okuma işlemi var. Bunun için aşağıdaki class ı kullanabiliriz.  public static KrediFaizleriElement KrediOranınıGetir(string krediTipi) { //KrediFaizleri section'nını içerisindeki elementler ile birlikte aldık var element= ConfigurationManager.GetSection("KrediFaizleriSection") as KrediFaizleriSection; //Paramaetre olarak verilen kredi tipine göre linq sorgusu yaptık var returnValue = element.Faizler.Cast<KrediFaizleriElement>().SingleOrDefault(c => c.KrediTipi== krediTipi); //İlgili kredi WebConfigde varmı kontrol ettik if (returnValue == null) throw new InvalidOperationException(string.Format("Kredi Tipi {0} bulunamadı !", krediTipi)); //Bulunan krediyi geri döndürdük return returnValue; } İşlemlerimiz bu kadar. KrediOranınıGetir metodunu gerekli yerde çağrısını yaparak kullanabiliriz.