Настроечные параметры ASP.NET

Использование атрибута file

Элемент <appSettings> включает только один атрибут – атрибут file. Атрибут file используется для указания файла XML, который содержит элементы <add>, <remove> или <clear>. Этот метод очень похож на включение на стороне сервера, поскольку включает только параметры из файла XML. Для использования атрибута filе установите его значение в теге раздела <appSettings>.

<appSettings file="relative file path" />

В таблице 3.6 показано значение атрибута элемента <appSettings>.

Ниже приведен пример использования атрибута file.

<appSettings file="extrasettings.xml" />

Для использования атрибута file нужно создать файл XML, содержащий различные пары ключ/значение. Ниже приведен пример файла настроек в сочетании с атрибутом file.

<?xml version="1.0" encoding="utf-8" ?>
  <appSettings>
  <add key="MyKey" value="MyValue" />
  <remove key="DatabasePassword" />
</appSettings>

Как вы можете видеть, это небольшой настроечный файл с одним единственным разделом настроек. Дочерние элементы этого раздела рассматриваются так, как если бы они были записаны в файле web.config или machine.config. Это очень эффективная методика, если требуется включить несколько значений в несколько приложений, поскольку можно создать подобный файл и сохранить его в месте, доступном для всех этих приложений.

Чтение значений <appSettings>

Теперь давайте рассмотрим, как читать в ASP.NET значения из раздела <appSettings>. Обработчик раздела настроек для раздела <appSettings> делает эти параметры доступными при помощи коллекции имен значений <AppSettings>. Ниже приведен код на VB.NET и C#, который осуществляет доступ к значениям.

VB.NET

Dim sConnString as string  ' Создаем строковое значение
' Читаем значение из коллекции
sConnString = Configuration.AppSettings("connString")
Dim oConn as SqlConnection  ' Создаем наш объект соединения
' Используем строку для создания соединения
oConn = new SqlConnection(sConnString)

C#

// Сначала читаем значение из коллекции AppSettings
string sConnString  = Configuration.AppSettings["connString"];
// Затем используем это значение для создания своего соединения
SqlConnection oConn = new SqlConnection(sConnString);

Как вы можете видеть, получить доступ к значениям, добавленным в настроечный файл, очень просто – обратитесь к коллекции <AppSettings> и используйте имя, указанное вами в настроечном файле. Раздел <appSettings> облегчает добавление различных значений в настроечный файл. Он особенно ценен при работе со значением, используемым на различных страницах, так как не придется менять его для каждой страницы. Вместо этого вы измените его в настроечном файле – и каждая страница прочтет новое значение.

Ключевые моменты

• Для объявления разделов и групп разделов используется раздел <configSections>.
• Для удаления разделов или групп разделов, объявленных в предыдущем настроечном файле, используются элементы <remove> и <clear>.
• Для добавления в коллекцию значений, доступ к которым производится из различных файлов и приложений, используются раздел <appSettings> и элемент <add>.
• Для удаления одного или всех значений, объявленных в предыдущих настроечных файлах, используются элементы <remove> и <clear>.