我已经按照以下方式在appsettings/Config.json文件中设置了我的AppSettings数据:
{
"AppSettings": {
"token": "1234"
}
}
我在网上搜索了如何从 .json 文件中读取 AppSettings 值的方法，但是没有找到有用的信息。
我尝试过：
var configuration = new Configuration();
var appSettings = configuration.Get("AppSettings"); // null
var token = configuration.Get("token"); // null
我知道在 ASP.NET 4.0 中你可以这样做：
System.Configuration.ConfigurationManager.AppSettings["token"];
但是在ASP.NET Core中我该如何实现这个呢？
这个问题经历了一些曲折。我已经修改了这个答案，使其与ASP.NET Core 2.0保持最新状态（截至2018年2月26日）。
这主要来自官方文档：
要在ASP.NET应用程序中使用设置，建议您只在应用程序的Startup类中实例化一个Configuration，然后使用选项模式访问单个设置。假设我们有一个类似于appsettings.json的文件，如下所示：
{
"MyConfig": {
"ApplicationName": "MyApp",
"Version": "1.0.0"
}
}
我们有一个代表配置的POCO对象：
public class MyConfig
{
public string ApplicationName { get; set; }
public int Version { get; set; }
}
现在我们在Startup.cs中构建配置:
public class Startup
{
public IConfigurationRoot Configuration { get; set; }
public Startup(IHostingEnvironment env)
{
var builder = new ConfigurationBuilder()
.SetBasePath(env.ContentRootPath)
.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);
Configuration = builder.Build();
}
}
注意，在.NET Core 2.0中，默认情况下将注册appsettings.json。如果需要，我们还可以针对每个环境注册一个appsettings.{Environment}.json配置文件。
如果我们想将配置注入到控制器中，我们需要在运行时中注册它。我们可以通过Startup.ConfigureServices来实现：
public void ConfigureServices(IServiceCollection services)
{
services.AddMvc();
// Add functionality to inject IOptions<T>
services.AddOptions();
// Add our Config object so it can be injected
services.Configure<MyConfig>(Configuration.GetSection("MyConfig"));
}
我们这样进行注入：
public class HomeController : Controller
{
private readonly IOptions<MyConfig> config;
public HomeController(IOptions<MyConfig> config)
{
this.config = config;
}
// GET: /<controller>/
public IActionResult Index() => View(config.Value);
}
完整的Startup类：
public class Startup
{
public IConfigurationRoot Configuration { get; set; }
public Startup(IHostingEnvironment env)
{
var builder = new ConfigurationBuilder()
.SetBasePath(env.ContentRootPath)
.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);
Configuration = builder.Build();
}
public void ConfigureServices(IServiceCollection services)
{
services.AddMvc();
// Add functionality to inject IOptions<T>
services.AddOptions();
// Add our Config object so it can be injected
services.Configure<MyConfig>(Configuration.GetSection("MyConfig"));
}
}
Microsoft.Extensions.Options.ConfigurationExtensions 后，它按预期工作。 - Peter.NET Core 3.0 / .NET 6
这是一种简洁而简单的解决方案。
{
"ConnectionStrings": {
"DefaultConnection": "****;"
},
"AppSettings": {
"APP_Name": "MY_Service",
"SampleIntValue": 100
}
}
顶部：
using Microsoft.Extensions.Configuration;
在你的代码中：
变量1：
var AppName = new ConfigurationBuilder().AddJsonFile("appsettings.json").Build().GetSection("AppSettings")["APP_Name"];
或者
变量2:(用于读取多个值或数字)
var MyConfig = new ConfigurationBuilder().AddJsonFile("appsettings.json").Build();
var IntExample = MyConfig.GetValue<int>("AppSettings:SampleIntValue");
var AppName = MyConfig.GetValue<string>("AppSettings:APP_Name");
.GetSection("AppSettings")["APP_Name"]。 - Steve Silberberg首先： Microsoft.Framework.ConfigurationModel 的程序集名称和命名空间已更改为 Microsoft.Framework.Configuration。因此，您应该使用： 例如：
Microsoft.Framework.Configuration
"Microsoft.Framework.Configuration.Json": "1.0.0-beta7"
在 project.json 中作为依赖项。如果你没有安装 7 版本，则使用 beta5 或 6。
然后你可以在 Startup.cs 中像这样做。
public IConfiguration Configuration { get; set; }
public Startup(IHostingEnvironment env, IApplicationEnvironment appEnv)
{
var configurationBuilder = new ConfigurationBuilder(appEnv.ApplicationBasePath)
.AddJsonFile("config.json")
.AddEnvironmentVariables();
Configuration = configurationBuilder.Build();
}
如果您想要从config.json中检索变量，可以直接使用以下方式获取：
public void Configure(IApplicationBuilder app)
{
// Add .Value to get the token string
var token = Configuration.GetSection("AppSettings:token");
app.Run(async (context) =>
{
await context.Response.WriteAsync("This is a token with key (" + token.Key + ") " + token.Value);
});
}
或者你可以创建一个叫做AppSettings的类，像这样：
public class AppSettings
{
public string token { get; set; }
}
然后像这样配置服务：
public void ConfigureServices(IServiceCollection services)
{
services.AddMvc();
services.Configure<MvcOptions>(options =>
{
//mvc options
});
services.Configure<AppSettings>(Configuration.GetSection("AppSettings"));
}
然后可以通过像这样的控制器访问它：
public class HomeController : Controller
{
private string _token;
public HomeController(IOptions<AppSettings> settings)
{
_token = settings.Options.token;
}
}
Configuration.Get<AppSettings>() 将整个文件反序列化，而不是只反序列化特定部分。 - Nilay Mehta对于.NET Core 2.0，有些变化。启动构造函数以Configuration对象作为参数，所以不需要使用ConfigurationBuilder。这是我的：
public Startup(IConfiguration configuration)
{
Configuration = configuration;
}
public IConfiguration Configuration { get; }
// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
services.Configure<StorageOptions>(Configuration.GetSection("AzureStorageConfig"));
}
我的POCO是顶部提到的StorageOptions对象：
namespace FictionalWebApp.Models
{
public class StorageOptions
{
public String StorageConnectionString { get; set; }
public String AccountName { get; set; }
public String AccountKey { get; set; }
public String DefaultEndpointsProtocol { get; set; }
public String EndpointSuffix { get; set; }
public StorageOptions() { }
}
}
而配置实际上是我的appsettings.json文件的一个子部分，名为AzureStorageConfig：
{
"ConnectionStrings": {
"DefaultConnection": "Server=(localdb)\\mssqllocaldb;",
"StorageConnectionString": "DefaultEndpointsProtocol=https;AccountName=fictionalwebapp;AccountKey=Cng4Afwlk242-23=-_d2ksa69*2xM0jLUUxoAw==;EndpointSuffix=core.windows.net"
},
"Logging": {
"IncludeScopes": false,
"LogLevel": {
"Default": "Warning"
}
},
"AzureStorageConfig": {
"AccountName": "fictionalwebapp",
"AccountKey": "Cng4Afwlk242-23=-_d2ksa69*2xM0jLUUxoAw==",
"DefaultEndpointsProtocol": "https",
"EndpointSuffix": "core.windows.net",
"StorageConnectionString": "DefaultEndpointsProtocol=https;AccountName=fictionalwebapp;AccountKey=Cng4Afwlk242-23=-_d2ksa69*2xM0jLUUxoAw==;EndpointSuffix=core.windows.net"
}
}
我唯一需要补充的是，由于构造函数已更改，我尚未测试是否需要执行额外操作才能加载appsettings.<environmentname>.json而不是appsettings.json。
public HomeController(IOptions<StorageOptions> settings)，我会得到以下错误信息：模型绑定的复杂类型不能是抽象或值类型，并且必须具有无参数构造函数。 - Jpsy使用 .NET Core 2.2，以最简单的方式...
public IActionResult Index([FromServices] IConfiguration config)
{
var myValue = config.GetValue<string>("MyKey");
}
appsettings.json会自动加载，可以通过构造函数或操作注入调用，而且IConfiguration还有一个GetSection方法。如果你只需要使用appsettings.json，则不需要修改Startup.cs或Program.cs文件。
var myValue = config["MyKey"]。该语句可以从名为“config”的对象中获取键名为“MyKey”的值，并将其赋给名为“myValue”的变量。 - jokab如果你只想获取令牌的值，那么使用：
Configuration["AppSettings:token"]
我怀疑这不是一个好的实践，但本地工作正常。如果在发布/部署（到IIS Web服务）时失败，我将更新此内容。
步骤1 - 将此程序集添加到您的类顶部（在我的情况下，控制器类）：
using Microsoft.Extensions.Configuration;
第二步 - 添加这个或类似的内容：
var config = new ConfigurationBuilder()
.SetBasePath(Directory.GetCurrentDirectory())
.AddJsonFile("appsettings.json").Build();
第三步 - 通过以下方式调用您的密钥值（返回字符串）：
config["NameOfYourKey"]
appsettings.json 文件在正确的目录中，这应该是没问题的。 - Ju66ernautProgram.cs中会有以下配置行：Host.CreateDefaultBuilder(args)
这使得以下内容可行:
这意味着您可以注入IConfiguration并使用字符串键获取值，甚至可以嵌套值。例如：IConfiguration ["Parent:Child"];
示例：
appsettings.json
{
"ApplicationInsights":
{
"Instrumentationkey":"putrealikeyhere"
}
}
天气预报.cs
[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
private static readonly string[] Summaries = new[]
{
"Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
};
private readonly ILogger<WeatherForecastController> _logger;
private readonly IConfiguration _configuration;
public WeatherForecastController(ILogger<WeatherForecastController> logger, IConfiguration configuration)
{
_logger = logger;
_configuration = configuration;
}
[HttpGet]
public IEnumerable<WeatherForecast> Get()
{
var key = _configuration["ApplicationInsights:InstrumentationKey"];
var rng = new Random();
return Enumerable.Range(1, 5).Select(index => new WeatherForecast
{
Date = DateTime.Now.AddDays(index),
TemperatureC = rng.Next(-20, 55),
Summary = Summaries[rng.Next(Summaries.Length)]
})
.ToArray();
}
}
这对我很有用.Net 5/6
我有一个 appsettings.development.json 文件。我选择了“Development”环境，所以我的开发环境中有设置在development.json 文件中。你可以使用带有默认环境的 appsettings.josn。
使用此配置
创建一个带有配置属性的类
在 Startup 中注册我的调用
现在我可以在我的控制器中访问
安装以下 NuGet 包（.csproj）；
<ItemGroup>
<PackageReference Include="Microsoft.Extensions.Configuration" Version="2.2.0-preview2-35157" />
<PackageReference Include="Microsoft.Extensions.Configuration.FileExtensions" Version="2.2.0-preview2-35157" />
<PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="2.2.0-preview2-35157" />
</ItemGroup>
在根目录创建appsettings.json文件。右键单击该文件，并选择“复制到输出目录”作为“如果较新则复制”。
示例配置文件：
{
"AppConfig": {
"FilePath": "C:\\temp\\logs\\output.txt"
}
}
Program.cs
configurationSection.Key和configurationSection.Value将包含配置属性。
static void Main(string[] args)
{
try
{
IConfigurationBuilder builder = new ConfigurationBuilder()
.SetBasePath(Directory.GetCurrentDirectory())
.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);
IConfigurationRoot configuration = builder.Build();
// configurationSection.Key => FilePath
// configurationSection.Value => C:\\temp\\logs\\output.txt
IConfigurationSection configurationSection = configuration.GetSection("AppConfig").GetSection("FilePath");
}
catch (Exception e)
{
Console.WriteLine(e);
}
}