Secara otomatis mengatur appsettings.json untuk lingkungan dev dan rilis di inti asp.net?

Saya telah menetapkan beberapa nilai dalam saya appsettings.jsonuntuk hal-hal seperti string koneksi database, lokasi webapi dan sejenisnya yang berbeda untuk pengembangan, pementasan, dan lingkungan langsung.

Apakah ada cara untuk memiliki banyak appsettings.jsonfile (seperti appsettings.live.json, dll, dll) dan membuat aplikasi asp.net hanya 'tahu' mana yang akan digunakan berdasarkan konfigurasi build yang dijalankannya?

Anda dapat menggunakan kompilasi bersyarat:

public Startup(IHostingEnvironment env)
{
    var builder = new ConfigurationBuilder()
    .SetBasePath(env.ContentRootPath)
    .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
#if SOME_BUILD_FLAG_A
    .AddJsonFile($"appsettings.flag_a.json", optional: true)
#else
    .AddJsonFile($"appsettings.no_flag_a.json", optional: true)
#endif
    .AddEnvironmentVariables();
    this.configuration = builder.Build();
}

Saya telah menambahkan tangkapan layar dari lingkungan kerja, karena saya menghabiskan beberapa jam untuk R&D.

1. Pertama, tambahkan kunci ke launch.jsonfile Anda .

   Lihat tangkapan layar di bawah ini, saya telah menambahkan Developmentsebagai lingkungan saya.

   

2. Kemudian, dalam proyek Anda, buat appsettings.{environment}.jsonfile baru yang menyertakan nama lingkungan.

   Di tangkapan layar berikut, cari dua file berbeda dengan nama:

   • appsettings.Development.Json
   • appSetting.json

   
   

3. Dan terakhir, konfigurasikan ke StartUpkelas Anda seperti ini:

   public Startup(IHostingEnvironment env)
   {
       var builder = new ConfigurationBuilder()
           .SetBasePath(env.ContentRootPath)
           .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
           .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
           .AddEnvironmentVariables();
   
       Configuration = builder.Build();
   }
   

4. Dan akhirnya, Anda dapat menjalankannya dari baris perintah seperti ini:

   dotnet run --environment "Development"
   

   dimana "Development"nama lingkungan saya.

Pembaruan untuk .NET Core 3.0+

1. Anda dapat menggunakan CreateDefaultBuilderyang secara otomatis akan membangun dan meneruskan objek konfigurasi ke kelas startup Anda:

   WebHost.CreateDefaultBuilder(args).UseStartup<Startup>();
   

   public class Startup
   {
       public Startup(IConfiguration configuration) // automatically injected
       {
           Configuration = configuration;
       }
       public IConfiguration Configuration { get; }
       /* ... */
   }
   

2. CreateDefaultBuilderotomatis menyertakan file yang sesuai, jadi tambahkan file setelan aplikasi terpisah untuk setiap lingkungan:appsettings.Environment.json

   

3. Kemudian atur ASPNETCORE_ENVIRONMENT variabel lingkungan saat menjalankan / debugging

Cara mengatur Variabel Lingkungan

Bergantung pada IDE Anda, ada beberapa tempat proyek dotnet biasanya mencari variabel lingkungan:

• Untuk Visual Studio masuk ke Project> Properties> Debug> Environment Variables:

  

• Untuk kode Visual Studio , edit .vscode/launch.json> env:

  

• Menggunakan Pengaturan Peluncuran , edit Properties/launchSettings.json> environmentVariables:

  

  Yang juga dapat dipilih dari Toolbar di Visual Studio

  

• Menggunakan dotnet CLI , gunakan sintaks yang sesuai untuk mengatur variabel lingkungan per OS Anda

  Catatan : Saat aplikasi diluncurkan dengan dotnet run , launchSettings.jsondibaca jika tersedia, dan environmentVariablessetelan di launchSettings.json menggantikan variabel lingkungan.

Bagaimana cara Host.CreateDefaultBuilderkerjanya?

.NET Core 3.0 ditambahkan di Host.CreateDefaultBuilderbawah ekstensi platform yang akan memberikan inisialisasi default IConfigurationyang menyediakan konfigurasi default untuk aplikasi dalam urutan berikut:

1. appsettings.jsonmenggunakan penyedia konfigurasi JSON .
2. appsettings.Environment.jsonmenggunakan penyedia konfigurasi JSON . Sebagai contoh:
   • appsettings.Production.json atau
   • appsettings.Development.json
3. Rahasia aplikasi saat aplikasi berjalan di lingkungan Pengembangan.
4. Variabel lingkungan menggunakan penyedia konfigurasi Variabel Lingkungan .
5. Argumen baris perintah yang menggunakan penyedia konfigurasi baris perintah .

Bacaan Lebih Lanjut - MS Docs

• Aplikasi startup di ASP.NET Core
• Konfigurasi di ASP.NET Core
• Gunakan beberapa lingkungan di ASP.NET Core

Di ASP.NET Core, Anda sebaiknya menggunakan Variabel Lingkungan daripada membangun konfigurasi untuk appsettings.json yang tepat

1. Klik kanan pada proyek Anda> Properti> Debug> Variabel Lingkungan

   

2. ASP.NET Core akan menggunakan file appsettings.json yang sesuai:

   

3. Sekarang Anda dapat menggunakan Variabel Lingkungan seperti ini:

   public Startup(IHostingEnvironment env)
   {
       var builder = new ConfigurationBuilder()
           .SetBasePath(env.ContentRootPath)
           .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
           .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
           .AddEnvironmentVariables();
   
       Configuration = builder.Build();
   }
   

Catatan : Jika Anda menggunakan jawaban @ Dmitry , Anda dapat mengalami masalah misalnya. saat mengganti nilai appsettings.json di Azure.

Anda dapat menggunakan variabel lingkungan dan ConfigurationBuilderkelas dalam Startupkonstruktor Anda seperti ini:

public Startup(IHostingEnvironment env)
{
    var builder = new ConfigurationBuilder()
    .SetBasePath(env.ContentRootPath)
    .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
    .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
    .AddEnvironmentVariables();
    this.configuration = builder.Build();
}

Kemudian Anda membuat appsettings.xxx.jsonfile untuk setiap lingkungan yang Anda butuhkan, dengan "xxx" sebagai nama lingkungan. Perhatikan bahwa Anda dapat memasukkan semua nilai konfigurasi global dalam appsettings.jsonfile "normal" Anda dan hanya memasukkan hal-hal khusus lingkungan ke dalam file baru ini.

Sekarang Anda hanya membutuhkan variabel lingkungan yang dipanggil ASPNETCORE_ENVIRONMENTdengan beberapa nilai lingkungan tertentu ("live", "staging", "production", apa pun). Anda dapat menentukan variabel ini di setelan proyek Anda untuk lingkungan pengembangan Anda, dan tentu saja Anda perlu menyetelnya di lingkungan pementasan dan produksi Anda juga. Cara Anda melakukannya tergantung pada jenis lingkungannya.

UPDATE: Saya baru menyadari Anda ingin memilih appsettings.xxx.jsonberdasarkan konfigurasi build Anda saat ini . Ini tidak dapat dicapai dengan solusi yang saya usulkan dan saya tidak tahu apakah ada cara untuk melakukan ini. Namun, cara "variabel lingkungan" berfungsi dan mungkin juga menjadi alternatif yang baik untuk pendekatan Anda.

Hanya pembaruan untuk pengguna .NET core 2.0, Anda dapat menentukan konfigurasi aplikasi setelah panggilan ke CreateDefaultBuilder:

public class Program
{
   public static void Main(string[] args)
   {
      BuildWebHost(args).Run();
   }

   public static IWebHost BuildWebHost(string[] args) =>
      WebHost.CreateDefaultBuilder(args)
             .ConfigureAppConfiguration(ConfigConfiguration)
             .UseStartup<Startup>()
             .Build();

   static void ConfigConfiguration(WebHostBuilderContext ctx, IConfigurationBuilder config)
   {
            config.SetBasePath(Directory.GetCurrentDirectory())
                .AddJsonFile("config.json", optional: false, reloadOnChange: true)
                .AddJsonFile($"config.{ctx.HostingEnvironment.EnvironmentName}.json", optional: true, reloadOnChange: true);

   }
 }

1. Buat banyak file seperti:appSettings.$(Configuration).json

   • appSettings.staging.json
   • appSettings.production.json

2. Buat acara pra-bangun di proyek yang menyalin file terkait ke appSettings.json:

   copy appSettings.$(Configuration).json appSettings.json
   

3. Gunakan hanya appSettings.jsondi Config Builder Anda:

   var builder = new ConfigurationBuilder()
               .SetBasePath(env.ContentRootPath)
               .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
               .AddEnvironmentVariables();
   
   Configuration = builder.Build();
   

Anda dapat menambahkan nama konfigurasi seperti ASPNETCORE_ENVIRONMENTdi launchSettings.jsonbawah ini

  "iisSettings": {
    "windowsAuthentication": false,
    "anonymousAuthentication": true,
    "iisExpress": {
      "applicationUrl": "http://localhost:58446/",
      "sslPort": 0
    }
  },
  "profiles": {
    "IIS Express": {
      "commandName": "IISExpress",
      "environmentVariables": {
        ASPNETCORE_ENVIRONMENT": "$(Configuration)"
      }
    }
  }

Ini adalah versi yang berfungsi untuk saya saat menggunakan aplikasi konsol tanpa halaman web:

var builder = new ConfigurationBuilder()
             .SetBasePath(Directory.GetCurrentDirectory())
             .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
             .AddJsonFile($"appsettings.{Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT")}.json", optional: true);

            IConfigurationRoot configuration = builder.Build();
            AppSettings appSettings = new AppSettings();
            configuration.GetSection("AppSettings").Bind(appSettings);

File .vscode / launch.json hanya digunakan oleh Visual Studio serta file /Properties/launchSettings.json. Jangan gunakan file ini dalam produksi.

File launchSettings.json:

1. Hanya digunakan di mesin pengembangan lokal.
2. Tidak diterapkan.

3. berisi pengaturan profil.

   • Nilai lingkungan yang disetel di launchSettings.json mengganti nilai yang disetel di lingkungan sistem

Untuk menggunakan file 'appSettings.QA.json' misalnya. Anda dapat menggunakan 'ASPNETCORE_ENVIRONMENT'. Ikuti langkah-langkah di bawah ini.

1. Tambahkan Variabel Lingkungan baru pada mesin host dan beri nama 'ASPNETCORE_ENVIRONMENT'. Setel nilainya menjadi 'QA'.
2. Buat file 'appSettings.QA.json' di proyek Anda. Tambahkan konfigurasi Anda di sini.
3. Terapkan ke mesin pada langkah 1. Konfirmasi 'appSettings.QA.json' diterapkan.
4. Muat situs web Anda. Harapkan appSettings.QA.json untuk digunakan di sini.