Setara dengan 'app.config' untuk perpustakaan (DLL)

Apakah ada yang setara dengan app.configuntuk perpustakaan (DLL)? Jika tidak, apa cara termudah untuk menyimpan pengaturan konfigurasi yang khusus untuk perpustakaan? Harap pertimbangkan bahwa perpustakaan dapat digunakan dalam aplikasi yang berbeda.

Anda dapat memiliki file konfigurasi terpisah, tetapi Anda harus membacanya "secara manual", ConfigurationManager.AppSettings["key"]hanya akan membaca konfigurasi dari unit yang sedang berjalan.

Dengan asumsi Anda menggunakan Visual Studio sebagai IDE Anda, Anda dapat mengklik kanan proyek yang diinginkan → Tambah → Item baru → File Konfigurasi Aplikasi

Ini akan menambah App.configfolder proyek, menempatkan pengaturan Anda di sana di bawah <appSettings>bagian. Jika Anda tidak menggunakan Visual Studio dan menambahkan file secara manual, pastikan untuk memberikannya nama seperti itu: DllName.dll.config , jika tidak, kode di bawah ini tidak akan berfungsi dengan baik.

Sekarang untuk membaca dari file ini memiliki fungsi seperti itu:

string GetAppSetting(Configuration config, string key)
{
    KeyValueConfigurationElement element = config.AppSettings.Settings[key];
    if (element != null)
    {
        string value = element.Value;
        if (!string.IsNullOrEmpty(value))
            return value;
    }
    return string.Empty;
}

Dan untuk menggunakannya:

Configuration config = null;
string exeConfigPath = this.GetType().Assembly.Location;
try
{
    config = ConfigurationManager.OpenExeConfiguration(exeConfigPath);
}
catch (Exception ex)
{
    //handle errror here.. means DLL has no sattelite configuration file.
}

if (config != null)
{
    string myValue = GetAppSetting(config, "myKey");
    ...
}

Anda juga harus menambahkan referensi ke namespace System.Configuration agar kelas ConfigurationManager tersedia.

Saat membangun proyek, selain DLL Anda akan memiliki DllName.dll.configfile juga, itu file yang Anda harus publikasikan dengan DLL itu sendiri.

Di atas adalah kode sampel dasar, bagi mereka yang tertarik pada contoh skala penuh, silakan merujuk ke jawaban lain ini .

Sayangnya, Anda hanya dapat memiliki satu file app.config per executable, jadi jika Anda memiliki DLL yang ditautkan ke aplikasi Anda, mereka tidak dapat memiliki file app.config mereka sendiri.

Solusinya adalah: Anda tidak perlu meletakkan file App.config dalam proyek Perpustakaan Kelas.
Anda meletakkan file App.config di aplikasi yang mereferensikan dll perpustakaan kelas Anda.

Sebagai contoh, katakanlah kita memiliki perpustakaan kelas bernama MyClasses.dll yang menggunakan file app.config seperti:

string connect = 
ConfigurationSettings.AppSettings["MyClasses.ConnectionString"];

Sekarang, katakanlah kita memiliki Aplikasi Windows bernama MyApp.exe yang mereferensikan MyClasses.dll. Ini akan berisi App.config dengan entri seperti:

<appSettings>
    <add key="MyClasses.ConnectionString"
         value="Connection string body goes here" />
</appSettings>

ATAU

File xml setara dengan yang terbaik untuk app.config. Gunakan xml serialisasi / deserialize sesuai kebutuhan. Anda dapat menyebutnya apa yang Anda inginkan. Jika konfigurasi Anda "statis" dan tidak perlu diubah, Anda juga bisa menambahkannya ke proyek sebagai sumber daya yang disematkan.

Semoga ini memberikan beberapa Ide

File konfigurasi adalah aplikasi-lingkup dan bukan ruang-perakitan. Jadi, Anda harus meletakkan bagian konfigurasi perpustakaan Anda di file konfigurasi setiap aplikasi yang menggunakan perpustakaan Anda.

Yang mengatakan, itu bukan praktik yang baik untuk mendapatkan konfigurasi dari file konfigurasi aplikasi, khususnya appSettingsbagian, di perpustakaan kelas. Jika pustaka Anda membutuhkan parameter, mereka mungkin harus dilewatkan sebagai argumen metode dalam konstruktor, metode pabrik, dll. Oleh siapa pun yang memanggil pustaka Anda. Ini mencegah panggilan aplikasi dari sengaja menggunakan kembali entri konfigurasi yang diharapkan oleh perpustakaan kelas.

Yang mengatakan, file konfigurasi XML sangat berguna, jadi kompromi terbaik yang saya temukan adalah menggunakan bagian konfigurasi khusus. Anda bisa meletakkan konfigurasi perpustakaan Anda dalam file XML yang secara otomatis dibaca dan diuraikan oleh kerangka kerja dan Anda menghindari potensi kecelakaan.

Anda dapat mempelajari lebih lanjut tentang bagian konfigurasi khusus di MSDN dan juga Phil Haack memiliki artikel yang bagus tentang mereka.

public class ConfigMan
{
    #region Members

    string _assemblyLocation;
    Configuration _configuration;

    #endregion Members

    #region Constructors

    /// <summary>
    /// Loads config file settings for libraries that use assembly.dll.config files
    /// </summary>
    /// <param name="assemblyLocation">The full path or UNC location of the loaded file that contains the manifest.</param>
    public ConfigMan(string assemblyLocation)
    {
        _assemblyLocation = assemblyLocation;
    }

    #endregion Constructors

    #region Properties

    Configuration Configuration
    {
        get
        {
            if (_configuration == null)
            {
                try
                {
                    _configuration = ConfigurationManager.OpenExeConfiguration(_assemblyLocation);
                }
                catch (Exception exception)
                {
                }
            }
            return _configuration;
        }
    }

    #endregion Properties

    #region Methods

    public string GetAppSetting(string key)
    {
        string result = string.Empty;
        if (Configuration != null)
        {
            KeyValueConfigurationElement keyValueConfigurationElement = Configuration.AppSettings.Settings[key];
            if (keyValueConfigurationElement != null)
            {
                string value = keyValueConfigurationElement.Value;
                if (!string.IsNullOrEmpty(value)) result = value;
            }
        }
        return result;
    }

    #endregion Methods
}

Hanya untuk melakukan sesuatu, saya refactored jawaban teratas ke dalam kelas. Penggunaannya seperti:

ConfigMan configMan = new ConfigMan(this.GetType().Assembly.Location);
var setting = configMan.GetAppSetting("AppSettingsKey");

Jika Anda menambahkan Pengaturan ke proyek Pustaka Kelas di Visual Studio (Properti Proyek, Pengaturan), itu akan menambahkan file app.config ke proyek Anda dengan bagian UserSettings / applyatioNSettings yang relevan, dan nilai-nilai default untuk pengaturan ini dari Pengaturan Anda.pengaturan mengajukan.

Namun file konfigurasi ini tidak akan digunakan saat runtime - sebaliknya perpustakaan kelas menggunakan file konfigurasi aplikasi hostingnya.

Saya percaya alasan utama untuk menghasilkan file ini adalah agar Anda dapat menyalin / menempelkan pengaturan ke file konfigurasi aplikasi host.

Saat ini saya sedang membuat plugin untuk merek perangkat lunak ritel, yang sebenarnya adalah perpustakaan kelas .net. Sebagai persyaratan, setiap plugin perlu dikonfigurasi menggunakan file konfigurasi. Setelah sedikit riset dan pengujian, saya menyusun kelas berikut. Itu melakukan pekerjaan dengan sempurna. Perhatikan bahwa saya belum menerapkan penanganan pengecualian lokal dalam kasus saya karena, saya menangkap pengecualian di tingkat yang lebih tinggi.

Beberapa penyesuaian mungkin diperlukan untuk mendapatkan titik desimal yang benar, jika desimal dan ganda, tetapi berfungsi dengan baik untuk Info Culture saya ...

static class Settings
{
    static UriBuilder uri = new UriBuilder(Assembly.GetExecutingAssembly().CodeBase);
    static Configuration myDllConfig = ConfigurationManager.OpenExeConfiguration(uri.Path);
    static AppSettingsSection AppSettings = (AppSettingsSection)myDllConfig.GetSection("appSettings");
    static NumberFormatInfo nfi = new NumberFormatInfo() 
    { 
        NumberGroupSeparator = "", 
        CurrencyDecimalSeparator = "." 
    };

    public static T Setting<T>(string name)
    {
        return (T)Convert.ChangeType(AppSettings.Settings[name].Value, typeof(T), nfi);
    }
}

Contoh file App.Config

<add key="Enabled" value="true" />
<add key="ExportPath" value="c:\" />
<add key="Seconds" value="25" />
<add key="Ratio" value="0.14" />

Pemakaian:

  somebooleanvar = Settings.Setting<bool>("Enabled");
  somestringlvar = Settings.Setting<string>("ExportPath");
  someintvar =     Settings.Setting<int>("Seconds");
  somedoublevar =  Settings.Setting<double>("Ratio");

Penghargaan untuk Shadow Wizard & MattC

Menanggapi pertanyaan awal, saya biasanya menambahkan file konfigurasi dalam proyek pengujian saya sebagai tautan; Anda kemudian dapat menggunakan atribut DeploymentItem untuk menambahkan ke folder Keluar dari uji coba.

[TestClass]
[DeploymentItem("MyProject.Cache.dll.config")]
public class CacheTest
{
    .
    .
    .
    .
}

Menanggapi komentar bahwa Assemblies tidak dapat spesifik proyek, mereka dapat dan itu memberikan fleksibilitas yang luar biasa. saat bekerja dengan kerangka kerja IOC.

Saya menghadapi masalah yang sama dan menyelesaikannya dengan membuat kelas statis Parameterssetelah menambahkan File Konfigurasi Aplikasi ke proyek:

public static class Parameters
{
    // For a Web Application
    public static string PathConfig { get; private set; } =
        Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "web.config");

    // For a Class Library
    public static string PathConfig { get; private set; } =
        Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "bin", "LibraryName.dll.config");

    public static string GetParameter(string paramName)
    {
        string paramValue = string.Empty;

        using (Stream stream = File.OpenRead(PathConfig))
        {
            XDocument xdoc = XDocument.Load(stream);

            XElement element = xdoc.Element("configuration").Element("appSettings").Elements().First(a => a.Attribute("key").Value == paramName);
            paramValue = element.Attribute("value").Value;
        }

        return paramValue;
    }
}

Kemudian dapatkan parameter seperti ini:

Parameters.GetParameter("keyName");

majelis tidak memiliki file app.config sendiri. Mereka menggunakan file app.config dari aplikasi yang menggunakannya. Jadi, jika majelis Anda mengharapkan hal-hal tertentu dalam file konfigurasi, maka pastikan file konfigurasi aplikasi Anda memiliki entri-entri di sana.

Jika perakitan Anda digunakan oleh beberapa aplikasi, maka masing-masing aplikasi tersebut harus memiliki entri tersebut di file app.config mereka.

Apa yang saya sarankan Anda lakukan adalah mendefinisikan properti pada kelas dalam perakitan Anda untuk nilai-nilai tersebut misalnya

private string ExternalServicesUrl
{
  get
  {
    string externalServiceUrl = ConfigurationManager.AppSettings["ExternalServicesUrl"];
    if (String.IsNullOrEmpty(externalServiceUrl))
      throw new MissingConfigFileAppSettings("The Config file is missing the appSettings entry for: ExternalServicesUrl");
    return externalServiceUrl;
  }
}

Di sini, properti ExternalServicesUrl mendapatkan nilainya dari file konfigurasi aplikasi. Jika ada aplikasi yang menggunakan rakitan ini tidak memiliki pengaturan dalam file konfigurasi Anda akan mendapatkan pengecualian o Jelas ada sesuatu yang hilang.

MissingConfigFileAppSettings adalah Pengecualian khusus. Anda mungkin ingin melempar pengecualian yang berbeda.

Tentu saja desain yang lebih baik adalah agar metode kelas-kelas tersebut diberikan nilai-nilai tersebut sebagai parameter daripada mengandalkan pengaturan file konfigurasi. Dengan cara itu aplikasi yang menggunakan kelas-kelas ini dapat memutuskan dari mana dan bagaimana mereka memberikan nilai-nilai ini.

Gunakan tambah item yang ada, pilih konfigurasi aplikasi dari proyek dll. Sebelum mengklik add, gunakan panah bawah kecil di sebelah kanan tombol add untuk "add as link"

Saya melakukan ini sepanjang waktu di dev saya.

Pembukaan : Saya menggunakan NET 2.0;

Solusi yang diposting oleh Yiannis Leoussis dapat diterima tetapi saya memiliki beberapa masalah dengannya.

Pertama, static AppSettingsSection AppSettings = (AppSettingsSection)myDllConfig.GetSection("appSettings");pengembalian nol. Saya harus mengubahnya kestatic AppSettingSection = myDllConfig.AppSettings;

Maka return (T)Convert.ChangeType(AppSettings.Settings[name].Value, typeof(T), nfi);tidak memiliki tangkapan untuk Pengecualian. Jadi saya sudah mengubahnya

try
{
    return (T)Convert.ChangeType(AppSettings.Settings[name].Value, typeof(T), nfi);
}
catch (Exception ex)
{
    return default(T);
}

Ini bekerja sangat baik tetapi jika Anda memiliki dll yang berbeda, Anda harus menulis ulang setiap kali kode untuk setiap perakitan. Jadi, ini adalah versi saya untuk Kelas untuk instantiate setiap kali Anda butuhkan.

public class Settings
{
    private AppSettingsSection _appSettings;
    private NumberFormatInfo _nfi;

    public Settings(Assembly currentAssembly)
    {
        UriBuilder uri = new UriBuilder(currentAssembly.CodeBase);
        string configPath = Uri.UnescapeDataString(uri.Path);
        Configuration myDllConfig = ConfigurationManager.OpenExeConfiguration(configPath);
        _appSettings = myDllConfig.AppSettings;
        _nfi = new NumberFormatInfo() 
        { 
            NumberGroupSeparator = "", 
            CurrencyDecimalSeparator = "." 
        };
    }


    public T Setting<T>(string name)
    {
        try
        {
            return (T)Convert.ChangeType(_appSettings.Settings[name].Value, typeof(T), _nfi);
        }
        catch (Exception ex)
        {
            return default(T);
        }
    }
}

Untuk konfigurasi:

<add key="Enabled" value="true" />
<add key="ExportPath" value="c:\" />
<add key="Seconds" value="25" />
<add key="Ratio" value="0.14" />

Gunakan sebagai:

Settings _setting = new Settings(Assembly.GetExecutingAssembly());

somebooleanvar = _settings.Setting<bool>("Enabled");
somestringlvar = _settings.Setting<string>("ExportPath");
someintvar =     _settings.Setting<int>("Seconds");
somedoublevar =  _settings.Setting<double>("Ratio");

Sejauh yang saya ketahui, Anda harus menyalin + menempel bagian yang Anda inginkan dari perpustakaan .config ke dalam aplikasi .config file. Anda hanya mendapatkan 1 app.config per instance yang dapat dieksekusi.

Mengapa tidak menggunakan:

• [ProjectNamespace].Properties.Settings.Default.[KeyProperty] untuk C #
• My.Settings.[KeyProperty] untuk VB.NET

Anda hanya perlu memperbarui secara visual properti-properti tersebut pada waktu desain melalui:

[Solution Project]->Properties->Settings

gunakan dari konfigurasi harus sangat sangat mudah seperti ini:

var config = new MiniConfig("setting.conf");

config.AddOrUpdate("port", "1580");

if (config.TryGet("port", out int port)) // if config exist
{
    Console.Write(port);
}

untuk detail lebih lanjut lihat MiniConfig