ASP.NET Core 支持一个新的配置系统，如下所示： https://docs.asp.net/en/latest/fundamentals/configuration.html
.NET Core 控制台应用程序是否也支持此模型？
如果不是之前的app.config 和ConfigurationManager 模型的替代品是什么？
【问题讨论】：
标签： c# .net-core configuration console-application
对于 .NET Core 2.0 控制台应用程序，我执行了以下操作：
{ "myKey1" : "my test value 1", "myKey2" : "my test value 2", "foo" : "bar" }
配置在构建项目时将文件复制到输出目录（在 VS -> 解决方案资源管理器 -> 右键单击文件 -> 选择“属性” -> 高级 -> 复制到输出目录 -> 选择“始终复制”）
在我的项目中安装以下 nuget 包：
将以下内容添加到 Program.cs（或 Main() 所在的任何位置）：
static void Main(string[] args)
{
var builder = new ConfigurationBuilder()
.SetBasePath(Directory.GetCurrentDirectory())
.AddJsonFile("appsettings.json");
var configuration = builder.Build();
// rest of code...
}
然后使用以下任一方式读取值：
string myKey1 = configuration["myKey1"];
Console.WriteLine(myKey1);
string foo = configuration.GetSection("foo").Value;
Console.WriteLine(foo);
【讨论】：
IConfigurationRoot is still available in .NET Core 2.0。它继承自IConfiguration，但它被认为是a derived case of it that's not commonly used。无论如何，代码示例已更新为不包含它并避免任何混淆。
您可以使用此代码 sn-p。它包括配置和 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<FmDataContext>(o => o.UseNpgsql(connectionString), ServiceLifetime.Transient);
services.AddTransient<IPackageFileService, PackageFileServiceImpl>();
var serviceProvider = services.BuildServiceProvider();
var packageFileService = serviceProvider.GetRequiredService<IPackageFileService>();
............
}
}
哦，别忘了在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"
]
},
...
}
【讨论】：
Directory.GetCurrentDirectory() 而不是AppContext.BaseDirectory。之后应该不需要破解。
SetBasePath 方法，除非您添加Microsoft.Extensions.Configuration.FileExtensions。没有AddJsonFile 没有Microsoft.Extensions.Configuration.Json
string environment = Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT"); 这太业余了。您可以通过设置全局变量来搞砸其他应用程序。你不能同时运行 dev 和 prod。使用 netcore 后 MS 质量大幅下降
如果您使用Microsoft.Extensions.Hosting（版本 2.1.0+）来托管您的控制台应用程序和 asp.net 核心应用程序，则您的所有配置都将使用HostBuilder 的ConfigureAppConfiguration 和ConfigureHostConfiguration 方法注入。这是关于如何添加appsettings.json 和环境变量的演示：
var hostBuilder = new HostBuilder()
.ConfigureHostConfiguration(config =>
{
config.AddEnvironmentVariables();
if (args != null)
{
// enviroment from command line
// e.g.: dotnet run --environment "Staging"
config.AddCommandLine(args);
}
})
.ConfigureAppConfiguration((context, builder) =>
{
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
//;
为了编译上面的代码，你需要添加这些包：
<PackageReference Include="Microsoft.Extensions.Configuration" Version="2.1.0" />
<PackageReference Include="Microsoft.Extensions.Configuration.CommandLine" Version="2.1.0" />
<PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" Version="2.1.0" />
<PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="2.1.0" />
<PackageReference Include="Microsoft.Extensions.Hosting" Version="2.1.0" />
【讨论】：
ASPNETCORE_ENVIRONMENT，但是context.HostingEnvironment.EnvironmentName 没有正确设置
new HostBuilder() 之后，这个解决方案的全部 不是多余的吗？ HostBuilder 不都是在内部做的吗？
我错了。您可以在 netcore 控制台应用程序中使用新的 ConfigurationBuilder。
有关示例，请参阅 https://docs.asp.net/en/latest/fundamentals/configuration.html。
但是，只有 aspnet 核心具有开箱即用的依赖注入功能，因此您无法拥有强类型配置设置并使用 IOptions 自动注入它们。
【讨论】：
Microsoft.Extensions.Options 并致电service.AddOptions();
ConfigureWebHostDefaults() 调用是可选的，并且仅适用于 Web 应用程序。
在 .Net Core 3.1 上，我们只需要这样做：
static void Main(string[] args)
{
var configuration = new ConfigurationBuilder().AddJsonFile("appsettings.json").Build();
}
使用 SeriLog 将如下所示：
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();
}
}
}
}
每天生成一个文件的 Serilog appsetings.json 部分如下所示：
"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"
}
}
]
}
【讨论】：
如果您使用.netcore 3.1 最简单的方法是使用新的配置系统调用静态类Host 的CreateDefaultBuilder 方法并配置应用程序
public class Program
{
public static void Main(string[] args)
{
Host.CreateDefaultBuilder(args)
.ConfigureAppConfiguration((context, config) =>
{
IHostEnvironment env = context.HostingEnvironment;
config.AddEnvironmentVariables()
// copy configuration files to output directory
.AddJsonFile("appsettings.json")
// default prefix for environment variables is DOTNET_
.AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
.AddCommandLine(args);
})
.ConfigureServices(services =>
{
services.AddSingleton<IHostedService, MySimpleService>();
})
.Build()
.Run();
}
}
class MySimpleService : IHostedService
{
public Task StartAsync(CancellationToken cancellationToken)
{
Console.WriteLine("StartAsync");
return Task.CompletedTask;
}
public Task StopAsync(CancellationToken cancellationToken)
{
Console.WriteLine("StopAsync");
return Task.CompletedTask;
}
}
您需要为文件 appsettings.json 和 appsettings.{environment}.json 设置 Copy to Output Directory = 'Copy if newer'
您还可以设置环境变量 {prefix}ENVIRONMENT（默认前缀是 DOTNET）以允许选择特定的配置参数。
.csproj 文件：
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>netcoreapp3.1</TargetFramework>
<RootNamespace>ConsoleApplication3</RootNamespace>
<AssemblyName>ConsoleApplication3</AssemblyName>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.Extensions.Configuration" Version="3.1.7" />
<PackageReference Include="Microsoft.Extensions.Hosting" Version="3.1.7" />
</ItemGroup>
<ItemGroup>
<None Update="appsettings.Development.json">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Update="appsettings.json">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
</ItemGroup>
【讨论】：
对于 dotnet 2.x 核心控制台应用程序来说是这样的：
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 => options.AddConfiguration(configuration).AddConsole())
.AddSingleton<IConfiguration>(configuration)
.AddSingleton<SomeService>()
.BuildServiceProvider();
[...]
await serviceProvider.GetService<SomeService>().Start();
你可以在SomeService中注入ILoggerFactory、IConfiguration。
【讨论】：
安装这些软件包：
代码：
static void Main(string[] args)
{
var environmentName = Environment.GetEnvironmentVariable("ENVIRONMENT");
Console.WriteLine("ENVIRONMENT: " + environmentName);
var builder = new ConfigurationBuilder()
.SetBasePath(Directory.GetCurrentDirectory())
.AddJsonFile("appsettings.json", false)
.AddJsonFile($"appsettings.{environmentName}.json", true)
.AddEnvironmentVariables();
IConfigurationRoot configuration = builder.Build();
var mySettingsConfig = configuration.Get<MySettingsConfig>();
Console.WriteLine("URL: " + mySettingsConfig.Url);
Console.WriteLine("NAME: " + mySettingsConfig.Name);
Console.ReadKey();
}
MySettingsConfig 类：
public class MySettingsConfig
{
public string Url { get; set; }
public string Name { get; set; }
}
【讨论】：
您可以为此使用LiteWare.Configuration 库。它与 .NET Framework 原始 ConfigurationManager 非常相似，适用于 .NET Core/Standard。代码方面，你最终会得到类似的东西：
string cacheDirectory = ConfigurationManager.AppSettings.GetValue<string>("CacheDirectory");
ulong cacheFileSize = ConfigurationManager.AppSettings.GetValue<ulong>("CacheFileSize");
免责声明：我是 LiteWare.Configuration 的作者。
【讨论】：
只是堆积...类似于周飞宇的帖子。这里我添加机器名称。
public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
WebHost.CreateDefaultBuilder(args)
.ConfigureAppConfiguration((context, builder) =>
{
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<Startup>();
}
【讨论】：
其他解决方案有效，但如果您想在其他服务中注入 IConfigurationRoot 则不行。我就是这样做的：
然后安装Microsoft.Extensions.Configuration.Json
static void Main(string[] args)
{
var serviceProvider = new ServiceCollection()
.AddSingleton(_ =>
new ConfigurationBuilder()
.SetBasePath(Path.Combine(AppContext.BaseDirectory))
.AddJsonFile("appsettings.json", optional: true)
.Build())
.BuildServiceProvider();
// Rest of code ...
}
并在其他服务中注入或使用
serviceProvider.GetService<IConfigurationRoot>()
【讨论】：