如何在 ConfigureServices 中解析 IOptions 实例？

Question

是否可以从 Startup 中的 ConfigureServices 方法解析 IOptions<AppSettings> 的实例？ The documentation explicitly says:

不要在Startup.ConfigureServices. 中使用IOptions<TOptions> 或IOptionsMonitor<TOptions> 由于服务注册的顺序，可能存在不一致的选项状态。

您可以使用serviceCollection.BuildServiceProvider() 手动创建服务提供者，但这会导致警告：

从应用程序代码中调用“BuildServiceProvider”会导致创建一个额外的单例服务副本。考虑将依赖注入服务等替代方案作为“配置”的参数。

我怎样才能做到这一点？

public void ConfigureServices(IServiceCollection services)
{
    services.Configure<AppSettings>(
        configuration.GetConfigurationSection(nameof(AppSettings)));

    // How can I resolve IOptions<AppSettings> here?
}

Answer 1

您是否正在寻找类似以下的内容？大家可以看一下我的cmets的代码：

// this call would new-up `AppSettings` type
services.Configure<AppSettings>(appSettings =>
{
    // bind the newed-up type with the data from the configuration section
    ConfigurationBinder.Bind(appSettings, Configuration.GetConfigurationSection(nameof(AppSettings)));

    // modify these settings if you want to
});

// your updated app settings should be available through DI now

Answer 2

如果您需要使用服务提供者手动解析服务，您可以使用此AddSingleton/AddScoped/AddTransient 重载：

// Works for AddScoped and AddTransient as well
services.AddSingleton<IBarService>(sp =>
{
    var fooService = sp.GetRequiredService<IFooService>();
    return new BarService(fooService);
}

如果您真的想要，您可以使用IServiceCollection 上的BuildServiceProvider() 方法构建一个中间服务提供者：

public void ConfigureService(IServiceCollection services)
{
    // Configure the services
    services.AddTransient<IFooService, FooServiceImpl>();
    services.Configure<AppSettings>(configuration.GetSection(nameof(AppSettings)));

    // Build an intermediate service provider
    var sp = services.BuildServiceProvider();

    // Resolve the services from the service provider
    var fooService = sp.GetService<IFooService>();
    var options = sp.GetService<IOptions<AppSettings>>();
}

为此，您需要 Microsoft.Extensions.DependencyInjection 包。

但是，请注意，这会导致多个服务提供者实例，而这又可能导致多个单例实例。

---

如果只需要绑定ConfigureServices中的一些选项，也可以使用Bind方法：

var appSettings = new AppSettings();
configuration.GetSection(nameof(AppSettings)).Bind(appSettings);

此功能可通过Microsoft.Extensions.Configuration.Binder 包获得。

Answer 3

实例化依赖于其他服务的类的最佳方式是使用 AddXXX 重载，它为您提供 IServiceProvider em>。这样您就不需要实例化中间服务提供者。

以下示例展示了如何在 AddSingleton/AddTransient 方法中使用此重载。

services.AddSingleton(serviceProvider =>
{
    var options = serviceProvider.GetService<IOptions<AppSettings>>();
    var foo = new Foo(options);
    return foo ;
});


services.AddTransient(serviceProvider =>
{
    var options = serviceProvider.GetService<IOptions<AppSettings>>();
    var bar = new Bar(options);
    return bar;
});

Answer 4

想帮助其他看起来相同但也在使用 Autofac 的人。

如果您想获取 ILifetimeScope（即当前范围的容器），您需要在 Configure(IApplicationBuilder app) 中调用 app.ApplicationServices.GetAutofacRoot() 方法，这将返回 ILifetimeScope 实例，您可以使用它来解析服务

public void Configure(IApplicationBuilder app)
    {
        //app middleware registrations 
        //...
        //

        ILifetimeScope autofacRoot = app.ApplicationServices.GetAutofacRoot();
        var repository = autofacRoot.Resolve<IRepository>();
    }

Answer 5

告诉您手动构建IServiceProvider 以获取IOptions<T> 实例的所有其他答案都是危险，因为它们是错误（至少在 ASP .NET Core 3.0）！实际上，如果您今天使用这些答案，您将收到以下编译器警告：

从应用程序代码调用“BuildServiceProvider”会导致创建一个额外的单例服务副本。考虑将依赖注入服务等替代方案作为“配置”的参数。

正确的方法是实现这一点，在所有版本的 ASP.NET Core 中都安全可靠地工作，是实现自 .NET Core 1.0 以来就存在的 IConfigureOptions<TOptions> 接口 - 但它似乎很少有人知道how it makes things Just Work™。

例如，您想要添加一个自定义模型验证器，该验证器依赖于您的应用程序的其他服务之一。最初这似乎是不可能的 - 没有办法解决 IMyServiceDependency 因为您无权访问 IServiceProvider：

public class MyModelValidatorProvider : IModelValidatorProvider
{
    public MyModelValidatorProvider(IMyServiceDependency dependency)
    {
        ...
    }
}

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers(options =>
    {
        options.ModelValidatorProviders.Add(new MyModelValidatorProvider(??????));
    });
}

但是IConfigureOptions<TOptions> 的“魔力”让它变得如此简单：

public class ConfigureMvcOptions : IConfigureOptions<MvcOptions>
{
    private IMyServiceDependency _dependency;

    public MyMvcOptions(IMyServiceDependency dependency)
        => _dependency = dependency;

    public void Configure(MvcOptions options)
        => options.ModelValidatorProviders.Add(new MyModelValidatorProvider(_dependency));
}

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();

    ...

    // or scoped, or transient, as necessary for your service
    services.AddSingleton<IConfigureOptions<MvcOptions>, ConfigureMvcOptions>();
}

基本上，您在ConfigureServices 中的Add***(***Options) 代表中所做的任何设置现在都移至您的IConfigureOptions<TOptions> 类的Configure 方法。然后，您以与注册任何其他服务相同的方式注册选项，然后离开！

如需更多详细信息，以及有关其在幕后如何运作的信息，请I refer you to the always-excellent Andrew Lock。

Answer 6

在 MVC Core 3.1 或 .Net 5 中，您可以通过两行将 IOptions 传递给 Startup.cs 中的服务：

你的IOptions设置先注册：

services.Configure<MySettings>(Configuration.GetSection("MySection"));

然后你的服务注册，传入IOptions：

services.AddSingleton<IMyService, MyService>(x => new MyService(x.GetService<IOptions<MySettings>>()));