如何在 app.config 中创建自定义配置部分？ [复制]

Posted 2023-03-04

【中文标题】如何在 app.config 中创建自定义配置部分？ [复制]

【英文标题】：How to create custom config section in app.config? [duplicate]

【发布时间】：2010-11-21 21:51:44

【问题描述】：

我想在我的app.config 文件中添加一个自定义配置部分。 有没有办法做到这一点，以及如何在我的程序中访问这些设置。 以下是我要添加到我的app.config 的配置部分：

<RegisterCompanies>
    <Companies>
      <Company name="Tata Motors" code="Tata"/>
      <Company name="Honda Motors" code="Honda"/>
    </Companies>
</RegisterCompanies>

【参考方案1】：

导入命名空间：

using System.Configuration;

创建 ConfigurationElement 公司：

public class Company : ConfigurationElement


        [ConfigurationProperty("name", IsRequired = true)]
        public string Name
        
            get
            
                return this["name"] as string;
            
        
            [ConfigurationProperty("code", IsRequired = true)]
        public string Code
        
            get
            
                return this["code"] as string;
            
        

配置元素集合：

public class Companies
        : ConfigurationElementCollection
    
        public Company this[int index]
        
            get
            
                return base.BaseGet(index) as Company ;
            
            set
            
                if (base.BaseGet(index) != null)
                
                    base.BaseRemoveAt(index);
                
                this.BaseAdd(index, value);
            
        

       public new Company this[string responseString]
       
            get  return (Company) BaseGet(responseString); 
            set
            
                if(BaseGet(responseString) != null)
                
                    BaseRemoveAt(BaseIndexOf(BaseGet(responseString)));
                
                BaseAdd(value);
            
        

        protected override System.Configuration.ConfigurationElement CreateNewElement()
        
            return new Company();
        

        protected override object GetElementKey(System.Configuration.ConfigurationElement element)
        
            return ((Company)element).Name;
        
    

和配置部分：

public class RegisterCompaniesConfig
        : ConfigurationSection
    

        public static RegisterCompaniesConfig GetConfig()
        
            return (RegisterCompaniesConfig)System.Configuration.ConfigurationManager.GetSection("RegisterCompanies") ?? new RegisterCompaniesConfig();
        

        [System.Configuration.ConfigurationProperty("Companies")]
            [ConfigurationCollection(typeof(Companies), AddItemName = "Company")]
        public Companies Companies
        
            get
            
                object o = this["Companies"];
                return o as Companies ;
            
        

    

您还必须在 web.config (app.config) 中注册新的配置部分：

<configuration>       
    <configSections>
          <section name="Companies" type="blablaNameSpace.RegisterCompaniesConfig, blablaAssemblyName" ..>

然后你加载你的配置

var config = RegisterCompaniesConfig.GetConfig();
foreach(var item in config.Companies)

   do something ..

【讨论】：

值得注意的是，如果您使用的是 MVC 应用程序，那么列出的部分就可以了。对于控制台应用程序、Web 服务，也许还有其他应用程序，您需要在“blablabla.RegisterCompaniesConfig”之后添加“, AssemblyName”

需要在section标签的type属性中指定程序集

*** 排名高于vendor's own documentation site 本身的频率让我感到惊讶：)

对于外行也值得注意， 需要成为

的第一个孩子

使 ConfigurationElementCollection 类型显式：codeproject.com/Tips/1037705/…