在 ASP.NET 中获取配置值 5 (vNext)

Question

我正在为 ASP.NET 5 (vNext) 中的一些概念而苦恼。

其中之一是用于配置的依赖注入方法。好像我必须通过堆栈一直传递一个参数。我可能误解了什么或做错了。

假设我有一个名为 "contactEmailAddress" 的配置属性。我将使用该配置属性在下新订单时发送电子邮件。考虑到这种情况，我的 ASP.NET 5 堆栈将如下所示：

Startup.cs

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

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

  public void Configure(IApplicationBuilder app)
  {
    app.UseErrorPage();
    app.UseMvc(routes =>
      {
        routes.MapRoute("default",
          "{controller}/{action}/{id}",
          defaults: new { controller = "Home", action = "Index" });
      }
    );
    app.UseWelcomePage();
  }

AppSettings.cs

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

config.json

{
  "AppSettings": {
    "ContactEmailAddress":"support@mycompany.com"  
  }
}

OrderController.cs

[Route("orders")]
public class OrdersController : Controller
{    
  private IOptions<AppSettings> AppSettings { get; set; }

  public OrdersController(IOptions<AppSettings> appSettings)
  {
    AppSettings = appSettings;
  }

  [HttpGet("new-order")]
  public IActionResult OrderCreate()
  {
    var viewModel = new OrderViewModel();
    return View(viewModel);
  }

  [HttpPost("new-order")]
  public IActionResult OrderCreate(OrderViewModel viewModel)
  {

    return new HttpStatusCodeResult(200);
  } 
}

Order.cs

public class Order()
{
  public void Save(IOptions<AppSettings> appSettings)
  {
    // Send email to address in appSettings
  }

  public static List<Order> FindAll(IOptions<AppSettings> appSettings)
  {
    // Send report email to address in appSettings
    return new List<Order>();
  }
}

如上例所示，我将 AppSettings 传递给整个堆栈。这感觉不对。更让我担心的是，如果我尝试使用需要访问配置设置的第三方库，这种方法将不起作用。第三方库如何访问配置设置？我误会了什么吗？有更好的方法吗？

Answer 1

您正在纠缠 2 个不同的运行时间资源提供者，AppSettings 和 Dependency Injection。

AppSettings，提供运行时间访问应用程序特定值，如 UICulture 字符串、Contact电子邮件，等等

DI 容器 是管理服务访问及其生命周期范围的工厂。例如，如果 MVC 控制器 需要访问您的 EmailService，您将配置

   public void ConfigureServices(IServiceCollection services)
   {
      // Add all dependencies needed by Mvc.
      services.AddMvc();

      // Add EmailService to the collection. When an instance is needed,
      // the framework injects this instance to the objects that needs it
      services.AddSingleton<IEmailService, EmailService>();
   }

然后，如果我们的 Home Controller 需要访问您的 EmailService，我们通过将其作为参数添加到 Controller 构造函数来添加对其接口的依赖性

public class HomeController : Controller
{
   private readonly IEmailService _emailService;
   private readonly string _emailContact;

  /// The framework will inject an instance of an IEmailService implementation.
   public HomeController(IEmailService emailService)
   {
      _emailService = emailService;
      _emailContact = System.Configuration.ConfigurationManager.
                   AppSettings.Get("ContactEmail");
   }

   [HttpPost]
   public void EmailSupport([FromBody] string message)
   {
      if (!ModelState.IsValid)
      {
         Context.Response.StatusCode = 400;
      }
      else
      {
         _emailService.Send(_emailContact, message);

依赖注入的目的是管理服务的访问和生命周期。

在前面的示例中，在我们的应用程序 Startup 中，我们将 DI 工厂配置为将 IEmailService 的应用程序请求与 EmailService 相关联。因此，当我们的控制器由 MVC 框架 实例化时，框架注意到我们的 Home Controller 期望 IEmailService，框架检查我们的应用程序服务集合。它找到映射指令并将 Singleton EmailService（占用接口的后代）注入我们的家庭控制器。

超级多态因子 - 可恶！

为什么这很重要？

如果您的联系电子邮件发生变化，您可以更改 AppSetting 值并完成。 ConfigurationManager 对 "ContactEmail" 的所有请求都已全局更改。字符串很容易。当我们可以散列时不需要注入。

如果您的存储库、电子邮件服务、日志记录服务等发生变化，您需要一种全局方式来更改对此服务的所有引用。服务引用不像不可变字符串文字那样容易传输。服务实例化应由工厂处理以配置服务的设置和依赖项。

所以，在一年内你开发了 RobustMailService:

Class RobustMailService : IEmailService
{

....

}

只要您的新 RobustMailService 继承并实现了 IEmailService 接口，您就可以通过更改 :

在全局范围内替换对邮件服务的所有引用

   public void ConfigureServices(IServiceCollection services)
   {
      // Add all dependencies needed by Mvc.
      services.AddMvc();

      // Add RobustMailService to the collection. When an instance is needed,
      // the framework injects this instance to the objects that needs it 
      services.AddSingleton<IEmailService, RobustMailService>();
   }

Answer 2

这可以使用 IOptions 评估程序服务来实现，因为您似乎正在尝试。

我们可以从创建一个 class 开始，其中包含您的控制器需要从配置中获取的所有变量。

public class VariablesNeeded
{
    public string Foo1{ get; set; }        
    public int Foo2{ get; set; }
}

public class OtherVariablesNeeded
{
    public string Foo1{ get; set; }        
    public int Foo2{ get; set; }
}

我们现在需要使用依赖注入在控制器的构造函数中告诉中间件控制器需要这个 class，我们使用 IOptions 访问器服务来做到这一点。

using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Options;

public class MyController: Controller{    
    private readonly VariablesNeeded _variablesNeeded;

    public MyController(IOptions<VariablesNeeded> variablesNeeded) {
        _variablesNeeded= variablesNeeded.Value;
    }

    public ActionResult TestVariables() {
        return Content(_variablesNeeded.Foo1 + _variablesNeeded.Foo2);
    }
}

为了从您的配置文件中获取变量，我们为启动创建了一个构造函数 class，以及一个配置属性。

public IConfigurationRoot Configuration { get; }

public Startup(IHostingEnvironment env)
{
    /* This is the fairly standard procedure now for configuration builders which will pull from appsettings (potentially with an environmental suffix), and environment variables. */
    var builder = new ConfigurationBuilder()
            .SetBasePath(env.ContentRootPath)    
            .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
            .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
            .AddEnvironmentVariables();
    Configuration = builder.Build();
}

现在我们需要确保管道实际为控制器提供此服务。

在 Startup class 的 ConfigureServices 方法中，您想要使用 Options 中间件，并将 VariablesNeeded 类型的对象注入到管道中。

public void ConfigureServices(IServiceCollection services)
{
   // Tells the pipeline we want to use IOption Assessor Services
   services.AddOptions();

   // Injects the object VariablesNeeded in to the pipeline with our desired variables
   services.Configure<VariablesNeeded>(x =>
   {
       x.Foo1 = Configuration["KeyInAppSettings"]
       x.Foo2 = Convert.ToInt32(Configuration["KeyParentName:KeyInAppSettings"])
   });

   //You may want another set of options for another controller, or perhaps to pass both to our "MyController" if so, you just add it to the pipeline    
   services.Configure<OtherVariablesNeeded>(x =>
   {
       x.Foo1 = "Other Test String",
       x.Foo2 = 2
   });

   //The rest of your configure services...
}

有关详细信息，请参阅 ASPCore Docs

中有关使用选项和配置对象的章节

在 ASP.NET 中获取配置值 5 (vNext)

Getting a Configuration Value in ASP.NET 5 (vNext)

c#

asp.net

asp.net-mvc

asp.net-core-mvc

asp.net-core