我的应用程序使用 appsettings.json 进行某些设置。如果 appsettings.local.json 存在,则应覆盖 appsettings.json 中包含的任何设置。到目前为止,没有问题。
但是我使用git进行版本控制。显然,我不希望其他用户删除我的本地设置。所以我 git 忽略 appsettings.json。
此外,解决方案中有很多项目。他们共享相同的设置。因此,解决方案级别有一个 appsettings.json,所有项目都将其作为链接包含。
仍然很好,除了一件事。为了可用,我必须将 appsettings.local.json 复制到输出目录。但它不应该在版本控制中。因此,如果有人克隆新的解决方案,他们将不会拥有它。这应该没问题,但事实并非如此。 VS。说“这个文件应该被链接,但它到底在哪里?”构建错误。
我该如何应对?
对于 v2,这非常简单。
appsettings.local.json
添加到您的项目中(它应该嵌套在主 appsettings.json
文件下方)。appsettings.local.json
添加到您的 .gitignore
在构造函数中的
startup.cs
中执行以下操作:
public class Startup
{
public IConfigurationRoot Configuration { get; }
public Startup(IHostingEnvironment env)
{
var builder = new ConfigurationBuilder()
.SetBasePath(env.ContentRootPath)
.AddJsonFile("appsettings.json", optional: false, reloadOnChange: true) //load base settings
.AddJsonFile("appsettings.local.json", optional: true, reloadOnChange: true) //load local settings
.AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true) //load environment settings
.AddEnvironmentVariables();
Configuration = builder.Build();
}
/*
* rest of your startup.cs
*/
}
对于 .Net Core >2.1,您可以简单地将扩展方法
ConfigureAppConfiguration(Action<WebHostBuilderContext, IConfigurationBuilder> configureDelegate)
链接到您的 WebHost。这是一个例子:
WebHost.CreateDefaultBuilder(args)
.ConfigureAppConfiguration((hostingContext, config) =>
{
config.AddJsonFile(
"appsettings.Local.json",
optional: true,
reloadOnChange: true);
})
// ...
当然忽略 .gitignore 中的 appsettings.Local.json。
对于 .NET 6,您可以使用它。
还要确保您忽略
appsettings.local.json
,以避免签入密码和机密等敏感信息。
var builder = WebApplication.CreateBuilder(args);
// Add configurations
builder.Host.ConfigureAppConfiguration((hostingContext, config) =>
{
config.Sources.Clear();
var env = hostingContext.HostingEnvironment;
config.SetBasePath(env.ContentRootPath)
.AddJsonFile("appsettings.json", optional: false, reloadOnChange: true) //load base settings
.AddJsonFile("appsettings.local.json", optional: true, reloadOnChange: true) //load local settings
.AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true) //load environment settings
.AddEnvironmentVariables();
if (args != null)
{
config.AddCommandLine(args);
}
});
不能说我喜欢将这个特定于环境的东西添加到源代码中,将其添加为像
appsetting.local.json
这样的文件似乎更干净,然后在launchSettings.json
中确保将环境变量添加为本地。
{
"profiles": {
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "local"
}
}
}
}
public class Startup
{
public IConfigurationRoot Configuration { get; }
public Startup(IHostingEnvironment env)
{
var builder = new ConfigurationBuilder()
.SetBasePath(env.ContentRootPath)
.AddJsonFile("appsettings.json", optional: false, reloadOnChange: true) //load base settings
// Avoid this nasty code in your codebase, its oddly specific for a particular environment.
//.AddJsonFile("appsettings.local.json", optional: true, reloadOnChange: true) //load local settings
.AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true) //load environment settings
.AddEnvironmentVariables();
Configuration = builder.Build();
}
/*
* rest of your startup.cs
*/
}
计划:
appsettings.local-base.json
。 appsettings.local.json
添加到 .gitignore
。 appsettings.local-base.json
作为 appsettings.local.json
复制到输出文件夹 if
appsettings.local.json
不存在。appsettings.local.json
,则不执行任何操作(它将被 VS 复制到输出文件夹)。MSBuild
Copy
目标可以在构建之前/之后有条件地复制文件。下面的目标是 Visual Studio 2017 和基于 csproj 的 .NET Core 项目的实际目标(文件名已减少):
<Project Sdk="Microsoft.NET.Sdk.Web">
<PropertyGroup>
<TargetFramework>netcoreapp1.1</TargetFramework>
</PropertyGroup>
<!--rest of file -->
<Target Name="TestTarget" AfterTargets="Build">
<ItemGroup>
<FromFile Include="src.json" />
<ToFile Include="$(OutDir)dest.json" />
</ItemGroup>
<Message Text="Copying @(FromFile) file to: @(ToFile)" Importance="high" />
<Copy
SourceFiles="@(FromFile)"
DestinationFiles="@(ToFile)"
Condition="!Exists('@(ToFile)')"
OverwriteReadOnlyFiles="true"
SkipUnchangedFiles="false" />
</Target>
</Project>
项目构建后,VS 构建输出中应出现以下消息:
将 src.json 文件复制到:bin\Debug etcoreapp1.1\dest.json
看起来这些东西变化得太快了,很难跟踪微软希望处理这些事情的“正确方式”。
在 ASP.NET Core 2 中,我相信开发人员处理每个开发人员配置值的预期方法是使用 Secret Manager。
简短摘要:在 Visual Studio 2019 中,右键单击项目并选择 管理用户机密。这会在
%APPDATA%\Microsoft\UserSecrets\...
中创建一个 JSON 文件,由 WebHost.CreateDefaultBuilders()
自动拾取(在默认 ASP.NET Core 项目中隐式调用)。
这是 Pim 的答案,但适用于没有startup.cs 文件的.Net6+ 程序。
var builder = WebApplication.CreateBuilder(args);
builder.Configuration
.SetBasePath(builder.Environment.ContentRootPath)
.AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
.AddJsonFile("appsettings.local.json", optional: true, reloadOnChange: true)
.AddJsonFile($"appsettings.{builder.Environment.EnvironmentName}.json", optional: true)
.AddEnvironmentVariables();