Автоматично встановлювати appsettings.json для середовищ розробників та випусків у ядрі asp.net?

Я визначив деякі значення в моєму appsettings.jsonдля таких речей, як рядки підключення до бази даних, розташування веб-сайтів та подібні, які відрізняються для середовищ розробки, індексації та реального часу.

Чи є спосіб мати кілька appsettings.jsonфайлів (наприклад appsettings.live.json, тощо, тощо), а програма asp.net просто `` знати '', який із них використовувати на основі конфігурації збірки, яку вона працює?

Ви можете використовувати умовну компіляцію:

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();
}

Я додав скріншоти робочого середовища, тому що це коштувало мені кількох годин досліджень та розробок.

1. Спочатку додайте ключ до свого launch.jsonфайлу.

   Дивіться знімок екрана нижче, який я додав Developmentяк своє середовище.

   

2. Потім у своєму проекті створіть новий appsettings.{environment}.jsonфайл, що включає назву середовища.

   На наступному скріншоті знайдіть два різні файли з іменами:

   • appsettings.Development.Json
   • appSetting.json

   
   

3. І нарешті, налаштуйте його на свій StartUpклас так:

   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. І нарешті, ви можете запустити його з командного рядка так:

   dotnet run --environment "Development"
   

   де "Development"назва мого оточення.

Оновлення для .NET Core 3.0+

1. Ви можете використовувати, CreateDefaultBuilderякий автоматично створюватиме і передаватиме об'єкт конфігурації до вашого класу запуску:

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

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

2. CreateDefaultBuilderавтоматично включає відповідний файл, тому додайте окремий файл налаштувань програми для кожного середовища:appsettings.Environment.json

   

3. Потім встановіть ASPNETCORE_ENVIRONMENT змінну середовища під час запуску / налагодження

Як встановити змінні середовища

Залежно від вашої IDE, є кілька місць, в яких dotnet-проекти традиційно шукають змінні середовища:

• Для Visual Studio перейдіть до Проект> Властивості> Налагодження> Змінні середовища:

  

• Для коду Visual Studio відредагуйте .vscode/launch.json> env:

  

• За допомогою налаштувань запуску редагуйте Properties/launchSettings.json> environmentVariables:

  

  Які також можна вибрати на панелі інструментів у Visual Studio

  

• Використовуючи dotnet CLI , використовуйте відповідний синтаксис для встановлення змінних середовища для вашої ОС

  Примітка : Коли додаток запускається із запуском точки , launchSettings.jsonчитається, якщо доступно, а environmentVariablesпараметри в launchSettings.json замінюють змінні середовища.

Як Host.CreateDefaultBuilderпрацює?

.NET Core 3.0 додано Host.CreateDefaultBuilderдо розширень платформи, які забезпечать ініціалізацію за замовчуванням, IConfigurationяка забезпечує конфігурацію програми за замовчуванням у наступному порядку:

1. appsettings.jsonза допомогою постачальника конфігурації JSON .
2. appsettings.Environment.jsonза допомогою постачальника конфігурації JSON . Наприклад:
   • appsettings.Production.json або
   • appsettings.Development.json
3. Секрети програми, коли програма працює в середовищі розробки.
4. Змінні середовища за допомогою постачальника конфігурації змінних середовища .
5. Аргументи командного рядка за допомогою постачальника конфігурації командного рядка .

Подальше читання - Документи MS

• Запуск програми в ASP.NET Core
• Конфігурація в ASP.NET Core
• Використовуйте кілька середовищ у ASP.NET Core

В ASP.NET Core вам краще скористатися змінними середовища, а не конфігурацією збірки для належного appsettings.json

1. Клацніть правою кнопкою миші на своєму проекті> Властивості> Налагодження> Змінні середовища

   

2. ASP.NET Core використовуватиме відповідний файл appsettings.json:

   

3. Тепер ви можете використовувати цю змінну середовища так:

   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();
   }
   

Примітка : Якщо ви використовуєте відповідь @ Dmitry , у вас можуть виникнути проблеми, наприклад. при перевизначенні значень appsettings.json в Azure.

Ви можете використовувати змінні середовища та ConfigurationBuilderклас у своєму Startupконструкторі так:

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();
}

Потім ви створюєте appsettings.xxx.jsonфайл для кожного необхідного вам середовища, а "xxx" - це ім'я середовища. Зверніть увагу, що ви можете помістити всі глобальні значення конфігурації у свій "звичайний" appsettings.jsonфайл і до цих нових файлів додавати лише матеріали, що стосуються середовища.

Тепер вам потрібна лише змінна середовища, що викликається ASPNETCORE_ENVIRONMENTз певним значенням середовища ("live", "staging", "production", що завгодно). Ви можете вказати цю змінну в налаштуваннях проекту для свого середовища розробки, і, звичайно, вам потрібно встановити її також у своєму проміжному та виробничому середовищі. Те, як ви це робите там, залежить від того, яке це середовище.

ОНОВЛЕННЯ: Я щойно зрозумів, що ви хочете вибрати на appsettings.xxx.jsonоснові вашої поточної конфігурації збірки . Цього неможливо досягти за допомогою запропонованого мною рішення, і я не знаю, чи є спосіб зробити це. Однак спосіб "змінної середовища" працює і може також бути хорошою альтернативою вашому підходу.

Просто оновлення для користувачів .NET core 2.0. Ви можете вказати конфігурацію програми після виклику 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. Створіть кілька файлів, таких як:appSettings.$(Configuration).json

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

2. Створіть подію попередньої збірки на проекті, яка копіює відповідний файл до appSettings.json:

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

3. Використовуйте лише appSettings.jsonу вашому Config Builder:

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

Ви можете додати ім'я конфігурації як ASPNETCORE_ENVIRONMENTу, launchSettings.jsonяк показано нижче

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

Це версія, яка працює для мене при використанні консольного додатка без веб-сторінки:

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);

Файл .vscode / launch.json використовується лише Visual Studio, а також /Properties/launchSettings.json. Не використовуйте ці файли у виробництві.

Файл launchSettings.json:

1. Використовується лише на локальній машині розробки.
2. Не розгорнуто.

3. містить налаштування профілю.

   • Значення середовища, встановлені в launchSettings.json, замінюють значення, встановлені в системному середовищі

Наприклад, щоб використовувати файл 'appSettings.QA.json'. Ви можете використовувати 'ASPNETCORE_ENVIRONMENT'. Виконайте наведені нижче дії.

1. Додайте нову змінну середовища на хост-машині та назвіть її "ASPNETCORE_ENVIRONMENT". Встановіть для його значення значення «QA».
2. Створіть у своєму проекті файл 'appSettings.QA.json'. Додайте свою конфігурацію сюди.
3. Розгорніть на машині на кроці 1. Переконайтеся, що appSettings.QA.json розгорнуто.
4. Завантажте свій веб-сайт. Очікуйте, що тут буде застосовано appSettings.QA.json.