Konfigurációs fájlok

Megjegyzés: Az a technológia csak .NET Framework keretrendszerek esetén érhető el. .NET Core és .NET 5 alatt ezek nem támogatottak. .NET Core és .NET 5 alkalmazások esetén a beállítások mentése és betöltésére JSON fájlokat szoktak alkalmazni.

Minden érdekes program képes felhasználói beállítások tárolására valamilyen módon. Manapság a JSON vagy XML formátum a népszerű alkalmazások körében, mert ezen formátumok strukturáltan képesek objektumok leírására, ami ideálissá teszi őket objektum-orientált nyelven készült programokban történő felhasználásra. Egy hátránya a saját konfigurációs fájloknak, hogy ezek kezelésére (beolvasás, kiírás) kódot kell írnunk.

Azonban a .NET keretrendszer készítői gondoltak erre a problémára. Éppen ezért minden .NET szerelvény rendelkezhet egy konfigurációs fájllal, aminek a betöltése a szerelvénnyel együtt megtörténik. A beépített konfigurációs rendszer előnye, hogy könnyen tudunk vele beállításokat kezelni abban az esetben, ha csak egyszerű értékek, típusok tárolására van szükségünk.

Ha komplex struktúrák és osztályhierarchia tárolására van szükségünk, akkor érdemes saját XML vagy JSON alapú tároló formátumot készíteni.

A beépített konfigurációs lehetőség használatának első lépése, hogy a projektünk tulajdonságait megnyitjuk a Solution Explorer-ben, majd a Settings fülre megyünk.

Itt valószínűleg egy üzenet fogad majd bennünket, miszerint a project-hez még nincs konfigurációs fájl rendelve.

A feliratra kattintva létrejön a beállításokat tartalmazó .config kiterjesztésű fájl és megjelenik a szerkesztő. A Name oszlopban a beállítás nevét adhatjuk meg. Erre ugyanolyan megkötések vonatkoznak, mint a változónevekre.

A Type oszlopban a beállítás típusát tudjuk meghatározni. Itt lehetőségünk van saját típus meghatározására is, de ebben az esetben a Value értéket nem, vagy csak komplikáltan tudjuk megadni a szerkesztőben.

A Scope a beállítás hatókörét határozza meg. A User beállítás a felhasználók profiljában fog tárolódni, míg az Application scope-pal rendelkező beállítások az alkalmazás mellet található .config fájlból olvasódnak. Előbiek a program futása közben csak olvashatók, míg a User beállítások módosíthatóak is.

Az Application Scope beállításokat tipikusan webes alkalmazásoknál szokás alkalmazni, ahol egyszer kell konfigurálni a környezethez tartozó beállításokat.

A beállításokhoz C# kód is generálódik, amit a Settings osztály Default statikus változóján tudunk elérni. Ehhez a programunkból a Properties névteret kell használatba vennünk.

A Settings osztályban a beállításaink tulajdonságokként jelennek meg, amiket írni és olvasni tudunk. Az osztályon hívott Save() metódussal menteni tudjuk a beállításokat.

using pelda_config.Properties;
using System;

namespace PeldaConfig
{
    class Program
    {
        static void Main(string[] args)
        {
            int config = Settings.Default.Beallitas;

            Console.WriteLine("Beallitas értéke: {0}", config);

            ++Settings.Default.Beallitas;

            Settings.Default.Save();

            Console.ReadKey();
        }
    }
}

A program kimenete:

Beallitas értéke: 42

Következő futtatáskor:

Beallitas értéke: 43