ConfigurationManager Класс

Определение

Предоставляет доступ к файлам конфигурации для клиентских приложений.Provides access to configuration files for client applications. Этот класс не наследуется.This class cannot be inherited.

public ref class ConfigurationManager abstract sealed
public static class ConfigurationManager
type ConfigurationManager = class
Public Class ConfigurationManager
Наследование
ConfigurationManager

Примеры

В первом примере показано простое консольное приложение, которое считывает параметры приложения, добавляет новый параметр и обновляет существующий параметр.The first example shows a simple console application that reads application settings, adds a new setting, and updates an existing setting.

using System;  
using System.Configuration;  
  
namespace ConsoleApplication1  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            ReadAllSettings();  
            ReadSetting("Setting1");  
            ReadSetting("NotValid");  
            AddUpdateAppSettings("NewSetting", "May 7, 2014");  
            AddUpdateAppSettings("Setting1", "May 8, 2014");  
            ReadAllSettings();  
        }  
  
        static void ReadAllSettings()  
        {  
            try  
            {  
                var appSettings = ConfigurationManager.AppSettings;  
  
                if (appSettings.Count == 0)  
                {  
                    Console.WriteLine("AppSettings is empty.");  
                }  
                else  
                {  
                    foreach (var key in appSettings.AllKeys)  
                    {  
                        Console.WriteLine("Key: {0} Value: {1}", key, appSettings[key]);  
                    }  
                }  
            }  
            catch (ConfigurationErrorsException)  
            {  
                Console.WriteLine("Error reading app settings");  
            }  
        }  
  
        static void ReadSetting(string key)  
        {  
            try  
            {  
                var appSettings = ConfigurationManager.AppSettings;  
                string result = appSettings[key] ?? "Not Found";  
                Console.WriteLine(result);  
            }  
            catch (ConfigurationErrorsException)  
            {  
                Console.WriteLine("Error reading app settings");  
            }  
        }  
  
        static void AddUpdateAppSettings(string key, string value)  
        {  
            try  
            {  
                var configFile = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);  
                var settings = configFile.AppSettings.Settings;  
                if (settings[key] == null)  
                {  
                    settings.Add(key, value);  
                }  
                else  
                {  
                    settings[key].Value = value;  
                }  
                configFile.Save(ConfigurationSaveMode.Modified);  
                ConfigurationManager.RefreshSection(configFile.AppSettings.SectionInformation.Name);  
            }  
            catch (ConfigurationErrorsException)  
            {  
                Console.WriteLine("Error writing app settings");  
            }  
        }  
    }  
}  
Imports System.Configuration  
Module Module1  
  
    Sub Main()  
        ReadAllSettings()  
        ReadSetting("Setting1")  
        ReadSetting("NotValid")  
        AddUpdateAppSettings("NewSetting", "May 7, 2014")  
        AddUpdateAppSettings("Setting1", "May 8, 2014")  
        ReadAllSettings()  
    End Sub  
  
    Sub ReadAllSettings()  
        Try  
            Dim appSettings = ConfigurationManager.AppSettings  
  
            If appSettings.Count = 0 Then  
                Console.WriteLine("AppSettings is empty.")  
            Else  
                For Each key As String In appSettings.AllKeys  
                    Console.WriteLine("Key: {0} Value: {1}", key, appSettings(key))  
                Next  
            End If  
        Catch e As ConfigurationErrorsException  
            Console.WriteLine("Error reading app settings")  
        End Try  
    End Sub  
  
    Sub ReadSetting(key As String)  
        Try  
            Dim appSettings = ConfigurationManager.AppSettings  
            Dim result As String = appSettings(key)  
            If IsNothing(result) Then  
                result = "Not found"  
            End If  
            Console.WriteLine(result)  
        Catch e As ConfigurationErrorsException  
            Console.WriteLine("Error reading app settings")  
        End Try  
    End Sub  
  
    Sub AddUpdateAppSettings(key As String, value As String)  
        Try  
            Dim configFile = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None)  
            Dim settings = configFile.AppSettings.Settings  
            If IsNothing(settings(key)) Then  
                settings.Add(key, value)  
            Else  
                settings(key).Value = value  
            End If  
            configFile.Save(ConfigurationSaveMode.Modified)  
            ConfigurationManager.RefreshSection(configFile.AppSettings.SectionInformation.Name)  
        Catch e As ConfigurationErrorsException  
            Console.WriteLine("Error writing app settings")  
        End Try  
    End Sub  
  
End Module  

В предыдущем примере предполагается, что проект содержит файл App. config, как показано ниже.The previous example assumes your project has an App.config file as shown below.

<?xml version="1.0" encoding="utf-8" ?>  
<configuration>  
    <startup>   
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" />  
    </startup>  
  <appSettings>  
    <add key="Setting1" value="May 5, 2014"/>  
    <add key="Setting2" value="May 6, 2014"/>  
  </appSettings>  
</configuration>  

В следующем примере показано, как использовать строку подключения для чтения данных из базы данных.The following example shows how to use a connection string to read data from a database.

using System;  
using System.Configuration;  
using System.Data.SqlClient;  
  
namespace ConsoleApplication1  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            ReadProducts();  
        }  
  
        static void ReadProducts()  
        {  
            var connectionString = ConfigurationManager.ConnectionStrings["WingtipToys"].ConnectionString;  
            string queryString = "SELECT Id, ProductName FROM dbo.Products;";  
            using (var connection = new SqlConnection(connectionString))  
            {  
                var command = new SqlCommand(queryString, connection);  
                connection.Open();  
                using (var reader = command.ExecuteReader())  
                {  
                    while (reader.Read())  
                    {  
                        Console.WriteLine(String.Format("{0}, {1}", reader[0], reader[1]));  
                    }  
                }  
            }  
        }  
    }  
}  
Imports System.Configuration  
Imports System.Data.SqlClient  
Module Module1  
  
    Sub Main()  
        ReadProducts()  
    End Sub  
  
    Sub ReadProducts()  
        Dim connectionString = ConfigurationManager.ConnectionStrings("WingtipToys").ConnectionString  
        Dim queryString = "SELECT Id, ProductName FROM dbo.Products;"  
        Using connection As New SqlConnection(connectionString)  
            Dim command = New SqlCommand(queryString, connection)  
            connection.Open()  
  
            Using reader As SqlDataReader = command.ExecuteReader()  
                While reader.Read()  
                    Console.WriteLine(String.Format("{0}, {1}", reader(0), reader(1)))  
                End While  
            End Using  
        End Using  
    End Sub  
  
End Module  

В предыдущем примере предполагается, что проект имеет файл App. config, как показано ниже.The previous example assumes your project has an App.config as shown below.

<?xml version="1.0" encoding="utf-8" ?>  
<configuration>  
    <startup>   
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" />  
    </startup>  
    <connectionStrings>  
      <add name="WingtipToys" connectionString="Data Source=(LocalDB)\v11.0;Initial Catalog=WingtipToys;Integrated Security=True;Pooling=False" />  
    </connectionStrings>  
</configuration>  

Комментарии

Класс ConfigurationManager позволяет получать доступ к сведениям о конфигурации компьютера, приложения и пользователя.The ConfigurationManager class enables you to access machine, application, and user configuration information. Этот класс заменяет класс ConfigurationSettings, который является устаревшим.This class replaces the ConfigurationSettings class, which is deprecated. Для веб-приложений используйте класс WebConfigurationManager.For web applications, use the WebConfigurationManager class.

Чтобы использовать класс ConfigurationManager, проект должен ссылаться на сборку System.Configuration.To use the ConfigurationManager class, your project must reference the System.Configuration assembly. По умолчанию некоторые шаблоны проектов, например консольное приложение, не ссылаются на эту сборку, поэтому необходимо вручную сослаться на нее.By default, some project templates, like Console Application, do not reference this assembly so you must manually reference it.

Примечание

Имя и расположение файла конфигурации приложения зависят от узла приложения.The name and location of the application configuration file depend on the application's host. Дополнительные сведения см. в разделе Настройка приложений с помощью файлов конфигурации.For more information, see Configuring Apps by using Configuration Files.

Для управления сведениями о конфигурации можно использовать встроенные типы System.Configuration или наследовать от них.You can use the built-in System.Configuration types or derive from them to handle configuration information. С помощью этих типов можно работать непосредственно с информацией о конфигурации, а файлы конфигурации можно расширять, чтобы они включали пользовательские сведения.By using these types, you can work directly with configuration information and you can extend configuration files to include custom information.

Класс ConfigurationManager содержит члены, которые позволяют выполнять следующие задачи:The ConfigurationManager class includes members that enable you to perform the following tasks:

  • Чтение раздела из файла конфигурации.Read a section from a configuration file. Чтобы получить доступ к сведениям о конфигурации, вызовите метод GetSection.To access configuration information, call the GetSection method. Для некоторых разделов, таких как appSettings и connectionStrings, используйте классы AppSettings и ConnectionStrings.For some sections such as appSettings and connectionStrings, use the AppSettings and ConnectionStrings classes. Эти члены выполняют операции только для чтения, используют один кэшированный экземпляр конфигурации и поддерживают многопоточность.These members perform read-only operations, use a single cached instance of the configuration, and are multithread aware.

  • Чтение и запись файлов конфигурации в целом.Read and write configuration files as a whole. Приложение может считывать и записывать параметры конфигурации на любом уровне, для самого себя или для других приложений или компьютеров локально или удаленно.Your application can read and write configuration settings at any level, for itself or for other applications or computers, locally or remotely. Используйте один из методов, предоставляемых классом ConfigurationManager, чтобы открыть файл конфигурации, например SampleApp. exe. config. Эти методы возвращают объект Configuration, который, в свою очередь, предоставляет методы и свойства, которые можно использовать для работы с связанными файлами конфигурации.Use one of the methods provided by the ConfigurationManager class to open a configuration file such as SampleApp.exe.config. These methods return a Configuration object that in turn exposes methods and properties you can use to work with the associated configuration files. Методы выполняют операции чтения или записи и создают данные конфигурации при каждом записи файла.The methods perform read or write operations and create the configuration data every time that a file is written.

  • Поддержка задач настройки.Support configuration tasks. Для поддержки различных задач настройки используются следующие типы:The following types are used to support various configuration tasks:

    Помимо работы с существующими сведениями о конфигурации, можно создавать пользовательские элементы конфигурации и работать с ними, расширяя встроенные типы конфигурации, такие как ConfigurationElement, ConfigurationElementCollection, ConfigurationPropertyи классы ConfigurationSection.In addition to working with existing configuration information, you can create and work with custom configuration elements by extending the built-in configuration types such as the ConfigurationElement, ConfigurationElementCollection, ConfigurationProperty, and ConfigurationSection classes. Пример программного расширения встроенного типа конфигурации см. в разделе ConfigurationSection.For an example of how to extend a built-in configuration type programmatically, see ConfigurationSection. Пример расширения встроенного типа конфигурации, использующего модель на основе атрибутов, см. в разделе ConfigurationElement.For an example of how to extend a built-in configuration type that uses the attribute-based model, see ConfigurationElement.

Примечания для тех, кто наследует этот метод

Класс Configuration обеспечивает программный доступ для редактирования файлов конфигурации.The Configuration class enables programmatic access for editing configuration files. Вы используете один из открытых методов, предоставляемых ConfigurationManager.You use one of the Open methods provided by ConfigurationManager. Эти методы возвращают объект Configuration, который, в свою очередь, предоставляет необходимые методы и свойства для управления базовыми файлами конфигурации.These methods return a Configuration object, which in turn provides the required methods and properties to handle the underlying configuration files. Вы можете получить доступ к этим файлам для чтения или записи.You can access these files for reading or writing.

Для чтения файлов конфигурации используйте GetSection(String) или GetSectionGroup(String) для чтения сведений о конфигурации.To read the configuration files, use GetSection(String) or GetSectionGroup(String) to read configuration information. Пользователь или процесс, выполняющий чтение, должен иметь следующие разрешения:The user or process that reads must have the following permissions: — Разрешение на чтение файла конфигурации на текущем уровне иерархии конфигурации.- Read permission on the configuration file at the current configuration hierarchy level.

— Разрешения на чтение всех родительских файлов конфигурации.- Read permissions on all the parent configuration files.

Если приложению требуется доступ только для чтения к своей собственной конфигурации, рекомендуется использовать метод GetSection(String).If your application needs read-only access to its own configuration, we recommend that you use the GetSection(String) method. Этот метод предоставляет доступ к кэшированным значениям конфигурации для текущего приложения, что обеспечивает лучшую производительность по сравнению с классом Configuration.This method provides access to the cached configuration values for the current application, which has better performance than the Configuration class.

Для записи в файлы конфигурации используйте один из методов Save.To write to the configuration files, use one of the Save methods. Пользователь или процесс, выполняющий запись, должен иметь следующие разрешения:The user or process that writes must have the following permissions: — Разрешение на запись в файл конфигурации и каталог на текущем уровне иерархии конфигурации.- Write permission on the configuration file and directory at the current configuration hierarchy level.

— Разрешения на чтение для всех файлов конфигурации.- Read permissions on all the configuration files.

Свойства

AppSettings

Получает данные AppSettingsSection для конфигурации текущего приложения по умолчанию.Gets the AppSettingsSection data for the current application's default configuration.

ConnectionStrings

Получает данные ConnectionStringsSection для конфигурации текущего приложения по умолчанию.Gets the ConnectionStringsSection data for the current application's default configuration.

Методы

GetSection(String)

Извлекает указанный раздел конфигурации для конфигурации по умолчанию текущего приложения.Retrieves a specified configuration section for the current application's default configuration.

OpenExeConfiguration(ConfigurationUserLevel)

Открывает файл конфигурации для текущего приложения в качестве объекта Configuration.Opens the configuration file for the current application as a Configuration object.

OpenExeConfiguration(String)

Открывает указанный файл конфигурации клиента в качестве объекта Configuration.Opens the specified client configuration file as a Configuration object.

OpenMachineConfiguration()

Открывает файл конфигурации компьютера на текущем компьютере в качестве объекта Configuration.Opens the machine configuration file on the current computer as a Configuration object.

OpenMappedExeConfiguration(ExeConfigurationFileMap, ConfigurationUserLevel)

Открывает указанный файл конфигурации клиента в качестве объекта Configuration, который использует указанные сопоставление файлов и уровень пользователя.Opens the specified client configuration file as a Configuration object that uses the specified file mapping and user level.

OpenMappedExeConfiguration(ExeConfigurationFileMap, ConfigurationUserLevel, Boolean)

Открывает указанный файл конфигурации клиента в качестве объекта Configuration, который использует указанное сопоставление файлов, уровень пользователя и параметр предварительной загрузки.Opens the specified client configuration file as a Configuration object that uses the specified file mapping, user level, and preload option.

OpenMappedMachineConfiguration(ConfigurationFileMap)

Открывает файл конфигурации компьютера в качестве объекта Configuration, который использует указанное сопоставление файлов.Opens the machine configuration file as a Configuration object that uses the specified file mapping.

RefreshSection(String)

Обновляет раздел с заданным именем, чтобы при следующем извлечении он повторно считывался с диска.Refreshes the named section so the next time that it is retrieved it will be re-read from disk.

Применяется к

Дополнительно