ASP NET Core configuration for NET Core console application

Question

ASP NET Core support a new configuration system as seen here  https   docs asp net en latest fundamentals configuration html  Is this model also supported in  NET Core console applications   If not what is alternate to the previous app config and ConfigurationManager model

User · Answer

Install these packages   Microsoft Extensions Configuration Microsoft Extensions Configuration Binder Microsoft Extensions Configuration EnvironmentVariables Microsoft Extensions Configuration FileExtensions Microsoft Extensions Configuration Json  Code  static void Main string   args                var environmentName   Environment GetEnvironmentVariable  quot ENVIRONMENT quot            Console WriteLine  quot ENVIRONMENT   quot    environmentName            var builder   new ConfigurationBuilder               SetBasePath Directory GetCurrentDirectory                AddJsonFile  quot appsettings json quot   false              AddJsonFile   quot appsettings  environmentName  json quot   true              AddEnvironmentVariables             IConfigurationRoot configuration   builder Build            var mySettingsConfig   configuration Get lt MySettingsConfig gt              Console WriteLine  quot URL   quot    mySettingsConfig Url           Console WriteLine  quot NAME   quot    mySettingsConfig Name            Console ReadKey           MySettingsConfig Class  public class MySettingsConfig       public string Url   get  set        public string Name   get  set       Your appsettings can be as simple as this   Also  set the appsettings files to Content   Copy if newer

User · Answer

It s something like this  for a dotnet 2 x core console application           using Microsoft Extensions Configuration          using Microsoft Extensions DependencyInjection          using Microsoft Extensions Logging                         var configuration   new ConfigurationBuilder                SetBasePath Directory GetCurrentDirectory                 AddJsonFile  appsettings json   optional  false  reloadOnChange  true               AddEnvironmentVariables                Build            var serviceProvider   new ServiceCollection                AddLogging options   gt  options AddConfiguration configuration  AddConsole                 AddSingleton lt IConfiguration gt  configuration               AddSingleton lt SomeService gt                 BuildServiceProvider                          await serviceProvider GetService lt SomeService gt    Start      The you could inject ILoggerFactory  IConfiguration in the SomeService

User · Answer

If you use  netcore 3 1 the simplest way use new configuration system to call CreateDefaultBuilder method of static class Host and configure application public class Program       public static void Main string   args                Host CreateDefaultBuilder args               ConfigureAppConfiguration  context  config    gt                                IHostEnvironment env   context HostingEnvironment                  config AddEnvironmentVariables                          copy configuration files to output directory                      AddJsonFile  quot appsettings json quot                          default prefix for environment variables is DOTNET                       AddJsonFile   quot appsettings  env EnvironmentName  json quot   optional  true                       AddCommandLine args                               ConfigureServices services   gt                                services AddSingleton lt IHostedService  MySimpleService gt                                 Build                Run             class MySimpleService   IHostedService       public Task StartAsync CancellationToken cancellationToken                Console WriteLine  quot StartAsync quot            return Task CompletedTask             public Task StopAsync CancellationToken cancellationToken                Console WriteLine  quot StopAsync quot            return Task CompletedTask           You need set Copy to Output Directory    Copy if newer  for the files appsettings json and appsettings  environment  json Also you can set environment variable  prefix ENVIRONMENT  default prefix is DOTNET  to allow choose specific configuration parameters   csproj file   lt PropertyGroup gt     lt OutputType gt Exe lt  OutputType gt     lt TargetFramework gt netcoreapp3 1 lt  TargetFramework gt     lt RootNamespace gt ConsoleApplication3 lt  RootNamespace gt     lt AssemblyName gt ConsoleApplication3 lt  AssemblyName gt   lt  PropertyGroup gt    lt ItemGroup gt     lt PackageReference Include  quot Microsoft Extensions Configuration quot  Version  quot 3 1 7 quot    gt     lt PackageReference Include  quot Microsoft Extensions Hosting quot  Version  quot 3 1 7 quot    gt   lt  ItemGroup gt    lt ItemGroup gt     lt None Update  quot appsettings Development json quot  gt       lt CopyToOutputDirectory gt PreserveNewest lt  CopyToOutputDirectory gt     lt  None gt     lt None Update  quot appsettings json quot  gt       lt CopyToOutputDirectory gt PreserveNewest lt  CopyToOutputDirectory gt     lt  None gt   lt  ItemGroup gt   more details  NET Generic Host

User · Answer

I was mistaken  You can use the new ConfigurationBuilder from a netcore console application   See https   docs asp net en latest fundamentals configuration html for an example   However  only aspnet core has dependency injection out of the box so you don t have the ability to have strongly typed configuration settings and automatically inject them using IOptions

User · Answer

You can use this code snippet  It includes Configuration and DI   public class Program       public static ILoggerFactory LoggerFactory      public static IConfigurationRoot Configuration       public static void Main string   args                Console OutputEncoding   Encoding UTF8           string environment   Environment GetEnvironmentVariable  ASPNETCORE ENVIRONMENT             if  String IsNullOrWhiteSpace environment               throw new ArgumentNullException  Environment not found in ASPNETCORE ENVIRONMENT             Console WriteLine  Environment   0    environment            var services   new ServiceCollection                Set up configuration sources          var builder   new ConfigurationBuilder                SetBasePath Path Combine AppContext BaseDirectory                AddJsonFile  appsettings json   optional  true           if  environment     Development                          builder                  AddJsonFile                      Path Combine AppContext BaseDirectory  string Format     0    0    0    Path DirectorySeparatorChar     appsettings  environment  json                        optional  true                                      else                       builder                  AddJsonFile   appsettings  environment  json   optional  false                      Configuration   builder Build             LoggerFactory   new LoggerFactory                AddConsole Configuration GetSection  Logging                 AddDebug             services              AddEntityFrameworkNpgsql                AddDbContext lt FmDataContext gt  o   gt  o UseNpgsql connectionString   ServiceLifetime Transient            services AddTransient lt IPackageFileService  PackageFileServiceImpl gt              var serviceProvider   services BuildServiceProvider             var packageFileService   serviceProvider GetRequiredService lt IPackageFileService gt                                     Oh  and don t forget to add in the project json       version    1 0 0-       buildOptions          emitEntryPoint   true       copyToOutput            includeFiles              appsettings json            appsettings Integration json            appsettings Production json            appsettings Staging json                         publishOptions          copyToOutput            appsettings json          appsettings Integration json          appsettings Production json          appsettings Staging json

User · Answer

Just piling on     similar to Feiyu Zhou s post  Here I m adding the machine name   public static IWebHostBuilder CreateWebHostBuilder string   args    gt          WebHost CreateDefaultBuilder args             ConfigureAppConfiguration  context  builder    gt                          var env   context HostingEnvironment              var hostname   Environment MachineName              builder AddJsonFile  appsettings json   optional  false  reloadOnChange  true                 AddJsonFile   appsettings  env EnvironmentName  json   optional  true  reloadOnChange  true                 AddJsonFile   appsettings  hostname  json   optional  true  reloadOnChange  true               builder AddEnvironmentVariables                if  args    null                              builder AddCommandLine args                                       UseStartup lt Startup gt

User · Answer

For a  NET Core 2 0 console app  I did the following    Create a new file named appsettings json at the root of the project  the file name can be anything   Add my specific settings to that file as json  For example          myKey1      my test value 1       myKey2      my test value 2       foo      bar         Configure to copy the file to the output directory whenever the project is built  in VS -  Solution Explorer -  right-click file -  select  Properties  -  Advanced -  Copy to Output Directory -  select  Copy Always   Install the following nuget package in my project    Microsoft Extensions Configuration Json  Add the following to Program cs  or wherever Main   is located    static void Main string   args        var builder   new ConfigurationBuilder            SetBasePath Directory GetCurrentDirectory             AddJsonFile  appsettings json         var configuration   builder Build            rest of code       Then read the values using either of the following ways    string myKey1   configuration  myKey1    Console WriteLine myKey1    string foo   configuration GetSection  foo   Value  Console WriteLine foo      More info  https   docs microsoft com en-us aspnet core fundamentals configuration tabs basicconfiguration simple-configuration

User · Answer

On  Net Core 3 1 we just need to do these   static void Main string   args      var configuration   new ConfigurationBuilder   AddJsonFile  appsettings json   Build        Using SeriLog will look like   using Microsoft Extensions Configuration  using Serilog  using System    namespace yournamespace       class Program                static void Main string   args                        var configuration   new ConfigurationBuilder   AddJsonFile  appsettings json   Build                Log Logger   new LoggerConfiguration   ReadFrom Configuration configuration  CreateLogger                 try                               Log Information  Starting Program                               catch  Exception ex                                Log Fatal ex   Program terminated unexpectedly                     return                            finally                               Log CloseAndFlush                                      And the Serilog appsetings json section for generating one file daily will look like      Serilog          MinimumLevel            Default    Information          Override              Microsoft    Warning            System    Warning                      Using      Serilog Sinks Console    Serilog Sinks File          WriteTo                      Name    File            Args                path    C   Logs  Program json              rollingInterval    Day              formatter    Serilog Formatting Compact CompactJsonFormatter  Serilog Formatting Compact

User · Answer

You can use LiteWare Configuration library for that  It is very similar to  NET Framework original ConfigurationManager and works for  NET Core Standard  Code-wise  you ll end up with something like   string cacheDirectory   ConfigurationManager AppSettings GetValue lt string gt   CacheDirectory    ulong cacheFileSize   ConfigurationManager AppSettings GetValue lt ulong gt   CacheFileSize      Disclaimer  I am the author of LiteWare Configuration

User · Answer

If you use Microsoft Extensions Hosting  version 2 1 0   to host your console app and asp net core app  all your configurations are injected with HostBuilder s ConfigureAppConfiguration and ConfigureHostConfiguration methods  Here s the demo about how to add the appsettings json and environment variables       var hostBuilder   new HostBuilder            ConfigureHostConfiguration config   gt                        config AddEnvironmentVariables                 if  args    null                                   enviroment from command line                    e g   dotnet run --environment  Staging                  config AddCommandLine args                                     ConfigureAppConfiguration  context  builder    gt                        var env   context HostingEnvironment              builder SetBasePath AppContext BaseDirectory               AddJsonFile  appsettings json   optional  false               AddJsonFile   appsettings  env EnvironmentName  json   optional  true                 Override config by env  using like Logging Level or Logging  Level              AddEnvironmentVariables                               add others  logging  services               In order to compile above code  you need to add these packages    lt PackageReference Include  Microsoft Extensions Configuration  Version  2 1 0    gt   lt PackageReference Include  Microsoft Extensions Configuration CommandLine  Version  2 1 0    gt   lt PackageReference Include  Microsoft Extensions Configuration EnvironmentVariables  Version  2 1 0    gt   lt PackageReference Include  Microsoft Extensions Configuration Json  Version  2 1 0    gt   lt PackageReference Include  Microsoft Extensions Hosting  Version  2 1 0    gt

[c#] ASP.NET Core configuration for .NET Core console application

Examples related to c#

Examples related to .net-core

Examples related to configuration

Examples related to console-application