Définir automatiquement appsettings.json pour les environnements dev et release dans asp.net core ?

Question

J'ai défini certaines valeurs dans mon appsettings.json pour des éléments tels que les chaînes de connexion à la base de données, les emplacements des webapis et autres, qui sont différents pour les environnements de développement, de simulation et réels.

Existe-t-il un moyen d'avoir plusieurs appsettings.json (comme appsettings.live.json ) et que l'application asp.net " sache " laquelle utiliser en fonction de la configuration de construction qu'elle exécute ?

Answer 1

J'ai ajouté des captures d'écran d'un environnement de travail, parce que cela m'a coûté plusieurs heures de recherche et développement.

1. Tout d'abord, ajoutez une clé à votre launch.json fichier.

   Voir la capture d'écran ci-dessous, j'ai ajouté Development comme mon environnement.

   

2. Ensuite, dans votre projet, créez un nouveau appsettings.{environment}.json qui inclut le nom de l'environnement.

   Dans la capture d'écran suivante, recherchez deux fichiers différents avec les noms :

   • appsettings.Development.Json
   • appSetting.json

   

3. Et enfin, configurez-le à votre StartUp comme ceci :

   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. Et enfin, vous pouvez le lancer depuis la ligne de commande comme ceci :

   dotnet run --environment "Development"

   où "Development" est le nom de mon environnement.

Answer 2

Dans ASP.NET Core, vous devriez plutôt utiliser les variables d'environnement au lieu de la configuration de construction pour les appsettings.json appropriés.

1. Cliquez à droite sur votre projet > Propriétés > Debug > Variables d'environnement.

   

2. ASP.NET Core utilisera le fichier appsettings.json approprié :

   

3. Maintenant vous pouvez utiliser cette variable d'environnement comme ceci :

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

Note : Si vous utilisez Réponse de @Dmitry vous pouvez rencontrer des problèmes, par exemple lorsque Remplacer les valeurs de appsettings.json sur Azure.

Answer 3

Vous pouvez utiliser les variables d'environnement et la fonction ConfigurationBuilder dans votre Startup Constructeur comme ceci :

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

Ensuite, vous créez un appsettings.xxx.json pour chaque environnement dont vous avez besoin, "xxx" étant le nom de l'environnement. Notez que vous pouvez placer toutes les valeurs de configuration globale dans votre fichier "normal". appsettings.json et ne mettez que les éléments spécifiques à l'environnement dans ces nouveaux fichiers.

Maintenant, vous avez seulement besoin d'une variable d'environnement appelée ASPNETCORE_ENVIRONMENT avec une valeur d'environnement spécifique ("live", "staging", "production", etc.). Vous pouvez spécifier cette variable dans les paramètres de votre projet pour votre environnement de développement, et bien sûr, vous devez également la définir dans vos environnements de production et de stockage. La façon dont vous le faites dépend du type d'environnement dont il s'agit.

UPDATE : Je viens de réaliser que vous voulez choisir le appsettings.xxx.json en fonction de votre configuration de construction . Cela ne peut être réalisé avec la solution que je propose et je ne sais pas s'il existe un moyen de le faire. La méthode de la "variable d'environnement", cependant, fonctionne et pourrait aussi bien être une bonne alternative à votre approche.

Answer 4

Vous pouvez utiliser la compilation conditionnelle :

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

Answer 5

Juste une mise à jour pour les utilisateurs de .NET core 2.0, vous pouvez spécifier la configuration de l'application après l'appel à 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);

   }
 }