ASP。NET 5（vNext）-获取配置设置

Question

我正在写一个学习ASP的基本应用程序。净5。我发现一个非常令人困惑的领域是配置。在ASP之前。NET 5，我可以做以下几点：

var settingValue = ConfigurationManager.AppSettings["SomeKey"];

我会在我的代码中散布这样的代码行。现在，在vNext世界中，我有一个配置。json文件，如下所示：

配置。json

{
  "AppSettings": {
    "SomeKey":"SomeValue"
  }
}

然后在创业阶段。cs，我有以下几点：启动。反恐精英

public IConfiguration Configuration { get; set; }
public Startup(IHostingEnvironment environment) 
{
  Configuration = new Configuration()
      .AddJsonFile("config.json");
}

从那以后，我完全不知所措。我有我的课。cs in/src/Website/Code/Models/MyClass。反恐精英。

我的班级。反恐精英

public class MyClass
{
  public string DoSomething() 
  {
    var result = string.Empty;
    var keyValue = string.Empty; // TODO: What do I do here? How do I get the value of "AppSettings:SomeKey"?
    return result;
  }
}

如何获取“AppSettings:SomeKey”的值？

Answer 1

我强烈建议使用选项model，而不是直接读取配置。它允许强类型模型绑定到配置。

下面是一个例子：GitHub。com/aspnet/Options/test/Microsoft。扩展。选项。测试/选项测试。反恐精英

针对您的具体情况创建一个模型：

class AppSettings {
    public string SomeSetting {get;set;}
}

然后将其绑定到您的配置：

var config = // The configuration object
var options = ConfigurationBinder.Bind<AppSettings>(config); 
Console.WriteLine(options.SomeSetting);

这样你就不必担心设置来自哪里，它是如何存储的，或者它的结构是什么。你只需预先定义你的选项模型，奇迹就会发生。

Answer 2

我使用ASP. NET 5依赖注入，就像这样。

config.json：

{
    "random":  "Hello World!"
}

创业。反恐精英：

public class Startup
{
    public Startup(IHostingEnvironment env, IApplicationEnvironment appEnv)
    {
        var builder = new ConfigurationBuilder(appEnv.ApplicationBasePath)
            .AddJsonFile("config.json");

        Configuration = builder.Build();
    }

    public IConfiguration Configuration { get; set; }

    public void ConfigureServices(IServiceCollection services)
    {
        services.AddMvc();
        services.AddSingleton<IConfiguration>(sp => { return Configuration; });
    }

    public void Configure(IApplicationBuilder app)
    {
        app.UseMvc(routes =>
        {
            routes.MapRoute(name: "default", template: "{controller=Home}/{action=Index}/{id?}");
        });

    }

}

控制器：

public class HomeController : Controller
{

    IConfiguration config;

    public HomeController(IConfiguration config)
    {
        this.config = config;
    }

    public IActionResult Index()
    {
        var template = "<marquee>{0}</marquee>";
        var content = string.Format(template, config.Get("random"));
        return Content(content, "text/html");
    }
}

Answer 3

ASP。NET 5大量使用依赖项注入，所以如果您也使用依赖项注入，那么这非常简单。如果查看示例MVC6项目，您可以看到它是如何工作的：

首先，属性中定义了一个类AppSettings，它是类支持的选项的强类型版本。在示例项目中，它只包含SiteTitle。

public class AppSettings
{
    public string SiteTitle { get; set; }
}

然后，通过ConfigureServices中的依赖项注入初始化该类<代码>配置这是您在Startup类的构造函数中创建的一个。

public void ConfigureServices(IServiceCollection services)
{
    services.Configure<AppSettings>(Configuration.GetSubKey("AppSettings"));
    // ...
}

然后，假设您的类是由依赖项注入容器实例化的，您只需请求一个IOptions，就可以得到一个。例如，在控制器中，您可以具有以下功能：

public class HomeController
{
    private string _title;
    public HomeController(IOptions<AppSettings> settings) 
    {
        _title = settings.Options.SiteTitle;
    }
}