控制器外部的 ASP.NET 5 DI 应用程序设置

Question

我可以像这样在控制器中设置应用程序

 private IOptions<AppSettings> appSettings;
 public CompanyInfoController(IOptions<AppSettings> appSettings)
 {
     this.appSettings = appSettings;
 }

但是如何像这样在我的自定义类中进行 DI

  private IOptions<AppSettings> appSettings;
  public PermissionFactory(IOptions<AppSettings> appSetting)
  {
      this.appSettings = appSettings;
  }

我在 Startup.cs 中的注册是

services.Configure<AppSettings>(Configuration.GetSection("AppSettings"));

Answer 1

“正确”的方式

在 DI 中注册你的自定义类，就像在 ConfigureServices 方法中注册其他依赖一样，例如：

services.AddTransient<PermissionFactory>();

（您可以使用AddScoped 或您需要的任何其他生命周期来代替AddTransient）

然后将此依赖项添加到控制器的构造函数中：

public CompanyInfoController(IOptions<AppSettings> appSettings, PermissionFactory permFact)

现在，DI 知道PermissionFactory，可以对其进行实例化并将其注入到您的控制器中。

如果您想在Configure 方法中使用PermissionFactory，只需将其添加到它的参数列表中即可：

Configure(IApplicationBuilder app, PermissionFactory prov)

Aspnet 会发挥神奇的作用并在那里注入类。

“讨厌”的方式

如果你想在你的代码深处实例化PermissionFactory，你也可以用一种有点讨厌的方式来做——在Startup类中存储对IServiceProvider的引用：

internal static IServiceProvider ServiceProvider { get;set; }

Configure(IApplicationBuilder app, IServiceProvider prov) {
   ServiceProvider = prov;
   ...
}

现在您可以像这样访问它：

var factory = Startup.ServiceProvider.GetService<PermissionFactory>();

同样，DI 将负责将IOptions<AppSettings> 注入PermissionFactory。

Asp.Net 5 Docs in Dependency Injection

Answer 2

我建议不要通过AppSettings。一个类不应该依赖于模糊的东西——它应该完全依赖于它需要的东西，或者接近它。 ASP.NET Core 使摆脱依赖AppSettings 的旧模式变得更加容易。如果您的类依赖于AppSettings，那么您无法从构造函数中真正看到它依赖于什么。它可能取决于任何键。如果它依赖于一个更具体的接口，那么它的依赖就更清晰、更明确，并且您可以在单元测试时模拟该接口。

您可以使用您的类需要的特定设置（或不太具体但不太宽泛的设置）和实现它的类创建一个接口 - 例如，

    public interface IFooSettings
    {
        string Name { get; }
        IEnumerable Foos { get; }
    }

    public interface IFoo
    {
        string Color { get;  }
        double BarUnits { get;  }
    }

    public class FooSettings : IFooSettings
    {
        public string Name { get; set; }
        public List<Foo> FooList { get; set; }

        public IEnumerable Foos
        {
            get
            {
                if (FooList == null) FooList = new List<Foo>();
                return FooList.Cast<IFoo>();
            }
        }
    }

    public class Foo : IFoo
    {
        public string Color { get; set; }
        public double BarUnits { get; set; }
    }

然后添加一个.json文件，fooSettings.json：

    {
      "FooSettings": {
        "Name": "MyFooSettings",
        "FooList": [
          {
            "Color": "Red",
            "BarUnits": "1.5"
          },      {
            "Color": "Blue",
            "BarUnits": "3.14159'"
          },      {
            "Color": "Green",
            "BarUnits": "-0.99999"
          }
        ]
      }
    }

然后，在 Startup()（在 Startup.cs 中）中，我们指定 Configuration 中的内容，添加 fooSettings.json：

    var builder = new ConfigurationBuilder(appEnv.ApplicationBasePath)
        .AddJsonFile("config.json")
        .AddJsonFile($"config.{env.EnvironmentName}.json", optional: true)
        .AddJsonFile("fooSettings.json");

最后，在 ConfigureServices()（也在 Startup.cs 中）告诉它加载 FooSettings 的实例，将其转换为 IFooSettings（因此属性显示为只读）并为所有用户提供该单个实例依赖IFooSettings:

    var fooSettings = (IFooSettings)ConfigurationBinder.Bind<FooSettings>(
        Configuration.GetConfigurationSection("FooSettings"));
    services.AddInstance(typeof (IFooSettings), fooSettings);

现在您的类 - 控制器、过滤器或由 DI 容器创建的任何其他内容 - 可以依赖于 IFooSettings，它将由 .json 文件提供。但是您可以模拟 IFooSettings 进行单元测试。

Original blog post - 这是我的，所以我没有抄袭。

Answer 3

您也可以在非控制器类中进行依赖注入。

在您的 startup 班级中，

public class Startup
{
  public IConfigurationRoot Configuration { get; set; }

  public Startup(IHostingEnvironment env)
  {
        // Set up configuration sources.
     var builder = new ConfigurationBuilder()
             .AddJsonFile("appsettings.json")
             .AddEnvironmentVariables();
     Configuration = builder.Build();
  }
  public void ConfigureServices(IServiceCollection services)
  {
     // register other dependencies also here
     services.AddInstance<IConfiguration>(Configuration);     
  }
}

现在在您的自定义类中，让构造函数接受 IConfiguration 的实现

private IConfiguration configuration;
public PermissionFactory(IConfiguration configuration)
{
  this.configuration = configuration;
}
public void SomeMethod()
{
  var someSection = this.configuration.GetSection("SomeSection");
  var someValue= this.configuration.Get<string>("YourItem:SubItem");
}

Answer 4

如果您想 DI 到操作过滤器参考 Action filters, service filters and type filters in ASP.NET 5 and MVC 6 服务过滤器部分。