在C#中读取自定义配置文件(Framework 4.0)

时间:2011-06-14 10:00:45

标签: c# configuration configuration-files

我正在使用Framework 4.0在C#中开发一个应用程序。

在我的应用程序中,我想创建一个不是app.config文件的单独配置文件。配置文件包含我们为产品开发的自定义配置部分。

我不想使用configSource从app.config引用此文件。

我想在运行时加载它并阅读它的内容。

我的意思是log4net,它允许你在log4net.config文件中编写配置。

任何人都可以在不编写模仿框架中存在的代码的代码的情况下帮助如何做到这一点吗?

更新

基于 Kaido 的答案,我编写了实用程序类,它读取自定义配置文件,并且能够在文件系统上的文件发生更改时刷新Config内容。

此课程的用法如下:

  1. 获取配置文件内容

    // Create configuration reader that reads the files once
    var configFileReader = new CustomConfigurationFileReader("c:\\myconfig.config");
    var config = configFileReader.Config;
    
    // Do any action you want with the config object like:
    config.GetSection("my.custom.section");
    
    // or,
    var someVal = config.AppSettings.Settings["someKey"];
    
  2. 配置文件更改时获取通知

    // Create configuration reader that notifies when the configuraiton file changes
    var configFileReader = new CustomConfigurationFileReader("c:\\myconfig.config", true);
    
    // Register to the FileChanged event
    configFileReader.FileChanged += MyEventHandler;
    
    ...
    
    private void MyEventHanler(object sender, EventArgs e)
    {
         // You can safely access the Config property here, it is already contains the new content
    }
    
  3. 在代码中我使用PostSharp来验证构造函数输入参数,以验证日志文件是否为空并且文件是否存在。您可以更改代码以在代码中内联进行这些验证(尽管我建议使用PostSharp将应用程序分隔到各个方面)。

    以下是代码:

        using System;
        using System.Configuration;
        using System.IO;
        using CSG.Core.Validation;
    
        namespace CSG.Core.Configuration
        {
            /// <summary>
            /// Reads customer configuration file
            /// </summary>
            public class CustomConfigurationFileReader
            {
                // By default, don't notify on file change
                private const bool DEFAULT_NOTIFY_BEHAVIOUR = false;
    
                #region Fields
    
                // The configuration file name
                private readonly string _configFileName;
    
                /// <summary>
                /// Raises when the configuraiton file is modified
                /// </summary>
                public event System.EventHandler FileChanged;
    
                #endregion Fields
    
                #region Constructor
    
                /// <summary>
                /// Initialize a new instance of the CustomConfigurationFileReader class that notifies 
                /// when the configuration file changes.
                /// </summary>
                /// <param name="configFileName">The full path to the custom configuration file</param>
                public CustomConfigurationFileReader(string configFileName)
                    : this(configFileName, DEFAULT_NOTIFY_BEHAVIOUR)
                {            
                }        
    
                /// <summary>
                /// Initialize a new instance of the CustomConfigurationFileReader class
                /// </summary>
                /// <param name="configFileName">The full path to the custom configuration file</param>
                /// <param name="notifyOnFileChange">Indicate if to raise the FileChange event when the configuraiton file changes</param>
                [ValidateParameters]
                public CustomConfigurationFileReader([NotNull, FileExists]string configFileName, bool notifyOnFileChange)
                {
                    // Set the configuration file name
                    _configFileName = configFileName;
    
                    // Read the configuration File
                    ReadConfiguration();
    
                    // Start watch the configuration file (if notifyOnFileChanged is true)
                    if(notifyOnFileChange)
                        WatchConfigFile();
                }
    
                #endregion Constructor        
    
                /// <summary>
                /// Get the configuration that represents the content of the configuration file
                /// </summary>
                public System.Configuration.Configuration Config
                {
                    get;
                    set;
                }
    
                #region Helper Methods
    
                /// <summary>
                /// Watch the configuraiton file for changes
                /// </summary>
                private void WatchConfigFile()
                {
                    var watcher = new FileSystemWatcher(_configFileName);
                    watcher.Changed += ConfigFileChangedEvent;
                }
    
                /// <summary>
                /// Read the configuration file
                /// </summary>
                public void ReadConfiguration()
                {
                    // Create config file map to point to the configuration file
                    var configFileMap = new ExeConfigurationFileMap
                    {
                        ExeConfigFilename = _configFileName
                    };
    
                    // Create configuration object that contains the content of the custom configuration file
                    Config = ConfigurationManager.OpenMappedExeConfiguration(configFileMap, ConfigurationUserLevel.None);
                }        
    
                /// <summary>
                /// Called when the configuration file changed.
                /// </summary>
                /// <param name="sender"></param>
                /// <param name="e"></param>
                private void ConfigFileChangedEvent(object sender, FileSystemEventArgs e)
                {
                    // Check if the file changed event has listeners
                    if (FileChanged != null)
                        // Raise the event
                        FileChanged(this, new EventArgs());
                }
    
                #endregion Helper Methods
            }
        }
    

5 个答案:

答案 0 :(得分:19)

 // Map the roaming configuration file. This
      // enables the application to access 
      // the configuration file using the
      // System.Configuration.Configuration class
      ExeConfigurationFileMap configFileMap =
        new ExeConfigurationFileMap();
      configFileMap.ExeConfigFilename = 
        roamingConfig.FilePath;

      // Get the mapped configuration file.
      Configuration config =
        ConfigurationManager.OpenMappedExeConfiguration(
          configFileMap, ConfigurationUserLevel.None);

来自http://msdn.microsoft.com/en-us/library/system.configuration.configurationmanager.aspx

答案 1 :(得分:6)

过去我使用过Nini - http://nini.sourceforge.net/manual.php,它允许你在运行时读/写自定义配置文件(XML / Ini / Registry / .Config)。

希望这有帮助。

答案 2 :(得分:2)

我对配置的建议是创建自己的组件来阅读它 如果在某些时候您决定从其他来源(如数据库或Web服务)获取配置,它可能会简化开发。
这种抽象还可以帮助您模拟配置并提高可测试性(.NET框架根本不能很好地完成)。
如果您使用XML作为配置格式,我建议使用Linq to XML 它更易于阅读和使用来解析XML文件。

答案 3 :(得分:2)

您可以尝试Cinchoo framework以满足您的需求。它通过代码优先方法简化了开发工作。定义一个类,如下所示,

namespace HelloWorld
{
    #region NameSpaces

    using System;
    using Cinchoo.Core.Configuration;

    #endregion NameSpaces

    [ChoConfigurationSection("sample")]
    public class SampleConfigSection : ChoConfigurableObject
    {
        #region Instance Data Members (Public)

        [ChoPropertyInfo("name", DefaultValue="Mark")]
        public string Name;

        [ChoPropertyInfo("message", DefaultValue="Hello World!")]
        public string Message;

        #endregion
    }

    static void Main(string[] args)
    {
        SampleConfigSection sampleConfigSection = new SampleConfigSection();
        Console.WriteLine(sampleConfigSection.ToString());
    }

}

首次运行应用程序时,它将在[appexename] .xml文件中创建配置部分,如下所示。然后,将自动选择对此文件所做的任何更改

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <configSections>
    <section name="sample" type="Cinchoo.Core.Configuration.ChoNameValueSectionHandler, Cinchoo.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=b7dacd80ff3e33de" />
  </configSections>
  <sample>
    <add key="name" value="Mark" />
    <add key="message" value="Hello World!" />
  </sample>
</configuration>

答案 4 :(得分:0)

或者更轻松地使用NameValueCollection