ASP.NET MVC: Читаем настройки сайта из своей секции файла конфигурации web.config

ru-RU | создано: 20.09.2012 | опубликовано: 20.09.2012 | обновлено: 01.01.2018 | просмотров за всё время: 10501

Много раз приходилось сохранять настройки сайта в файле конфигурации. Раздел appSettings предоставляет возможность хранить настройки по принципу "ключ" = "значение" (Dictionary). Я же хочу показать как можно создать свою секцию в файле конфигурации, как читать из нее данные значения.

Постановка задачи

Требуется создать свою секцию настроек в конфигурационном файле web.config, со структурой более "продвинутой" чем appSettings (то есть нечто большее, чем просто Dictionary). А так же надо реализовать механизм считывания и обновления данных в этой секции.

Как сохранить настройки или выбор стратегии

Снова напомню, что есть серия статей "История одного проекта" (далее ИОП), которая посвящена разработке сайта “музей юмора”. И поэтому, давайте снова поговорим про этот проект, как можно расширить возможности по администрированию этого сайта. Предположим, что лента экспонатов, должна хранить записи за какой-то определенный срок. Например, за одну неделю, то есть семь дней. А если я захочу изменить срок, например на 14 дней? А если я захочу вообще временно отключить удаление записей? А если я хочу временно запретить публикацию экспонатов на ленте через IE-ускоритель? А если... Слишком много "а если"... Надо просто эти параметры где-то хранить с возможностью управления ими непосредственно со страниц сайта. Один из вариантов - файл конфигурации web.config, можно также хранить в базе данных, или, например, в текстовом файле, или сделать другой сайт, на котором сделать web-сервис, который сможет "выдать" всем моим сайта настройки для каждого или общие для всех. Или вообще, всё выложить в облако Azure и платить некоторую сумму в Microsoft... Всё ограничено лишь вашей фантазией. Мы будем говорить про первый вариант – сохранение настроек сайта в файле конфигурации.

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

  • Из секции appSettings. ASP.NET предоставляет программистам в своё распоряжение самый простой вариант. Информация в этой секции хранится по принципу Dictionary (ключ = значение).
  • Из собственной секции файла конфигурации. ASP.NET также предоставляет такую возможность. Структура данных в этом случае может быть сколь угодно сложной (комплексные типы), более того, вы можете гарантировать значения по умолчанию для своих параметров и даже валидацию ввода при изменении свойств, что является неоспоримым плюсом для этого способа.

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

Начнем с простого. Пусть на данный момент мне требуется такая ветка в файле конфигурации:

<SiteSettingsGroup>
    <SiteSettings>
        <PagerSize>
            <Entity Name="Logs" Size="20" />
            <Entity Name="Exhibit" Size="10" />
            <Entity Name="Lenta" Size="15" />
        </PagerSize>
        <Lenta DeleteAfterDays="17" AllowPostFromShare="false" />
    </SiteSettings>
</SiteSettingsGroup>

Если описать вкратце, то SiteSettingsGroup – название группы. SiteSettings – это та самая секция, которую мы будем создавать. PagerSize – это коллекция с настройками размера страницы при отображении в пейджере для определенного типа сущности. Lenta – это дополнительный раздел настроек для ленты анекдотов, а значения атрибутов, итак понятны.

Немного специальных классов

Создадим несколько классов. Для начала – главный класс SiteSettings (также называется и файл .cs). Чтобы все получилось, нужно для начала добавить namespace:

using System.Configuration;

Для начала создадим первый “кирпичик” выбранной структуры – класс LentaElement из указанной выше конфигурации:

public class LentaElement : ConfigurationElement {

    [ConfigurationProperty("DeleteAfterDays", DefaultValue = 7, IsRequired = true)]
    [IntegerValidator(MinValue = 3, MaxValue = 30, ExcludeRange = false)]
    public int DeleteAfterDays {
        get {
            return (int)this["DeleteAfterDays"];
        }
        set {
            this["DeleteAfterDays"] = value;
        }
    }

    [ConfigurationProperty("AllowPostFromShare", DefaultValue = true, IsRequired = true)]
    public bool AllowPostFromShare {
        get {
            return (bool)this["AllowPostFromShare"];
        }
        set {
            this["AllowPostFromShare"] = value;
        }
    }
}

Обратите внимание на то, что класс унаследован от ConfigurationElement. Это один из основных базовых классов, которые используются в web.config для разделов. Дальше будет понятнее.

Далее надо бы создать главный раздел для моей секции и уже использовать LentaElement как свойство. Класс я назову SiteSettings:

public class SiteSettings : ConfigurationSection {

    [ConfigurationProperty("Lenta", IsRequired = true)]
    public LentaElement Lenta {
        get {
            return (LentaElement)this["Lenta"];
        }
        set {
            this["Lenta"] = value;
        }
    }
}

Между делом или Config-помощник

Для того, чтобы “достучаться” до любого значения любого параметра моей конфигурации, давайте прямо сейчас создадим специальный класс-помощник. Я буду его использовать чтобы протестировать работоспособность конфигурации:

public class Config {

    /// <summary>
    /// скроем конструктор от любопытных программеров
    /// </summary>
    internal Config() { }

    /// <summary>
    /// наименование раздела конфигурации
    /// </summary>
    private const string CONFIGGROUPNAME = "SiteSettingsGroup/";

    /// <summary>
    /// наименование секции
    /// </summary>
    private const string CONFIGSECTIONNAME = "SiteSettings";

    /// <summary>
    /// Чтение раздела конфигурации целиком
    /// </summary>
    /// <returns></returns>
    internal static SiteSettings Get() {
        var config = (SiteSettings)ConfigurationManager   
             .GetSection(String.Concat(CONFIGGROUPNAME, CONFIGSECTIONNAME));
        return config;
    }        
}

А теперь пришло время попробовать что получилось. Попробуем прочитать информацию из конфигурации. Я предварительно в файле  web.config пока убрал (закомментировал) из своей конфигурации секцию PagerSize. Потому что она еще не реализована, а значит приложение даже не будет пытаться запуститься, а просто вывалится с ошибкой.

В головном контролере в методе Index, я для проверки вставил пару строк, чтобы проверить что конфигурация читается, запустил и…

Отлично! Как раз то, что я и указал в своей конфигурации. Дальше - больше. Я добавил еще несколько классов. Это самое интересное. В раздел SiteSettings я добавил определение класса PagerSizeCollection. Чтобы можно было работать с коллекцией настроек. Далее определил класс PageSizeItemsElement, который и представляет собой одну из строчек в списке PagerSize… Наверное, всё-таки имеет смысл показать весь файл SiteSettings целиком:

public class SiteSettings : ConfigurationSection
{

    [ConfigurationProperty("PagerSize")]
    public PagerSizeCollection PagerSize
    {
        get
        {
            return ((PagerSizeCollection)base["PagerSize"]);
        }
    }

    [ConfigurationProperty("Lenta", IsRequired = true)]
    public LentaElement Lenta
    {
        get
        {
            return (LentaElement)this["Lenta"];
        }
        set
        {
            this["Lenta"] = value;
        }
    }
}

[ConfigurationCollection(typeof(PageSizeItemsElement), AddItemName = "Entity")]
public class PagerSizeCollection : ConfigurationElementCollection
{

    public PageSizeItemsElement this[int index]
    {
        get { return (PageSizeItemsElement)BaseGet(index); }
    }

    protected override ConfigurationElement CreateNewElement()
    {
        return new PageSizeItemsElement();
    }

    protected override object GetElementKey(ConfigurationElement element)
    {
        return ((PageSizeItemsElement)element).Name;
    }
}

public class PageSizeItemsElement : ConfigurationElement
{

    [ConfigurationProperty("Size", DefaultValue = 20, IsRequired = true)]
    [IntegerValidator(MinValue = 5, MaxValue = 100, ExcludeRange = false)]
    public int Size
    {
        get
        {
            return (int)this["Size"];
        }
        set
        {
            this["Size"] = value;
        }
    }

    [ConfigurationProperty("Name", DefaultValue = "EntityName", IsRequired = true)]
    [StringValidator(MinLength = 3, MaxLength = 50, 
           InvalidCharacters = " ~!@#$%^&*()[]{}/;'\"|\\")]
    public String Name
    {
        get
        {
            return (String)this["Name"];
        }
        set
        {
            this["Name"] = value;
        }
    }
}

public class LentaElement : ConfigurationElement
{

    [ConfigurationProperty("DeleteAfterDays", DefaultValue = 7, IsRequired = true)]
    [IntegerValidator(MinValue = 3, MaxValue = 30, ExcludeRange = false)]
    public int DeleteAfterDays
    {
        get
        {
            return (int)this["DeleteAfterDays"];
        }
        set
        {
            this["DeleteAfterDays"] = value;
        }
    }

    [ConfigurationProperty("AllowPostFromShare", DefaultValue = true, IsRequired = true)]
    public bool AllowPostFromShare
    {
        get
        {
            return (bool)this["AllowPostFromShare"];
        }
        set
        {
            this["AllowPostFromShare"] = value;
        }
    }
}

Чтобы проверить работоспособность проделываю такую же операцию как и в прошлый раз:

Всё работает. Теперь осталось в подключить настройки к системе, то есть начать использовать их. Читается всё замечательно. Попробуем сохранить?

Заключение

В следующей статье я создам форму редактирования настроек (скорее всего это будет knockout.js, то есть это означает AJAX).

Комментарии к статье (16)

30.05.2017 4:12:34 Никита

В своем проекте подключил "свои" настройки в файле web.config таким образом:

<configSections>
    <sectionGroup name="SiteSettingsGroup">
        <section name="SiteSettings" type="Namespace.SiteSettingsSection, <ProjectName>"/>
    </sectionGroup>
</configSections>

Уточню:

Namespace.SiteSettingsSection - пространство имен и название класса через точку

<ProjectName> - название сборки проекта без расширения dll, в котором находится класс SiteSettingsSection.

Без этого - проект либо ничего не находит, либо не видит вложенные файлы.

Просто примечание: SiteSettingsGroup и другие "свои" группы настроек должны быть только дочерними (не внучатыми и т.д.) элементами корневого элемента <configuration/> .

06.05.2013 12:50:44 Calabonga

Значит, всё-таки что-то неправильно подключено или десериализация настроек "валит" проект в дамп. Тут уже надо смотреть на сам проект, классы и реализацию.

15.05.2013 22:13:43 Артем

Здравствуйте! А можно ли этот же подход использовать для файла App.config , который был создан в проэкте - библиотека классов?

16.05.2013 1:32:12 Calabonga

для Артема:

Web.config всего лишь текстовой файл, ASP.NET предоставляет специальные классы и сервисы по работе с этим безусловно важным текстовым файлом. Мне не очень понятно о каком конкретно типе приложения идет речь (ведь Windows Phone и WPF App.config присутствует), но могу сказать следующее: в каждом конкретном случае нужно смотреть на возможности, которые предоставляет выбранная платформа. Далее, если чего-то не хватает, придется дописать. И еще немаловажная вешь. При работе с Web.config когда вы внесете изменения, обновления уже будут применено сразу же в следующем запросе (при любом клике на странице сайта). С app.config придется перезапускать приложение, чтобы применить изменения, если только вы "вручную" не примените их

16.05.2013 12:30:47 Артём

Подскажите пожалуйста, как сделать правильно. Я пишу свой интернет-магазин, и хочу чтобы настройки (конфиги) хранились в отдельном проэкте. Можно ли это сделать? И как потом доступаться к конфигурационным файлам из других проектов (например, из проэкта МВЦ)?

16.05.2013 13:33:41 Calabonga

Артем, что касается ответа на вопрос, то тут нельзя однозначно сказать как правильно сделать, хотя бы потому, что настройки бывают разные:

  • настройки, которые применяются на приложение (при старте);
  • настройки, которые нужно использовать в приложении (например, количество товаров на странице по умолчанию) с возможностью переопределения в процессе работы приложения;
  • Настройки UI, которые вообще в статике должны быть доступны на представлениях (view). Вас конкретно какие интересуют!?
16.05.2013 14:00:48 Артём

Меня интересуют настройки, которые нужно использовать в приложение. То есть имя сайта, количество товаров на странице и прочие настройки, которые потом сможет изменить администратор. Сейчас получилось создать настройки, как вы описали в файле Web.config моего МВЦ приложения, но хотелось бы все настройки (как файлы ресурсов, конфиги) иметь в отдельном проекте. Подскажите, как бы вы это сделали. Спасибо :)

16.05.2013 14:54:04 Calabonga

Артем, вы мне можете не поверить, но на данный момент я действительно делаю такой проект, который "шарит" настройки между решениями (solutions). Я сделал просто. Есть настройки по умолчанию, они читаются специальным сервисом. Эти настройки не хранятся в web.config. Есть обёртка (wrapper) на эти настройк, она предоставляется доступ к ним на представлении. Настройки храняться не xml, а в Json формате, потому что меньше размер файла.

16.05.2013 15:47:58 Артём

Спасибо! Это интересно :) Если у вас будет свободное время, напишите вкратце статью, как вы это сделали. Думаю многим это будет полезно, так как вопросов об общих настройках для нескольких проектов много, но хорошее решение сложно найти. Успехов вам!

17.05.2013 0:38:04 Calabonga

Спасибо, на добром слове. Если будет время, то обязательно напишу.

18.06.2013 15:53:51 Artem

Здравствуйте! Помогите пожалуйста. Сделал у себя на сайте чтение настроек из web.config'а. Локально всё работает, но при переносе на хостинг возникают проблемы с безопасностью. Чтение собственной секции из конфига требует trust level = full или выше, а хостинг предоставляет только trust level = medium! Можно ли как-то оставить чтение собственных секций из вэб.конфига, и чтоб при этом на на хостинге стояло trust level = medium?
**** Самостоятельно поменять trust level не получается, потому что эта настройка у хостинг-провайдера находится в <location allowOverride="false">.

Спасибо за любую помощь!

18.06.2013 17:13:58 Artem

здравствуйте, вопрос с траст лэвэлом решил! извините за беспокойство. там нужно секции назначить 

requirePermission="false"
19.06.2013 1:12:07 Calabonga

Рад, Артем, что всё у вас получилось. И спасибо, вам что поделились бесценной информацией

19.06.2013 15:37:03 Artem

Читать настройки с траст левелом = медиум получается, а вот их перезаписать не удаётся. Выдаётся

 System.Security.SecurityException: Request for the permission of type 'System.Security.Permissions.FileIOPermission, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089' failed.

требует FileIOPermission. Можно ли это обойти, оставив при этом траст лэвэл = медиум ?

Спасибо большое

22.06.2013 2:22:23 Artem

В комментарии выше был вопрос :) Если знаете, подскажите, пожалуйста. Я пока ответа не нашёл

22.06.2013 3:09:47 Calabonga

Artem, обойти это не получится, ибо именно для того чтобы нельзя было это обойти, это всё и задумывалось. Во всяком случае, стандартным способом у меня не получилось.