Compartilhar via


Como: Ler configurações do aplicativo do arquivo Web.config

Este exemplo lê uma configuração do aplicativo identificada pela chave customsetting1 de um arquivo Web.config.O elemento AppSettings é uma coleção NameValueCollection de sequências de caracteres.Trabalhar com elementos de coleção pode ser levemente mais complicado que trabalhar com outros elementos de configuração.

Para obter parâmetros de configuração para a configuração da Web a nível de raiz, null é passado para o método OpenWebConfiguration.

Para atualizar um parâmetro de configuração, use o método Save ou o método SaveAs do objeto de configuração.Para obter mais informações, consulte Usando as Classes de Configuração.Para exemplos de código adicionais, consulte a classe AppSettingsSection e classes relacionadas.

Este exemplo usa o método não estático de obtenção de dados de configuração, o qual lhe permite puxar dados de configuração de qualquer aplicativo.Se você vai obter informações de configuração de um aplicativo no qual seu código reside, use o método estático, que processa mais rapidamente.Para obter mais informações, consulte a seção Trabalhando com Definições de Configuração Local e Remota em Visão Geral da API de Configuração do ASP.NET.

Exemplo

Dim rootWebConfig1 As System.Configuration.Configuration
rootWebConfig1 = System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration(Nothing)
If (0 < rootWebConfig1.AppSettings.Settings.Count) Then
    Dim customSetting As System.Configuration.KeyValueConfigurationElement
    customSetting = rootWebConfig1.AppSettings.Settings("customsetting1")
    If Not (Nothing = customSetting.Value) Then
        Console.WriteLine("customsetting1 application string = {0}", customSetting.Value)
    Else
        Console.WriteLine("No customsetting1 application string")
    End If
End If
         System.Configuration.Configuration rootWebConfig1 =
                System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration(null);
            if (0 < rootWebConfig1.AppSettings.Settings.Count)
            {
                System.Configuration.KeyValueConfigurationElement customSetting = 
                    rootWebConfig1.AppSettings.Settings["customsetting1"];
                if (null != customSetting)
                    Console.WriteLine("customsetting1 application string = \"{0}\"", 
                        customSetting.Value);
                else
                    Console.WriteLine("No customsetting1 application string");
            }

Compilando o código

Este exemplo requer:

  • Um elemento appSettings no arquivo raiz web.config parecido com o seguinte:

    <appSettings>
      <add key="customsetting1" value="Some text here"/>
    </appSettings>
    

    O elemento appSettings é um filho direto do elemento <configuration> e um ponto do elemento system.web.

Programação robusta

Valores lidos do elemento appSettings do arquivo Web.config são sempre do tipo String.Se a chave especificada não existe no arquivo Web.config, nenhum erro ocorrerá.Em vez disso, uma sequência vazia é retornada.

Segurança

O arquivo de configuração deve estar protegido no servidor usando as definições de segurança do Windows para limitar quem pode ler o arquivo.Evite armazenar informações sigilosas, como as credenciais do usuário, no elemento appSettings do arquivo Web.config.Além disso, considere criptografar definições de configuração.Para obter mais informações, consulte Criptografando informações de configuração usando configuração protegida.

Consulte também

Referência

appSettings elemento (Geral Settings Esquema)

ConfigurationSettings