如何在 ConfigureServices 方法中获取 IOptions？

Question

我有 asp.net 核心应用程序。我想使用IOptions 模式从 appsettings.json 注入值。所以我有一个类SecurityHeaderOptions，还有一个目标类SecurityHeadersBuilder，其构造函数以IOptions<SecurityHeaderOptions>为参数。

我知道 .net 核心可以在向容器注册后通过注入 IOptions<SecurityHeaderOptions> 来隐式创建 SecurityHeadersBuilder 的实例。

但是我想显式创建SecurityHeadersBuilder 的实例，调用其方法之一，然后将实例注册到容器中。

public sealed class SecurityHeaderOptions
{
    public string FrameOption { get; set; }    
    public string XssProtection { get; set; }
}


public class SecurityHeadersBuilder
{
    private readonly SecurityHeaderOptions _options = null;

    public SecurityHeadersBuilder(IOptions<SecurityHeaderOptions> options)
    {
        _options = options.Value;    
    }

    public SecurityHeadersBuilder AddDefaultPolicy()
    {
        AddFrameOptions();
        AddConetntSecurityPolicy();
        return this;
    }
}

ConfigureServices 方法

public void ConfigureServices(IServiceCollection services)
{        
    services.Configure<SecurityHeaderOptions>(Configuration.GetSection("SecurityHeaderOptions"));

    services.AddScoped<SecurityHeadersBuilder>(provider => 
           new SecurityHeadersBuilder(?????).AddDefaultPolicy())
}

问题
1> 如果我明确地将选项传递给构造函数，我是否需要使用service.Configure 方法向容器注册SecurityHeaderOptions？

2> Configuration.GetSection("SecurityHeaderOptions") 不能返回 IOptions<SecurityHeaderOptions> 的实例，而是返回 IConfigurationSection?

3>无论哪种方式，我如何检索SecurityHeaderOptions 并将其传递给SecurityHeadersBuilder 的构造函数？

Answer 1

使用 .NET Core 2 并且在 ConfigureServices 中没有可用的提供程序（或愿意添加它）我选择使用这样的东西（以 OP 代码为例）：

public void ConfigureServices(IServiceCollection services)
{
    // secOpts available for use in ConfigureServices
    var secOpts = Configuration
        .GetSection("SecurityHeaderOptions")
        .Get<SecurityHeaderOptions>();

    ...
}

Answer 2

这就是我注册选项并注入SecurityHeadersBuilder的方式

public void ConfigureServices(IServiceCollection services)
{
    services.Configure<SecurityHeaderOptions>(Configuration.GetSection("SecurityHeaderOptions"));            
    services.AddScoped<SecurityHeadersBuilder>(provider =>
    {
        var option = provider.GetService<IOptions<SecurityHeaderOptions>>();
        return new SecurityHeadersBuilder(option)
            .AddDefaultPolicy();
    });
}

Answer 3

Docs具体说：

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

因此您必须通过Startup.ConfigureServices 以其他方式访问配置，例如Quinton's answer

Answer 4

关于您的问题：

1. 是的，您需要注册选项，但我相信您这样做是错误的（至少以您的示例为例）。你应该这样注册：

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

2.我相信我上面提到的正确注册会返回您所期望的。

3. 只需注册它并将其放在SecurityHeaderBuilder 构造函数中就足够了。您不需要（默认的 .NET Core IOC 容器也不允许）在注册时传递构造函数参数。为此，您需要使用其他 IOC，例如 Autofac。

但您需要注册SecurityHeadersBuilder 才能在其他课程中使用它。 只需为此使用一个接口。

public interface ISecurityHeadersBuilder
{
    SecurityHeadersBuilder AddDefaultPolicy();    
}

public class SecurityHeadersBuilder : ISecurityHeadersBuilder
{
    private readonly SecurityHeaderOptions _options = null;

    public SecurityHeadersBuilder(IOptions<SecurityHeaderOptions> options)
    {
        _options = options.Value;    
    }

    public SecurityHeadersBuilder AddDefaultPolicy()
    {
        AddFrameOptions();
        AddContentSecurityPolicy();
        return this;
    }
}

然后，只需在startup.cs注册它

services.AddScoped<ISecurityHeadersBuilder, SecurityHeadersBuilder>();

Answer 5

首先，您需要向SecurityHeadersBuilder 添加第二个构造函数，它采用普通的SecurityHeaderOptions：

public class SecurityHeadersBuilder
{
    private readonly SecurityHeaderOptions _options;

    public SecurityHeadersBuilder(IOptions<SecurityHeaderOptions> options)
    {
        _options = options.Value;    
    }

    public SecurityHeadersBuilder(SecurityHeaderOptions options)
    {
        _options = options;    
    }

    public SecurityHeadersBuilder AddDefaultPolicy()
    {
        AddFrameOptions();
        AddContentSecurityPolicy();

        return this;
    }
}

那么答案完全取决于您是否需要在 Startup 类之外使用这些选项。

---

如果没有，你可以简单地使用Microsoft.Extensions.Configuration.ConfigurationBinder.Get<T>()扩展方法：

services.AddScoped<SecurityHeadersBuilder>(provider =>
{
    var options = Configuration.GetSection("SecurityHeaderOptions")
        .Get<SecurityHeaderOptions>();

    return new SecurityHeadersBuilder(options)
        .AddDefaultPolicy();
});

（然后您可以删除采用IOptions<SecurityHeaderOptions> 的SecurityHeadersBuilder 构造函数）。

---

如果您需要在其他地方使用这些选项，则可以将上述方法与Microsoft.Extensions.DependencyInjection.OptionsConfigurationServiceCollectionExtensions.Configure() 扩展方法结合使用：

var optionsSection = Configuration.GetSection("SecurityHeaderOptions");
services.Configure<SecurityHeaderOptions>(optionsSection);
services.AddScoped<SecurityHeadersBuilder>(provider =>
{
    var options = optionsSection.Get<SecurityHeaderOptions>();

    return new SecurityHeadersBuilder(options)
        .AddDefaultPolicy();
});

Answer 6

你可以这样做

public static class IConfigurationExtensions
{
    public static TypedConfiguration<SecurityHeaderOptions> GetSecurityHeaderOptions(this IConfiguration configuration)
    {
        return new TypedConfiguration<SecurityHeaderOptions>(configuration.GetSection("SecurityHeaderOptions"));
    }
}

public class TypedConfiguration<T> where T : class
{
    public TypedConfiguration(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public IConfiguration Configuration { get; }
    public T Value => Configuration.Get<T>();

    public void InitializeOptions(IServiceCollection services)
    {
        services.Configure<T>(Configuration);
    }
}

现在，您已经从一个地方创建了具有 IConfiguration、类型为 SecurityHeaderOptions 和用于为该类注册 IOptions 注入的辅助方法的对象。

这样使用

public void ConfigureServices(IServiceCollection services)
{        
    var wrappedOptions = Configuration.GetSecurityHeaderOptions();
    wrappedOptions.InitializeOptions(services);

    var options = Options.Create(wrappedOptions.Value);
    services.AddScoped<SecurityHeadersBuilder>(provider => 
       new SecurityHeadersBuilder(options).AddDefaultPolicy());
}