我正在编写一个基本的应用程序来学习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;
}
}
如何获取“AppSettings:SomeKey”的值?
答案 0 :(得分:15)
ASP.NET 5大量使用依赖注入,因此如果您还使用依赖注入,那么这非常简单。如果您检查示例MVC6项目,您可以看到它的工作原理:
首先,在属性中定义了一个类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;
}
}
答案 1 :(得分:14)
我使用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");
}
}
答案 2 :(得分:13)
我强烈建议您使用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);
这样您就不必担心设置的来源,存储方式或结构。你只需预先定义你的选项模型,然后就会发生魔术。
答案 3 :(得分:12)
使用此:
var value = Configuration.Get("AppSettings:SomeKey");
基于this blog post。冒号类似于点表示法,用于在层次结构中向下导航。
如果你需要其他类中的值,你应该将其注入.ASP.NET内置依赖注入,但是如果你只需要一个MyClass实例,你可以新建它而不是设置一个DI容器。 / p>
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;
}
}