Membaca pengaturan dari app.config atau web.config di .NET

Saya sedang mengerjakan pustaka kelas C # yang harus dapat membaca pengaturan dari file web.configatau app.config(tergantung pada apakah DLL dirujuk dari aplikasi web ASP.NET atau aplikasi Windows Forms).

Saya telah menemukan itu

ConfigurationSettings.AppSettings.Get("MySetting")

berfungsi, tetapi kode itu telah ditandai sebagai usang oleh Microsoft.

Saya telah membaca bahwa saya harus menggunakan:

ConfigurationManager.AppSettings["MySetting"]

Namun, System.Configuration.ConfigurationManagerkelas sepertinya tidak tersedia dari proyek Perpustakaan C # Class.

Apa cara terbaik untuk melakukan ini?

Anda harus menambahkan referensi ke System.Configurationdalam folder referensi proyek Anda .

Anda pasti harus menggunakan ConfigurationManagerlebih dari usang ConfigurationSettings.

Untuk contoh file app.config seperti di bawah ini:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <appSettings>
    <add key="countoffiles" value="7" />
    <add key="logfilelocation" value="abc.txt" />
  </appSettings>
</configuration>

Anda membaca pengaturan aplikasi di atas menggunakan kode yang ditunjukkan di bawah ini:

using System.Configuration;

Anda mungkin juga perlu menambahkan referensi ke System.Configurationdalam proyek Anda jika belum ada. Anda kemudian dapat mengakses nilai-nilai seperti ini:

string configvalue1 = ConfigurationManager.AppSettings["countoffiles"];
string configvalue2 = ConfigurationManager.AppSettings["logfilelocation"];

Pembaruan untuk .NET Framework 4.5 dan 4.6; berikut ini tidak lagi berfungsi:

string keyvalue = System.Configuration.ConfigurationManager.AppSettings["keyname"];

Sekarang akses kelas Pengaturan melalui Properti:

string keyvalue = Properties.Settings.Default.keyname;

Lihat Mengelola Pengaturan Aplikasi untuk informasi lebih lanjut.

Klik kanan pada perpustakaan kelas Anda, dan pilih opsi "Tambahkan Referensi" dari Menu.

Dan dari tab .NET, pilih System.Configuration. Ini akan termasuk file System.Configuration DLL ke proyek Anda.

Saya menggunakan ini, dan itu berfungsi dengan baik untuk saya:

textBox1.Text = ConfigurationManager.AppSettings["Name"];

Baca Dari Konfigurasi:

Anda harus menambahkan referensi ke konfigurasi:

1. Buka "Properties" di proyek Anda
2. Buka Tab "Pengaturan"
3. Tambahkan "Nama" dan "Nilai"

4. Dapatkan Nilai dengan menggunakan kode berikut:

   string value = Properties.Settings.Default.keyname;

Simpan ke konfigurasi:

   Properties.Settings.Default.keyName = value;
   Properties.Settings.Default.Save();

Anda harus menambahkan referensi ke unit System.Configuration ke proyek.

Anda mungkin menambahkan file App.config ke file DLL. App.Config hanya berfungsi untuk proyek yang dapat dieksekusi, karena semua file DLL mengambil konfigurasi dari file konfigurasi untuk file EXE yang sedang dieksekusi.

Katakanlah Anda memiliki dua proyek dalam solusi Anda:

• Dll
• Seseorang

Masalah Anda mungkin terkait dengan fakta bahwa Anda menyertakan file app.config ke SomeDLL dan bukan SomeExe. SomeDll dapat membaca konfigurasi dari proyek SomeExe.

Coba ini:

string keyvalue = System.Configuration.ConfigurationManager.AppSettings["keyname"];

Dalam file web.config ini harus menjadi struktur berikutnya:

<configuration>
<appSettings>
<add key="keyname" value="keyvalue" />
</appSettings>
</configuration>

Saya memiliki masalah yang sama. Cukup baca seperti ini: System.Configuration.ConfigurationSettings.AppSettings ["MySetting"]

web.configdigunakan dengan aplikasi web. web.configsecara default memiliki beberapa konfigurasi yang diperlukan untuk aplikasi web. Anda dapat memiliki web.configuntuk setiap folder di bawah aplikasi web Anda.

app.configdigunakan untuk aplikasi Windows. Ketika Anda membangun aplikasi di Visual Studio, itu akan secara otomatis diubah namanya menjadi <appname>.exe.configdan file ini harus dikirimkan bersama dengan aplikasi Anda.

Anda dapat menggunakan metode yang sama untuk memanggil app settingsnilai dari kedua file konfigurasi: System.Configuration.ConfigurationSettings.AppSettings ["Key"]

Ketika saya menemukan pendekatan terbaik untuk mengakses variabel pengaturan aplikasi secara sistematis dengan membuat kelas wrapper melalui System.Configuration seperti di bawah ini

public class BaseConfiguration
{
    protected static object GetAppSetting(Type expectedType, string key)
    {
        string value = ConfigurationManager.AppSettings.Get(key);
        try
        {
            if (expectedType == typeof(int))
                return int.Parse(value);
            if (expectedType == typeof(string))
                return value;

            throw new Exception("Type not supported.");
        }
        catch (Exception ex)
        {
            throw new Exception(string.Format("Config key:{0} was expected to be of type {1} but was not.",
                key, expectedType), ex);
        }
    }
}

Sekarang kita dapat mengakses variabel pengaturan yang diperlukan dengan nama kode keras menggunakan kelas lain seperti di bawah ini:

public class ConfigurationSettings:BaseConfiguration
{
    #region App setting

    public static string ApplicationName
    {
        get { return (string)GetAppSetting(typeof(string), "ApplicationName"); }
    }

    public static string MailBccAddress
    {
        get { return (string)GetAppSetting(typeof(string), "MailBccAddress"); }
    }

    public static string DefaultConnection
    {
        get { return (string)GetAppSetting(typeof(string), "DefaultConnection"); }
    }

    #endregion App setting

    #region global setting


    #endregion global setting
}

Saya sangat menyarankan Anda untuk membuat pembungkus untuk panggilan ini. Sesuatu seperti a ConfigurationReaderServicedan menggunakan injeksi ketergantungan untuk mendapatkan kelas ini. Dengan cara ini Anda dapat mengisolasi file konfigurasi ini untuk tujuan pengujian.

Jadi gunakan yang ConfigurationManager.AppSettings["something"];disarankan dan kembalikan nilai ini. Dengan metode ini Anda dapat membuat semacam pengembalian default jika tidak ada kunci yang tersedia di file .config.

Anda juga dapat menggunakan Formo :

Konfigurasi:

<appSettings>
    <add key="RetryAttempts" value="5" />
    <add key="ApplicationBuildDate" value="11/4/1999 6:23 AM" />
</appSettings>

Kode:

dynamic config = new Configuration();
var retryAttempts1 = config.RetryAttempts;                 // Returns 5 as a string
var retryAttempts2 = config.RetryAttempts(10);             // Returns 5 if found in config, else 10
var retryAttempts3 = config.RetryAttempts(userInput, 10);  // Returns 5 if it exists in config, else userInput if not null, else 10
var appBuildDate = config.ApplicationBuildDate<DateTime>();

Hanya untuk kelengkapan, ada opsi lain yang tersedia hanya untuk proyek web: System.Web.Configuration.WebConfigurationManager.AppSettings ["MySetting"]

Manfaat dari hal ini adalah tidak memerlukan referensi tambahan untuk ditambahkan, jadi mungkin lebih disukai untuk beberapa orang.

Langkah 1: Klik kanan pada tab referensi untuk menambahkan referensi.

Langkah 2: Klik pada tab Assemblies

Langkah 3: Cari 'System.Configuration'

Langkah 4: Klik OK.

Maka akan berhasil.

 string value = System.Configuration.ConfigurationManager.AppSettings["keyname"];

Saya selalu membuat antarmuka IConfig dengan properti typesafe dideklarasikan untuk semua nilai konfigurasi. Kelas implementasi Config kemudian membungkus panggilan ke System.Configuration. Semua panggilan System.Configuration Anda sekarang ada di satu tempat, dan jauh lebih mudah dan lebih bersih untuk memelihara dan melacak bidang mana yang sedang digunakan dan mendeklarasikan nilai standarnya. Saya menulis satu set metode pembantu pribadi untuk membaca dan mengurai tipe data umum.

Menggunakan IOC kerangka kerja Anda dapat mengakses IConfig ladang di mana saja aplikasi dalam Anda hanya lewat antarmuka untuk konstruktor kelas. Anda juga kemudian dapat membuat implementasi tiruan dari antarmuka IConfig dalam pengujian unit Anda sehingga sekarang Anda dapat menguji berbagai nilai konfigurasi dan kombinasi nilai tanpa perlu menyentuh file App.config atau Web.config Anda.

Solusi lain yang mungkin:

var MyReader = new System.Configuration.AppSettingsReader();
string keyvalue = MyReader.GetValue("keyalue",typeof(string)).ToString();

Saya telah mencoba menemukan perbaikan untuk masalah yang sama selama beberapa hari sekarang. Saya dapat menyelesaikan ini dengan menambahkan kunci di dalam tag pengaturan aplikasi di file web.config . Ini harus mengganti file .dll saat menggunakan helper.

<configuration>
    <appSettings>
        <add key="loginUrl" value="~/RedirectValue.cshtml" />
        <add key="autoFormsAuthentication" value="false"/>
    </appSettings>
</configuration>

Anda dapat menggunakan baris di bawah ini. Dalam kasus saya ini berfungsi: System.Configuration.ConfigurationSettings.AppSettings ["yourKeyName"]

Anda harus berhati-hati bahwa baris kode di atas juga merupakan versi lama dan sudah tidak digunakan lagi di perpustakaan baru.

ConfigurationManager bukanlah yang Anda butuhkan untuk mengakses pengaturan Anda sendiri.

Untuk melakukan ini, Anda harus menggunakan

{YourAppName}.Properties.Settings.{settingName}

Saya bisa mendapatkan pendekatan di bawah ini bekerja untuk proyek .NET Core:

Langkah:

1. Buat appsettings.json (format yang diberikan di bawah) di proyek Anda.
2. Selanjutnya buat kelas konfigurasi. Formatnya disediakan di bawah ini.

3. Saya telah membuat metode Login () untuk menunjukkan penggunaan Kelas Konfigurasi.

   Buat appsettings.json di proyek Anda dengan konten:

   {
     "Environments": {
       "QA": {
         "Url": "somevalue",
    "Username": "someuser",
         "Password": "somepwd"
     },
     "BrowserConfig": {
       "Browser": "Chrome",
       "Headless": "true"
     },
     "EnvironmentSelected": {
       "Environment": "QA"
     }
   }
   
   public static class Configuration
   {
       private static IConfiguration _configuration;
   
       static Configuration()
       {
           var builder = new ConfigurationBuilder()
               .AddJsonFile($"appsettings.json");
   
           _configuration = builder.Build();
   
       }
       public static Browser GetBrowser()
       {
   
           if (_configuration.GetSection("BrowserConfig:Browser").Value == "Firefox")
           {
               return Browser.Firefox;
           }
           if (_configuration.GetSection("BrowserConfig:Browser").Value == "Edge")
           {
               return Browser.Edge;
           }
           if (_configuration.GetSection("BrowserConfig:Browser").Value == "IE")
           {
               return Browser.InternetExplorer;
           }
           return Browser.Chrome;
       }
   
       public static bool IsHeadless()
       {
           return _configuration.GetSection("BrowserConfig:Headless").Value == "true";
       }
   
       public static string GetEnvironment()
       {
           return _configuration.GetSection("EnvironmentSelected")["Environment"];
       }
       public static IConfigurationSection EnvironmentInfo()
       {
           var env = GetEnvironment();
           return _configuration.GetSection($@"Environments:{env}");
       }
   
   }
   
   
   public void Login()
   {
       var environment = Configuration.EnvironmentInfo();
       Email.SendKeys(environment["username"]);
       Password.SendKeys(environment["password"]);
       WaitForElementToBeClickableAndClick(_driver, SignIn);
   }

Jika Anda membutuhkan / ingin menggunakan ConfigurationManagerkelas ...

Anda mungkin perlu memuat System.Configuration.ConfigurationManageroleh Microsoft melalui Manajer Paket NuGet

Alat-> Manajer Paket NuGet-> Kelola Paket NuGet untuk Solusi ...

Microsoft Documents

Satu hal yang patut dicatat dari dokumen ...

Jika aplikasi Anda membutuhkan akses hanya baca ke konfigurasinya sendiri, kami sarankan Anda menggunakan metode GetSection (String). Metode ini menyediakan akses ke nilai konfigurasi yang di-cache untuk aplikasi saat ini, yang memiliki kinerja lebih baik daripada kelas Konfigurasi.

Silakan periksa versi .NET yang sedang Anda kerjakan. Itu harus lebih tinggi dari 4. Dan Anda harus menambahkan perpustakaan sistem System.Configuration ke aplikasi Anda.

Ini sebuah contoh: App.config

<applicationSettings>
    <MyApp.My.MySettings>
        <setting name="Printer" serializeAs="String">
            <value>1234 </value>
        </setting>
    </MyApp.My.MySettings>
</applicationSettings>

Dim strPrinterName as string = My.settings.Printer