ConfigurationBuilder Kelas

Referensi

Definisi

Ruang nama:: System.Configuration

Rakitan:: System.Configuration.dll

Penting

Beberapa informasi terkait produk prarilis yang dapat diubah secara signifikan sebelum dirilis. Microsoft tidak memberikan jaminan, tersirat maupun tersurat, sehubungan dengan informasi yang diberikan di sini.

Mewakili kelas dasar yang akan diperluas oleh implementasi penyusun konfigurasi kustom.

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

Warisan: Object

ProviderBase
ConfigurationBuilder

Contoh

Contoh berikut menunjukkan cara mengimplementasikan ConfigurationBuilder sederhana untuk membaca variabel Lingkungan:

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

Contoh berikut adalah kutipan file konfigurasi seperti yang berlaku untuk contoh sebelumnya. Ini menerapkan variabel lingkungan ke konfigurasi appSettings dan membuat nilai tersebut tersedia di bawah ConfigurationManager.AppSettings.

<!-- 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>

Keterangan

Berasal dari kelas ini untuk membaca konfigurasi dari sumber eksternal yang ingin Anda konsumsi di aplikasi .NET Framework Anda menggunakan API standarConfigurationManager. ConfigurationBuilders tersedia di NuGet.org untuk dibaca dari variabel lingkungan, brankas kunci Azure, dan sejumlah sumber lainnya.

Beberapa implementasi ConfigurationBuilders tersedia dari NuGet.org:

EnvironmentConfigBuilder - Baca dari variabel lingkungan.
AzureKeyVaultConfigBuilder - Baca dari Azure Key Vault.
UserSecretsConfigBuilder - Baca dari file usersecrets di disk, mirip dengan fungsionalitas ASP.NET Core.
SimpleJsonConfigBuilder - Baca dari file JSON.

Konstruktor

ConfigurationBuilder()

Menginisialisasi instans baru kelas ConfigurationBuilder.

Properti

Description	Mendapatkan deskripsi singkat dan ramah yang cocok untuk ditampilkan di alat administratif atau antarmuka pengguna (UI) lainnya. (Diperoleh dari ProviderBase)
Name	Mendapatkan nama ramah yang digunakan untuk merujuk ke penyedia selama konfigurasi. (Diperoleh dari ProviderBase)

Metode

Equals(Object)	Menentukan apakah objek yang ditentukan sama dengan objek saat ini. (Diperoleh dari Object)
GetHashCode()	Berfungsi sebagai fungsi hash default. (Diperoleh dari Object)
GetType()	Mendapatkan dari instans Type saat ini. (Diperoleh dari Object)
Initialize(String, NameValueCollection)	Menginisialisasi penyusun konfigurasi. (Diperoleh dari ProviderBase)
MemberwiseClone()	Membuat salinan dangkal dari saat ini Object. (Diperoleh dari Object)
ProcessConfigurationSection(ConfigurationSection)	ConfigurationSection Menerima objek dari sistem konfigurasi dan mengembalikan objek yang dimodifikasi atau baru ConfigurationSection untuk digunakan lebih lanjut.
ProcessRawXml(XmlNode)	Menerima bagian konfigurasi mentah yang XmlNode mewakili dari file konfigurasi dan mengembalikan yang dimodifikasi atau baru XmlNode untuk digunakan lebih lanjut.
ToString()	Mengembalikan string yang mewakili objek saat ini. (Diperoleh dari Object)

Berlaku untuk