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

Сброс всех разделов

Для удаления всех разделов и групп разделов используйте элемент <clear>. Он удаляет все разделы, объявленные до него, и все разделы, объявленные в предыдущих настроечных файлах. Ниже приведен пример использования элемента <clear> в настроечных файлах.

Файл machine.config

<configuration>
  <configSections>
    <section name="httpRuntime" type=
      "System.Web.Configuration.HttpRuntimeConfigurationHandler,
      System.Web, Version=1.0.3300.0, Culture=neutral,
      PublicKeyToken=b03f5f7f11d50a3a" />
  </configSections>
</configuration>

Файл web.config

<configuration>
  <configSections>
    <clear />
  </configSections>
</configuration>

Раздел <httpRuntime> из более раннего настроечного файла теперь не будет доступен.

Хотя раздел <configSections> не часто используется при работе с ASP.NET, очень важно понимать его функцию в архитектуре конфигурации. В части III данный раздел рассмотрен более подробно с точки зрения создания своих собственных разделов и обработчиков разделов.

Работа с <appSettings>

Раздел <appSettings> позволяет хранить в настроечном файле символьные строки и получать эти значения из любого приложения. Эти строки, или значения, хранятся вместе с ключами, которые используются для получения строки в приложениях. Давайте посмотрим на различные элементы из раздела <appSettings>. В дальнейшем вы встретитесь с атрибутом file, который служит для указания файла XML, содержащего различные элементы <appSettings>.

Добавление значения

При наличии строки, к которой требуется доступ из разных файлов приложений, следует добавить ее в раздел <appSettings> своего настроечного файла. Если это значение должно быть доступно всем приложениям вашего сервера, его также можно добавить в файл machine.config. Для добавления значения в коллекцию <appSettings> служит элемент <add> – задайте ключ, идентифицирующий значение в вашей коллекции, и значение, которое вы хотите сохранить. Для добавления элемента <add> используйте следующий синтаксис.

<appSettings>
  <add key="ourKey" value="ourValue" />
</appSettings>

Атрибуты элемента <add> перечислены в таблице 3.4.

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

<appSettings>
  <add key="ConnString" value="server=192.168.0.12;database=mydb;
    UID=myuser;Password=mypassword" />
</appSettings>

Здесь в коллекцию добавлена пара ключ/значение. Ключ называется ConnString, а значением пары является строка соединения с сервером. В конце этого раздела вы увидите, как получить доступ к этому значению при помощи ASP.NET.

Удаление значения

Тег <remove> используется для удаления из коллекции пары ключ/значение. Вы указываете ключ пары, которую нужно удалить, и указанная пара в этой коллекции становится недоступной. Это полезно, если необходимо удалить параметр, который был добавлен в коллекцию на более высоком уровне. Например, пара ключ/значение, добавленная в файл machine.config, может быть изъята на уровне файла web.config с помощью следующей записи.

<appSettings>
  <remove key="ourKey" />
</appSettings>

В таблице 3.5 показаны значения атрибута элемента <remove>.

Следующий пример показывает, как удалить строку, добавленную в предыдущем разделе.

<appSettings>
  <remove key="ConnString" />
</appSettings>

Данная пара ключ/значение будет недоступна этому приложению и любым другим приложениям, наследующим этот файл web.config.

Сброс всех значений

Элемент <clear> используется для полного сброса коллекции <appSettings>. Аналогично элементу <remove>, он служит для удаления различных пар ключ/значение, но при этом удаляет все пары. Ниже приведен пример элемента <clear>.

<appSettings>
  <clear/>
</appSettings>

Добавление этого элемента в раздел <appSettings> полностью очищает его.

Использование атрибута 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> облегчает добавление различных значений в настроечный файл. Он особенно ценен при работе со значением, используемым на различных страницах, так как не придется менять его для каждой страницы. Вместо этого вы измените его в настроечном файле – и каждая страница прочтет новое значение.

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