Спеціальний розділ 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>

Відповіді:


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.Insests ["Tata Motors"] чи можна це зробити?
Саймон

2
Слід зазначити, що це <configSection>має бути відразу після <configuration>тегу, щоб він працював!
Ведран Копаня

2
Слід також зазначити, що <додати потрібно. Створення власного власного тегу <не працює з цією відповіддю
Steve's D

8
AFAIK - цей код "config [" Tata Motors "]" не буде компілювати b / c, індексатор config є захищеним внутрішнім. вам доведеться самостійно перерахувати предмети колекції.
CedricB

1
@JayWalker все добре. "My.MyConfiguration, My.Assembly" у вашому прикладі для типу розділу викиньте мене. Мені просто довелося використовувати "MyAssembly.MyConfiguration, MyAssembly" для того, що я намагався.
Глен,

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]);
}

1
Думаю, це не відповідає чітко на запитання ОП, але, на мою думку, це дійсне рішення, і набагато простіше. Щонайменше це мені допомогло!
styl0r

2
@ styl0r ти маєш рацію. він не відповідає суворо . Якщо вам доведеться використовувати атрибути name / code замість мого ключа / значення рішення, вам доведеться використовувати справді спеціальний розділ. Однак я припускаю, що ви контролюєте файл конфігурації, і вам слід зробити щось краще, ніж створити власний клас.
JJS

4
Дуже просто і чисто! Немає необхідності в будь-якому додатковому роздуму для розділів / елементів.
Ondřej

2
Ви також можете оновити версію = 4.0.0.0, якщо хочете, просто змінивши номер версії. Це найкраща відповідь imo, якщо вам потрібні лише додаткові прості списки. Те саме можна зробити і для "System.Configuration.ConnectionStringsSection", хоча дублікати обробляються дещо інакше, ніж налаштування програми.
Шарпіро

@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);
}

2
Це чудово. Тепер нам просто потрібен приклад коду для оновлення, додавання та видалення Екземпляра.
Скотт Хатчінсон,

1
Дякуємо за ваше рішення! Хто б це не робив у РС ... це справді є без потреби.
Switch386

8

На основі відповіді Джея Уокера, доступ до елементів потрібно здійснити шляхом ітерації через колекцію "Екземпляри". тобто

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

foreach (MyConfigInstanceElement e in config.Instances) { 
   Console.WriteLine("Name: {0}, Code: {1}", e.Name, e.Code); 
}
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.