ConfigurationBuilder Sınıf

Tanım

public ref class ConfigurationBuilder abstract : System::Configuration::Provider::ProviderBase

public abstract class ConfigurationBuilder : System.Configuration.Provider.ProviderBase

type ConfigurationBuilder = class
    inherit ProviderBase

Public MustInherit Class ConfigurationBuilder
Inherits ProviderBase

Devralma

Object

ProviderBase

ConfigurationBuilder

Örnekler

Aşağıdaki örnekte, Ortam değişkenlerini okumak için basit bir ConfigurationBuilder'ın nasıl uygulandığı gösterilmektedir:

using System;
using System.Configuration;
using System.Xml;

namespace Samples.AspNet.Config
{

   public class SampleConfigurationBuilder : ConfigurationBuilder
    {

        public override XmlNode ProcessRawXml(XmlNode rawXml) 
        {

            string rawXmlString = rawXml.OuterXml;

            if (String.IsNullOrEmpty(rawXmlString)) {
                return rawXml;
            }

            rawXmlString = Environment.ExpandEnvironmentVariables(rawXmlString);

            XmlDocument doc = new XmlDocument();
            doc.PreserveWhitespace = true;
            doc.LoadXml(rawXmlString);
            return doc.DocumentElement;
        }

        public override ConfigurationSection ProcessConfigurationSection(ConfigurationSection configSection) 
            => configSection;
    }
}

Imports System.Configuration
Imports System.Xml

Public Class SampleConfigurationBuilder : Inherits ConfigurationBuilder

    Public Overrides Function ProcessRawXml(rawXml As XmlNode)  As XmlNode

        Dim rawXmlString As String = rawXml.OuterXml

        If String.IsNullOrEmpty(rawXmlString) Then
            Return rawXml
        End If

        rawXmlString = Environment.ExpandEnvironmentVariables(rawXmlString)

        Dim doc As New XmlDocument()
        doc.PreserveWhitespace = True
        doc.LoadXml(rawXmlString)
        Return doc.DocumentElement
    End Function

    Public Overrides Function ProcessConfigurationSection(configSection As ConfigurationSection)  As ConfigurationSection
       Return configSection
    End Function

End Class

Aşağıdaki örnek, önceki örnekte geçerli olduğu gibi yapılandırma dosyasının bir alıntısıdır. Bu, appSettings yapılandırmasına ortam değişkenlerini uygular ve bu değerleri altında ConfigurationManager.AppSettingskullanılabilir hale getirir.

<!-- To declare and use Configuration Builders in your configuration chain, update your app.config or web.config file as follows:  -->

<configSections>
  <section name="configBuilders" type="System.Configuration.ConfigurationBuildersSection, System.Configuration, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" restartOnExternalChanges="false" requirePermission="false"/>
</configSections>

<configBuilders>
  <builders>
    <add name="SampleConfigurationBuilder" type="CustomConfigBuilders.MyConfigBuilder, CustomConfigBuilders" />
  </builders>
</configBuilders>

<!-- To apply Configuration Builders to a configuration section, use the 'configBuilders' tag as follows:  -->
<appSettings configBuilders="SampleConfigurationBuilder">
  <add key="COMPUTERNAME" value="Will Be Replaced by EnvironmentVariable" />
</appSettings>

Açıklamalar

Standart ConfigurationManager API'yi kullanarak .NET Framework uygulamanızda kullanmak istediğiniz bir dış kaynaktan yapılandırmayı okumak için bu sınıftan türetin. ConfigurationBuilders ortam değişkenlerinden, Azure anahtar kasasından ve diğer kaynaklardan okumak için NuGet.org kullanılabilir.

ConfigurationBuilders'ın çeşitli uygulamaları NuGet.org kullanılabilir:

• EnvironmentConfigBuilder - Ortam değişkenlerinden okuma.
• AzureKeyVaultConfigBuilder - Azure Key Vault'dan okuyun.
• UserSecretsConfigBuilder - ASP.NET Core işlevselliğine benzer şekilde disk üzerindeki bir usersecrets dosyasından okuma.
• SimpleJsonConfigBuilder - JSON dosyasından okuma.

Oluşturucular

Özellikler

Yöntemler

Şunlara uygulanır