Пользовательский раздел app.config с простым списком «добавляемых» элементов.

88

Как создать собственный раздел app.config, представляющий собой простой список addэлементов?

Я нашел несколько примеров (например, как создать настраиваемый раздел конфигурации в app.config? ) Для настраиваемых разделов, которые выглядят следующим образом:

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

Но как избежать дополнительного элемента коллекции ( «фирма») , так что она выглядит так же , как appSettingsи connectionStringsсекции? Другими словами, я бы хотел:

<registerCompanies>
  <add name="Tata Motors" code="Tata"/>
  <add name="Honda Motors" code="Honda"/>
</registerCompanies>
c#  app-config 
— Джо Дейли
источник
— Охад Шнайдер

Ответы:

115

Полный пример с кодом на основе файла конфигурации OP:

<configuration>
    <configSections>
        <section name="registerCompanies" 
                 type="My.MyConfigSection, My.Assembly" />
    </configSections>
    <registerCompanies>
        <add name="Tata Motors" code="Tata"/>
        <add name="Honda Motors" code="Honda"/>
    </registerCompanies>
</configuration>

Вот пример кода для реализации настраиваемого раздела конфигурации со свернутой коллекцией.

using System.Configuration;
namespace My {
public class MyConfigSection : ConfigurationSection {
    [ConfigurationProperty("", IsRequired = true, IsDefaultCollection = true)]
    public MyConfigInstanceCollection Instances {
        get { return (MyConfigInstanceCollection)this[""]; }
        set { this[""] = value; }
    }
}
public class MyConfigInstanceCollection : ConfigurationElementCollection {
    protected override ConfigurationElement CreateNewElement() {
        return new MyConfigInstanceElement();
    }

    protected override object GetElementKey(ConfigurationElement element) {
        //set to whatever Element Property you want to use for a key
        return ((MyConfigInstanceElement)element).Name;
    }
}

public class MyConfigInstanceElement : ConfigurationElement {
    //Make sure to set IsKey=true for property exposed as the GetElementKey above
    [ConfigurationProperty("name", IsKey = true, IsRequired = true)]
    public string Name {
        get { return (string) base["name"]; }
        set { base["name"] = value; }
    }

    [ConfigurationProperty("code", IsRequired = true)]
    public string Code {
        get { return (string) base["code"]; }
        set { base["code"] = value; }
    } } }

Вот пример того, как получить доступ к информации о конфигурации из кода.

var config = ConfigurationManager.GetSection("registerCompanies") 
                 as MyConfigSection;

Console.WriteLine(config["Tata Motors"].Code);
foreach (var e in config.Instances) { 
   Console.WriteLine("Name: {0}, Code: {1}", e.Name, e.Code); 
}
— Джей Уокер
источник
@Jay Walker, как получить доступ к нужному элементу, например: - config.Instances ["Tata Motors"] можно ли это сделать?
— Саймон
2
Следует отметить, что тег <configSection>должен быть сразу после <configuration>тега, чтобы он работал!
— Vedran Kopanja
2
Следует также отметить, что требуется <add. Создание собственного пользовательского тега <не работает с этим ответом
— Steve's a D
8
AFAIK - этот код "config [" Tata Motors "]" не будет компилировать b / c индексатор конфигурации защищен внутренним. вам нужно будет найти способ самостоятельно перечислить предметы в коллекции.
— CedricB
1
@JayWalker все хорошо. «My.MyConfiguration, My.Assembly» в вашем примере для типа раздела бросает меня. Мне просто пришлось использовать MyAssembly.MyConfiguration, MyAssembly для того, что я пытался.
— Glen
38

Нет необходимости в настраиваемом разделе конфигурации.

App.Config

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <configSections>
        <section name="YourAppSettings" type="System.Configuration.AppSettingsSection, System.Configuration, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" />
    </configSections>
    <!-- value attribute is optional. omit if you just want a list of 'keys' -->
    <YourAppSettings>
        <add key="one" value="1" />
        <add key="two" value="2"/>
        <add key="three" value="3"/>
        <add key="duplicate" value="aa"/>
        <add key="duplicate" value="bb"/>
    </YourAppSettings>
</configuration>

Получить

// This casts to a NameValueCollection because the section is defined as a 
/// AppSettingsSection in the configSections.
NameValueCollection settingCollection = 
    (NameValueCollection)ConfigurationManager.GetSection("YourAppSettings");

var items = settingCollection.Count;
Debug.Assert(items == 4); // no duplicates... the last one wins.
Debug.Assert(settingCollection["duplicate"] == "bb");

// Just keys as per original question? done... use em.
string[] allKeys = settingCollection.AllKeys;

// maybe you did want key/value pairs. This is flexible to accommodate both.
foreach (string key in allKeys)
{
    Console.WriteLine(key + " : " + settingCollection[key]);
}
— JJS
источник
1
Я предполагаю, что он не отвечает строго на вопрос OP, но я думаю, что это действительное решение, и гораздо более простое. По крайней мере, мне это помогло!
— styl0r
2
@ styl0r ты прав. он не отвечает строго на него. Если вам нужно использовать имя / код атрибутов вместо ключа / значения моего решения, вам придется использовать действительно настраиваемый раздел. Однако я предполагаю, что вы контролируете файл конфигурации, и у вас есть дела поважнее, чем создание собственного класса.
— JJS
4
Очень просто и чисто! Нет необходимости в каких-либо дополнительных настраиваемых разделах / элементах.
— Ondřej
2
Вы также можете выполнить обновление до версии 4.0.0.0, если хотите, просто изменив номер версии. Это лучший ответ, если вам просто нужны дополнительные простые списки. То же самое можно сделать и для System.Configuration.ConnectionStringsSection, хотя дубликаты обрабатываются несколько иначе, чем настройки приложения.
— Sharpiro
@Sharpiro были ли у вас проблемы с версией сборки? Я думал, что привязка сборки будет идти в ногу со временем даже для более новых версий фреймворка.
— JJS
22

Основываясь на приведенном выше ответе Джея Уокера , это полный рабочий пример, который добавляет возможность выполнять индексацию:

<configuration>
    <configSections>
        <section name="registerCompanies" 
                 type="My.MyConfigSection, My.Assembly" />
    </configSections>
    <registerCompanies>
        <add name="Tata Motors" code="Tata"/>
        <add name="Honda Motors" code="Honda"/>
    </registerCompanies>
</configuration>

Вот пример кода для реализации настраиваемого раздела конфигурации со свернутой коллекцией.

using System.Configuration;
using System.Linq;
namespace My
{
   public class MyConfigSection : ConfigurationSection
   {
      [ConfigurationProperty("", IsRequired = true, IsDefaultCollection = true)]
      public MyConfigInstanceCollection Instances
      {
         get { return (MyConfigInstanceCollection)this[""]; }
         set { this[""] = value; }
      }
   }
   public class MyConfigInstanceCollection : ConfigurationElementCollection
   {
      protected override ConfigurationElement CreateNewElement()
      {
         return new MyConfigInstanceElement();
      }

      protected override object GetElementKey(ConfigurationElement element)
      {
         //set to whatever Element Property you want to use for a key
         return ((MyConfigInstanceElement)element).Name;
      }

      public new MyConfigInstanceElement this[string elementName]
      {
         get
         {
            return this.OfType<MyConfigInstanceElement>().FirstOrDefault(item => item.Name == elementName);
         }
      }
   }

   public class MyConfigInstanceElement : ConfigurationElement
   {
      //Make sure to set IsKey=true for property exposed as the GetElementKey above
      [ConfigurationProperty("name", IsKey = true, IsRequired = true)]
      public string Name
      {
         get { return (string)base["name"]; }
         set { base["name"] = value; }
      }

      [ConfigurationProperty("code", IsRequired = true)]
      public string Code
      {
         get { return (string)base["code"]; }
         set { base["code"] = value; }
      }
   }
}

Вот пример того, как получить доступ к информации о конфигурации из кода.

MyConfigSection config = 
   ConfigurationManager.GetSection("registerCompanies") as MyConfigSection;

Console.WriteLine(config.Instances["Honda Motors"].Code);
foreach (MyConfigInstanceElement e in config.Instances)
{
   Console.WriteLine("Name: {0}, Code: {1}", e.Name, e.Code);
}
— SwDevMan81
источник
2
Это круто. Теперь нам просто нужен пример кода для обновления, добавления и удаления экземпляра.
— Скотт Хатчинсон
1
Спасибо за решение! Кто бы это ни сделал в MS ... это действительно излишне сложно.
— Switch386,
8

Основываясь на ответе Джея Уокера, доступ к элементам должен осуществляться путем итерации через коллекцию «Instances». т.е.

var config = ConfigurationManager.GetSection("registerCompanies") 
                 as MyConfigSection;

foreach (MyConfigInstanceElement e in config.Instances) { 
   Console.WriteLine("Name: {0}, Code: {1}", e.Name, e.Code); 
}
— Bonneech
источник
Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.