ASP.NET 5 (vNext) - 获取配置设置

Question

我正在编写一个基本的应用程序来学习 ASP.NET 5。我发现 非常 令人困惑的一个领域是配置。在 ASP.NET 5 之前，我可以执行以下操作：

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

我会在我的代码中散布类似的代码行。现在，在 vNext 世界中，我有一个如下所示的 config.json 文件：

config.json

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

然后在 Startup.cs 中，我有以下内容： Startup.cs

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

从那里，我完全被难住了。我在 /src/Website/Code/Models/MyClass.cs 中有 MyClass.cs。

MyClass.cs

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;
  }
}

如何获取“Ap​​pSettings:SomeKey”的值？

Answer 1

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

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

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

然后，通过ConfigureServices中的依赖注入初始化这个类。 Configuration 这里是你在 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;
    }
}

Answer 2

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

config.json：

{
    "random":  "Hello World!"
}

startup.cs：

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

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

这里是一个例子：GitHub.com/aspnet/Options/test/Microsoft.Extensions.Options.Test/OptionsTest.cs

为您的特定情况创建一个模型：

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

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

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

这样您就不必担心设置的来源、存储方式或结构。您只需预定义您的期权模型，奇迹就会发生。

Answer 4

使用这个：

var value = Configuration.Get("AppSettings:SomeKey");

基于this blog post。冒号类似于点符号，用于向下导航。

如果你需要其他类中的值，你应该注入它。ASP.NET 已经内置了依赖注入，但是如果你只需要一个 MyClass 的实例，你可以新建它而不是设置一个 DI 容器。

public IConfiguration Configuration { get; set; }

public Startup(IHostingEnvironment environment) 
{
    Configuration = new Configuration()
      .AddJsonFile("config.json");
    //generally here you'd set up your DI container. But for now we'll just new it up
    MyClass c = new MyClass(Configuration.Get("AppSettings:SomeKey"));
}

public class MyClass
{
    private readonly string Setting; //if you need to pass multiple objects, use a custom POCO (and interface) instead of a string.

    public MyClass(string setting) //This is called constructor injection
    {
        Setting = setting;
    }

    public string DoSomething() 
    {
        var result = string.Empty;
        //Use setting here
        return result;
    }
}