ConfigurationBuilder Kelas

Definisi

Ruang nama:

Microsoft.Extensions.Configuration

Rakitan:

Microsoft.Extensions.Configuration.dll

Paket:

Microsoft.Extensions.Configuration v9.0.0-preview.5.24306.7

Sumber:

ConfigurationBuilder.cs

Digunakan untuk membangun pengaturan konfigurasi berbasis kunci/nilai untuk digunakan dalam aplikasi.

public ref class ConfigurationBuilder : Microsoft::Extensions::Configuration::IConfigurationBuilder

public class ConfigurationBuilder : Microsoft.Extensions.Configuration.IConfigurationBuilder

type ConfigurationBuilder = class
    interface IConfigurationBuilder

Public Class ConfigurationBuilder
Implements IConfigurationBuilder

Warisan

Object

ConfigurationBuilder

Penerapan

IConfigurationBuilder

Keterangan

Dengan menggunakan kelas ini, Anda dapat menyimpan nilai konfigurasi dalam file JSON, misalnya, lalu mengambilnya pada durasi. Untuk informasi selengkapnya, lihat Konfigurasi - contoh dasar.

Jika Anda memigrasikan aplikasi ke .NET Core 3.1 atau versi yang lebih baru, Anda dapat menggunakan kelas ini untuk menggantikan fungsionalitas file app.config yang mungkin sebelumnya telah Anda gunakan untuk mengonfigurasi aplikasi Anda.

Contoh

Cuplikan kode berikut menunjukkan aplikasi yang disederhanakan ConfigurationBuilder yang membuat objek untuk mengambil nilai string dari file JSON pada durasi.

using Microsoft.Extensions.Configuration;

IConfigurationBuilder builder = new ConfigurationBuilder().AddJsonFile("appsettings.json", false, true);
IConfigurationRoot root = builder.Build();

Console.WriteLine($"Hello, { root["weather"] } world!");

/* This program outputs the following text:
 * 
 * Hello, stormy world!
 */

Konten file JSON ditampilkan di sini.

{
  "weather": "stormy"
}

Konstruktor

ConfigurationBuilder()

Menginisialisasi instans baru kelas ConfigurationBuilder.

Properti

Properties	Mendapatkan koleksi kunci/nilai yang dapat digunakan untuk berbagi data antara IConfigurationBuilder dan penyedia konfigurasi terdaftar.
Sources	Mendapatkan sumber yang digunakan untuk mendapatkan nilai konfigurasi.

Metode

Add(IConfigurationSource)	Menambahkan sumber konfigurasi baru.
Build()	IConfiguration Membangun dengan kunci dan nilai dari set penyedia yang terdaftar di Sources.
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)
MemberwiseClone()	Membuat salinan dangkal dari saat ini Object. (Diperoleh dari Object)
ToString()	Mengembalikan string yang mewakili objek saat ini. (Diperoleh dari Object)

Metode Ekstensi

AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	Mendaftarkan penyedia konfigurasi untuk metadata aplikasi.
AddConfiguration(IConfigurationBuilder, IConfiguration)	Menambahkan konfigurasi yang ada ke configurationBuilder.
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	Menambahkan konfigurasi yang ada ke configurationBuilder.
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	Menambahkan yang IConfigurationProvider membaca nilai konfigurasi dari baris perintah.
AddCommandLine(IConfigurationBuilder, String[])	CommandLineConfigurationProvider Menambahkan yang membaca nilai konfigurasi dari baris perintah.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	CommandLineConfigurationProvider Menambahkan yang membaca nilai konfigurasi dari baris perintah menggunakan pemetaan sakelar yang ditentukan.
Add<TSource>(IConfigurationBuilder, Action<TSource>)	Menambahkan sumber konfigurasi baru.
AddEnvironmentVariables(IConfigurationBuilder)	Menambahkan yang IConfigurationProvider membaca nilai konfigurasi dari variabel lingkungan.
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	Menambahkan yang IConfigurationProvider membaca nilai konfigurasi dari variabel lingkungan.
AddEnvironmentVariables(IConfigurationBuilder, String)	IConfigurationProvider Menambahkan yang membaca nilai konfigurasi dari variabel lingkungan dengan awalan tertentu.
GetFileLoadExceptionHandler(IConfigurationBuilder)	Mendapatkan default IFileProvider yang akan digunakan untuk penyedia berbasis file.
GetFileProvider(IConfigurationBuilder)	Mendapatkan default IFileProvider yang akan digunakan untuk penyedia berbasis file.
SetBasePath(IConfigurationBuilder, String)	Mengatur FileProvider untuk penyedia berbasis file ke PhysicalFileProvider dengan jalur dasar.
SetFileLoadExceptionHandler(IConfigurationBuilder, Action<FileLoadExceptionContext>)	Mengatur tindakan default yang akan dipanggil untuk penyedia berbasis file ketika terjadi kesalahan.
SetFileProvider(IConfigurationBuilder, IFileProvider)	Menyetel default IFileProvider yang akan digunakan untuk penyedia berbasis file.
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Menambahkan sumber konfigurasi INI ke builder.
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	Menambahkan sumber konfigurasi INI ke builder.
AddIniFile(IConfigurationBuilder, String)	Menambahkan penyedia konfigurasi INI ke pathbuilder.
AddIniFile(IConfigurationBuilder, String, Boolean)	Menambahkan penyedia konfigurasi INI ke pathbuilder.
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	Menambahkan penyedia konfigurasi INI ke pathbuilder.
AddIniStream(IConfigurationBuilder, Stream)	Menambahkan sumber konfigurasi INI ke builder.
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Menambahkan sumber konfigurasi JSON ke builder.
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	Menambahkan sumber konfigurasi JSON ke builder.
AddJsonFile(IConfigurationBuilder, String)	Menambahkan penyedia konfigurasi JSON ke pathbuilder.
AddJsonFile(IConfigurationBuilder, String, Boolean)	Menambahkan penyedia konfigurasi JSON ke pathbuilder.
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	Menambahkan penyedia konfigurasi JSON ke pathbuilder.
AddJsonStream(IConfigurationBuilder, Stream)	Menambahkan sumber konfigurasi JSON ke builder.
AddKeyPerFile(IConfigurationBuilder, Action<KeyPerFileConfigurationSource>)	Menambahkan konfigurasi menggunakan file dari direktori. Nama file digunakan sebagai kunci, konten file digunakan sebagai nilai .
AddKeyPerFile(IConfigurationBuilder, String)	Menambahkan konfigurasi menggunakan file dari direktori. Nama file digunakan sebagai kunci, konten file digunakan sebagai nilai .
AddKeyPerFile(IConfigurationBuilder, String, Boolean)	Menambahkan konfigurasi menggunakan file dari direktori. Nama file digunakan sebagai kunci, konten file digunakan sebagai nilai .
AddKeyPerFile(IConfigurationBuilder, String, Boolean, Boolean)	Menambahkan konfigurasi menggunakan file dari direktori. Nama file digunakan sebagai kunci, konten file digunakan sebagai nilai .
AddInMemoryCollection(IConfigurationBuilder)	Menambahkan penyedia konfigurasi memori ke configurationBuilder.
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	Menambahkan penyedia konfigurasi memori ke configurationBuilder.
AddUserSecrets(IConfigurationBuilder, Assembly)	Menambahkan sumber konfigurasi rahasia pengguna. Ini mencari assembly instans UserSecretsIdAttribute, yang menentukan ID rahasia pengguna. ID rahasia pengguna adalah nilai unik yang digunakan untuk menyimpan dan mengidentifikasi kumpulan nilai konfigurasi rahasia.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)	Menambahkan sumber konfigurasi rahasia pengguna. Ini mencari assembly instans UserSecretsIdAttribute, yang menentukan ID rahasia pengguna. ID rahasia pengguna adalah nilai unik yang digunakan untuk menyimpan dan mengidentifikasi kumpulan nilai konfigurasi rahasia.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	Menambahkan sumber konfigurasi rahasia pengguna. Ini mencari assembly instans UserSecretsIdAttribute, yang menentukan ID rahasia pengguna. ID rahasia pengguna adalah nilai unik yang digunakan untuk menyimpan dan mengidentifikasi kumpulan nilai konfigurasi rahasia.
AddUserSecrets(IConfigurationBuilder, String)	Menambahkan sumber konfigurasi rahasia pengguna dengan ID rahasia pengguna tertentu. ID rahasia pengguna adalah nilai unik yang digunakan untuk menyimpan dan mengidentifikasi kumpulan nilai konfigurasi rahasia.
AddUserSecrets(IConfigurationBuilder, String, Boolean)	Menambahkan sumber konfigurasi rahasia pengguna dengan ID rahasia pengguna tertentu. ID rahasia pengguna adalah nilai unik yang digunakan untuk menyimpan dan mengidentifikasi kumpulan nilai konfigurasi rahasia.
AddUserSecrets<T>(IConfigurationBuilder)	Menambahkan sumber konfigurasi rahasia pengguna. Mencari perakitan yang berisi jenis T untuk instans UserSecretsIdAttribute, yang menentukan ID rahasia pengguna. ID rahasia pengguna adalah nilai unik yang digunakan untuk menyimpan dan mengidentifikasi kumpulan nilai konfigurasi rahasia.
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	Menambahkan sumber konfigurasi rahasia pengguna. Mencari perakitan yang berisi jenis T untuk instans UserSecretsIdAttribute, yang menentukan ID rahasia pengguna. ID rahasia pengguna adalah nilai unik yang digunakan untuk menyimpan dan mengidentifikasi kumpulan nilai konfigurasi rahasia.
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	Menambahkan sumber konfigurasi rahasia pengguna. Mencari perakitan yang berisi jenis T untuk instans UserSecretsIdAttribute, yang menentukan ID rahasia pengguna. ID rahasia pengguna adalah nilai unik yang digunakan untuk menyimpan dan mengidentifikasi kumpulan nilai konfigurasi rahasia.
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Menambahkan sumber konfigurasi XML ke builder.
AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)	Menambahkan sumber konfigurasi XML ke builder.
AddXmlFile(IConfigurationBuilder, String)	Menambahkan penyedia konfigurasi XML ke pathbuilder.
AddXmlFile(IConfigurationBuilder, String, Boolean)	Menambahkan penyedia konfigurasi XML ke pathbuilder.
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	Menambahkan penyedia konfigurasi XML ke pathbuilder.
AddXmlStream(IConfigurationBuilder, Stream)	Menambahkan sumber konfigurasi XML ke builder.

Lihat juga

• Konfigurasi di .NET