App.Config и Custom Configuration Sections / Хабр

Я уверен, что многие из вас использовали файл конфигурации App. Config для хранения данных инициализации или конфигурации приложения. И я также уверен, что многие из вас хотели создать в этом файле свои собственные структуры для хранения настроек. Но в итоге пришлось использовать встроенный функционал раздела и извлекать значения с помощью конструкции формы:

ConfigurationManager.AppSettings["MyKey"]

Что ж, я давно хотел разобраться, как использовать возможности класса ConfigurationSection для описания и загрузки данных, определенных в моем собственном формате. После нескольких часов экспериментов и гугления я смог создать свою собственную структуру данных в файле конфигурации и использовать ее в своем приложении.

Итак, для загрузки нашей структуры данных из файла App. Config нам понадобятся следующие классы:

1. ConfigurationSection: этот объект вернет настраиваемый раздел.
2. ConfigurationElementCollection — на самом деле это набор элементов, которые мы определим в пользовательском разделе.
3. ConfigurationElement — это сам элемент, описывающий определенный вами тип объекта.

Первое, что нам нужно сделать, это добавить файл app. Config в наше приложение (если вы еще этого не сделали, конечно). Затем откройте этот файл и скопируйте и вставьте следующий код между тегами:

<configSections>
<!-- 
name = Имя, которое используется для ссылки на данный раздел в файле настройки.
type = Обработчик раздела настроек. Включает две секции: полный путь - пространство имен обработчика наших данных   имя самого обработчика, наименование сборки, где данный класс располагается.
-->
    <section name="StartupFolders" type="ConfigSectionTester.StartupFoldersConfigSection, ConfigSectionTester"/>
</configSections>

Примечание: Этот раздел необходимо размещать в самом начале конфигурационного файла, т.е. сразу после тега, иначе будут ошибки инициализации конфигурации.

Далее создадим свой раздел, который будет реализовывать нашу собственную модель данных:

<StartupFolders>
    <Folders>
        <add folderType="A" path="c:foo" />
        <add folderType="B" path="C:foo1" />
    </Folders>
</StartupFolders>

Примечание. Если кому-то не нравится добавлять узлы с помощью команды add в этом примере, они всегда могут создать свой собственный префикс, используя следующий код:

[ConfigurationCollection( typeof( FolderElement ) ), AddItemName = "Folder"]
public class FoldersCollection : ConfigurationElementCollection
{

при определении коллекции элементов в структуре данных. Тогда в конфигурационном файле можно будет писать так:

<StartupFolders>
   <Folders>
     <Folder folderType="A" path="c:foo" />
     <Folder folderType="B" path="C:foo1" />
   </Folders>
 </StartupFolders>

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

Во-первых, мы создадим класс, наследуемый от ConfigurationSection, который позволит нам взаимодействовать с нашим разделом в файле конфигурации через ConfigurationManager во время выполнения.

public class StartupFoldersConfigSection : ConfigurationSection
{
    [ConfigurationProperty( "Folders" )]
    public FoldersCollection FolderItems
   {
        get { return ( (FoldersCollection)( base[ "Folders" ] ) ); }
    }
}

Атрибут ConfigurationProperty(«Folders») необходим для сопоставления свойства FolderItems с корневым узлом нашей структуры данных.

Класс FoldersCollection наследуется от ConfigurationElementCollection, что обеспечивает взаимодействие с коллекцией наших элементов, описанных в app.config. Класс определяется так:

[ConfigurationCollection( typeof( FolderElement ) )]
public class FoldersCollection : ConfigurationElementCollection
{
    protected override ConfigurationElement CreateNewElement()
    {
        return new FolderElement();
    }

    protected override object GetElementKey( ConfigurationElement element )
    {
        return ( (FolderElement)( element ) ).FolderType;
    }

    public FolderElement this[int idx ]
    {
        get{return (FolderElement) BaseGet(idx); }
    }
}

Последнее, что нам нужно сделать, это создать ConfigurationElement, класс, который привяжет нас к окончательным данным, определенным в файле конфигурации.

public class FolderElement : ConfigurationElement
{

    [ConfigurationProperty("folderType", DefaultValue="", IsKey=true, IsRequired=true)]
    public string FolderType
    {
        get {return ((string) (base["folderType"]));}
        set{base["folderType"] = value; }
    }

    [ConfigurationProperty( "path", DefaultValue = "", IsKey = false, IsRequired = false )]
    public string Path
    {
        get{return ( (string)( base[ "path" ] ) ); }
        set{base[ "path" ] = value; }
    }
}

Атрибут ConfigurationProperty(«folderType») требуется, чтобы связать имя атрибута xml в файле конфигурации. Другие настройки атрибутов, такие как DefaultValue=»», IsKey=true, IsRequired=true, только задают различные параметры, применимые к свойствам.

Замечание: автор умалчивает, что при стандартном способе использования сеттер свойства FolderType, работать не будет, т.к. файл конфигурации обычно доступен только на чтение. Для того что бы представлялось возможным производить запись в файл конфигурации следует делать, например, так:

Configuration cfg = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
StartupFoldersConfigSection section = (StartupFoldersConfigSection)cfg.Section["StartupFolders"];
if ( section != null )
{
    System.Diagnostics.Debug.WriteLine( section.FolderItems[0].FolderType );
    System.Diagnostics.Debug.WriteLine( section.FolderItems[0].Path );
    section.FolderItems[0].Path = "C:Nanook";
    cfg.Save(); //устанавливает перенос на новую строку и производит проверку <exename>.vshost.exe.config файла в вашей отладочной папке.
}

Итак, мы имеем все необходимые данные и классы, которые предоставляют нам возможность хранить в конфигурационном файле app.config пользовательскую структуру данных.
Использовать данный подход можно так:

StartupFoldersConfigSection section = (StartupFoldersConfigSection)ConfigurationManager.GetSection( "StartupFolders" );

if ( section != null )
{
System.Diagnostics.Debug.WriteLine( section.FolderItems[ 0 ].FolderType );
System.Diagnostics.Debug.WriteLine( section.FolderItems[ 0 ].Path );
}

При этом не забудьте добавить System. Configuration в список подключаемых пространств имен.

Автор: Дерик Уиттакер