在.NET应用开发中,不同环境往往需要不同的配置参数,比如开发环境连接本地数据库,生产环境连接线上数据库,硬编码配置会导致后期维护成本极高。.NET内置的配置系统可以很好地解决这个问题,它支持多来源配置读取、优先级覆盖,能轻松实现不同环境的配置管理。

.NET配置系统的核心概念
.NET配置系统的核心是IConfiguration接口,它提供了统一的方式读取各个来源的配置数据。配置数据以键值对的形式存在,支持分层结构,比如Database:ConnectionString这样的键可以对应配置中的嵌套节点。
常见的配置来源包括:
- JSON文件:比如默认的appsettings.json和按环境命名的appsettings.Development.json
- 环境变量:系统或进程级别的环境变量,适合生产环境配置
- 命令行参数:启动应用时传入的参数
- 自定义配置源:开发者可以扩展实现自己的配置读取逻辑
不同环境配置的优先级规则
.NET配置系统有默认的加载顺序,后加载的配置会覆盖先加载的同名配置,默认优先级从高到低为:
- 命令行参数
- 环境变量
- 按环境命名的appsettings文件(如appsettings.Production.json)
- 默认appsettings.json
这个顺序意味着如果同时在环境变量和appsettings文件中配置了同一个键,环境变量的值会生效,非常适合生产环境不修改文件直接使用环境变量切换配置的场景。
多环境配置的实现步骤
1. 添加基础配置文件
首先在项目的根目录添加默认的appsettings.json,存放通用的配置:
{
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft.AspNetCore": "Warning"
}
},
"Database": {
"ConnectionString": "Server=localhost;Database=TestDB;Uid=root;Pwd=123456;"
},
"AllowedHosts": "*"
}
2. 添加环境专属配置文件
根据需要的环境添加对应的配置文件,比如开发环境添加appsettings.Development.json,生产环境添加appsettings.Production.json。开发环境配置示例:
{
"Database": {
"ConnectionString": "Server=localhost;Database=DevDB;Uid=dev_user;Pwd=dev_pwd;"
},
"Logging": {
"LogLevel": {
"Default": "Debug"
}
}
}
生产环境配置示例:
{
"Database": {
"ConnectionString": "Server=prod-server;Database=ProdDB;Uid=prod_user;Pwd=prod_strong_pwd;"
},
"Logging": {
"LogLevel": {
"Default": "Warning"
}
}
}
3. 配置环境加载逻辑
在Program.cs中配置环境相关的配置加载,默认模板已经包含了基础逻辑,可根据需要调整:
var builder = WebApplication.CreateBuilder(args);
// 默认已经加载了appsettings.json和appsettings.{EnvironmentName}.json
// 如果需要添加其他配置源可以在这里扩展
// 比如添加环境变量配置,默认已经包含,无需额外添加
// builder.Configuration.AddEnvironmentVariables();
var app = builder.Build();
app.MapGet("/", (IConfiguration configuration) =>
{
// 读取数据库配置
var dbConn = configuration["Database:ConnectionString"];
return $"当前数据库连接字符串:{dbConn}";
});
app.Run();
4. 设置运行环境
可以通过环境变量ASPNETCORE_ENVIRONMENT来指定当前运行的环境,常见值有Development、Staging、Production。比如在开发环境启动应用时设置:
# Linux/Mac系统 export ASPNETCORE_ENVIRONMENT=Development dotnet run # Windows系统(PowerShell) $env:ASPNETCORE_ENVIRONMENT="Development" dotnet run
代码中读取配置的常见方式
直接通过IConfiguration读取
可以在需要的地方注入IConfiguration接口直接读取配置:
public class UserService
{
private readonly IConfiguration _configuration;
public UserService(IConfiguration configuration)
{
_configuration = configuration;
}
public void PrintDbConfig()
{
// 读取分层配置
var connStr = _configuration["Database:ConnectionString"];
var logLevel = _configuration["Logging:LogLevel:Default"];
Console.WriteLine($"数据库配置:{connStr},日志级别:{logLevel}");
}
}
绑定到强类型配置类
更推荐的方式是定义强类型配置类,将配置绑定到类实例,避免硬编码键名:
// 定义配置类
public class DatabaseOptions
{
public const string SectionName = "Database";
public string ConnectionString { get; set; } = string.Empty;
}
public class LoggingOptions
{
public const string SectionName = "Logging";
public LogLevelOptions LogLevel { get; set; } = new();
}
public class LogLevelOptions
{
public string Default { get; set; } = string.Empty;
public string MicrosoftAspNetCore { get; set; } = string.Empty;
}
然后在Program.cs中注册配置:
var builder = WebApplication.CreateBuilder(args);
// 绑定配置到强类型类
builder.Services.Configure<DatabaseOptions>(
builder.Configuration.GetSection(DatabaseOptions.SectionName));
builder.Services.Configure<LoggingOptions>(
builder.Configuration.GetSection(LoggingOptions.SectionName));
var app = builder.Build();
app.MapGet("/config", (IOptions<DatabaseOptions> dbOptions, IOptions<LoggingOptions> logOptions) =>
{
return new
{
DbConnection = dbOptions.Value.ConnectionString,
DefaultLogLevel = logOptions.Value.LogLevel.Default
};
});
app.Run();
注意事项
- 敏感配置比如生产环境的数据库密码,不要写在JSON文件里,建议使用环境变量或者密钥管理服务存储
- 环境名称的拼写要准确,默认支持的环境名称是区分大小写的,开发时建议统一使用首字母大写的形式
- 如果在配置文件中使用了数组,读取时可以用索引访问,比如
configuration["AllowedHosts:0"]获取数组第一个元素 - 自定义配置源时需要实现
IConfigurationSource和IConfigurationProvider接口,然后添加到ConfigurationBuilder中
.NET_Configurationappsettings环境变量IConfiguration修改时间:2026-06-13 18:27:41