• 如何在 ASP.NET Core 的 .json 文件中读取 AppSettings ?
  • 发布于 2个月前
  • 513 热度
    0 评论
  • 遥歌
  • 2 粉丝 35 篇博客
  •   
咨询区
Oluwafemi:
在 appsettings.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 中做等价处理 ?
回答区
Yuval Itzchakov:
要想在 ASP.NET Core 中使用 settings 的话?推荐的做法是:在 Startup 类中初始化 Configuration,然后再使用 Options 模式访问 Configuration 中的具体某个配置节,为了方便讲解,参考下面的例子。
{
  "MyConfig": {
   "ApplicationName": "MyApp",
   "Version": "1.0.0"
   }
}
然后再配套一个 POCO 类,类定义如下:
public class MyConfig
{
    public string ApplicationName { get; set; }
    public int Version { get; set; }
}
现在就可以在 Startup.cs 中构建 Configuration 了。
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 配置文件名即可。
如果你想将 configuration 注入到 Controller 中,需要在 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"));
}
然后就可以注入到 Controller 中了。
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"));
    }
}
点评区
想在 Appsettings.json 中获取具体配置信息,我还特意看了下项目中是如何实现的🤣,大体上分两种。
1.层级读取
services.AddTransient<IDbConnection>(db => new MySqlConnection(Configuration.GetSection("Config")["ConnectionString"]));
2.Options 方式读取
    services.Configure<AppSettingConfig>(Configuration.GetSection("Config"));
    services.Configure<ExternalApiConfig>(Configuration.GetSection("ExternalAPI"));
如果不想定义适配类,那就直接用第一种即可,简单粗暴,如果想使用便捷,体现面向对象思想的话,那就用第二种啦 !!!

用户评论