ConfigurationBuilder Kelas

Definisi

Ruang nama:

Microsoft.Extensions.Configuration

Rakitan:

Microsoft.Extensions.Configuration.dll

Paket:

Microsoft.Extensions.Configuration v11.0.0-preview.4.26230.115

Sumber:

ConfigurationBuilder.cs

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 waktu proses. 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 mengganti app.config fungsionalitas file yang mungkin telah Anda gunakan sebelumnya untuk mengonfigurasi aplikasi Anda.

Example

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

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

Nama	Deskripsi
ConfigurationBuilder()	Menginisialisasi instans baru dari kelas ConfigurationBuilder.

Properti

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

Metode

Nama	Deskripsi
Add(IConfigurationSource)	Menambahkan sumber konfigurasi baru.
Build()	IConfiguration Membangun dengan kunci dan nilai dari sekumpulan penyedia yang terdaftar di Sources.

Metode Ekstensi

Nama	Deskripsi
Add<TSource>(IConfigurationBuilder, Action<TSource>)	Menambahkan sumber konfigurasi baru.
AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	Mendaftarkan penyedia konfigurasi untuk metadata aplikasi.
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	IConfigurationProvider Menambahkan yang membaca nilai konfigurasi dari baris perintah.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	CommandLineConfigurationProvider IConfigurationProvider Menambahkan yang membaca nilai konfigurasi dari baris perintah menggunakan pemetaan sakelar yang ditentukan.
AddCommandLine(IConfigurationBuilder, String[])	CommandLineConfigurationProvider IConfigurationProvider Menambahkan yang membaca nilai konfigurasi dari baris perintah.
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	Menambahkan konfigurasi yang ada ke configurationBuilder.
AddConfiguration(IConfigurationBuilder, IConfiguration)	Menambahkan konfigurasi yang ada ke configurationBuilder.
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	IConfigurationProvider Menambahkan yang membaca nilai konfigurasi dari variabel lingkungan.
AddEnvironmentVariables(IConfigurationBuilder, String)	IConfigurationProvider Menambahkan yang membaca nilai konfigurasi dari variabel lingkungan dengan awalan tertentu.
AddEnvironmentVariables(IConfigurationBuilder)	IConfigurationProvider Menambahkan yang membaca nilai konfigurasi dari variabel lingkungan.
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	Menambahkan sumber konfigurasi INI ke builder.
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Menambahkan sumber konfigurasi INI ke builder.
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	Menambahkan penyedia konfigurasi INI ke pathbuilder.
AddIniFile(IConfigurationBuilder, String, Boolean)	Menambahkan penyedia konfigurasi INI ke pathbuilder.
AddIniFile(IConfigurationBuilder, String)	Menambahkan penyedia konfigurasi INI ke pathbuilder.
AddIniStream(IConfigurationBuilder, Stream)	Menambahkan sumber konfigurasi INI ke builder.
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	Menambahkan penyedia konfigurasi memori ke configurationBuilder.
AddInMemoryCollection(IConfigurationBuilder)	Menambahkan penyedia konfigurasi memori ke configurationBuilder.
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	Menambahkan sumber konfigurasi JSON ke builder.
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Menambahkan sumber konfigurasi JSON ke builder.
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	Menambahkan penyedia konfigurasi JSON ke pathbuilder.
AddJsonFile(IConfigurationBuilder, String, Boolean)	Menambahkan penyedia konfigurasi JSON ke pathbuilder.
AddJsonFile(IConfigurationBuilder, String)	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, Boolean, Boolean)	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)	Menambahkan konfigurasi menggunakan file dari direktori. Nama file digunakan sebagai kunci, konten file digunakan sebagai nilai .
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, 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)	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, 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(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<T>(IConfigurationBuilder, Boolean, Boolean)	Menambahkan sumber konfigurasi rahasia pengguna. Mencari rakitan 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 rakitan 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)	Menambahkan sumber konfigurasi rahasia pengguna. Mencari rakitan 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, Action<XmlConfigurationSource>)	Menambahkan sumber konfigurasi XML ke builder.
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Menambahkan sumber konfigurasi XML ke builder.
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	Menambahkan penyedia konfigurasi XML ke pathbuilder.
AddXmlFile(IConfigurationBuilder, String, Boolean)	Menambahkan penyedia konfigurasi XML ke pathbuilder.
AddXmlFile(IConfigurationBuilder, String)	Menambahkan penyedia konfigurasi XML ke pathbuilder.
AddXmlStream(IConfigurationBuilder, Stream)	Menambahkan sumber konfigurasi XML ke builder.
GetFileLoadExceptionHandler(IConfigurationBuilder)	Mendapatkan tindakan default yang akan dipanggil untuk penyedia berbasis file ketika terjadi kesalahan.
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 saat terjadi kesalahan.
SetFileProvider(IConfigurationBuilder, IFileProvider)	Mengatur default IFileProvider yang akan digunakan untuk penyedia berbasis file.

Lihat juga

• Konfigurasi di .NET