.NET Core如何通过依赖注入利用IOptions协变简化配置注册

核心结论 #

你不需要逐个手动编写每个配置节的注册代码。
你之前尝试直接注入IOptions<EmailOptions>不生效的原因很简单：IOptions<T>的协变特性仅对存在继承/派生关系的已注册选项类型生效，而EmailOptions是MyConfiguration的属性，并非MyConfiguration的父类或派生类，容器中也没有单独注册EmailOptions的选项绑定，自然无法解析出实例。

对于嵌套自定义配置类的场景，微软自带的Options绑定器本身就支持递归绑定：只要你绑定了外层配置节，内层所有嵌套的自定义类型属性会自动按照JSON结构映射，不需要额外为嵌套类编写单独的绑定逻辑。

批量注册实现方案 #

你可以通过反射基于约定实现自动注册，完全避免重复代码，以下是两种生产环境常用的实现方式：

方式1：基于标记接口扫描配置类 #

适合需要明确控制哪些类需要注册为选项的场景：

1. 先定义一个空接口作为所有配置类的标记：

public interface IOptionsSection
{
}

2. 让所有需要单独注入的配置类实现该接口，嵌套内部的配置类不需要实现：

public class EmailOptions : IOptionsSection
{
    // 嵌套类直接定义属性即可，不需要单独标记
    public SmtpOptions Smtp { get; set; }
    public string DefaultFromAddress { get; set; }
}
public class SmtpOptions
{
    public string Host { get; set; }
    public int Port { get; set; }
}
public class PhoneOptions : IOptionsSection
{
    public string DefaultSmsGateway { get; set; }
}

3. 编写批量注册逻辑，约定配置节名称为配置类名去掉Options后缀：

var optionTypes = Assembly.GetExecutingAssembly()
    .GetTypes()
    .Where(t => t.IsClass 
                && !t.IsAbstract 
                && typeof(IOptionsSection).IsAssignableFrom(t))
    .ToList();

foreach (var optionType in optionTypes)
{
    var sectionKey = optionType.Name.Replace("Options", string.Empty);
    var configSection = configuration.GetSection(sectionKey);
    services.Configure(optionType, configSection);
}

如果后续你需要直接注入IOptions<SmtpOptions>，只需要让SmtpOptions也实现IOptionsSection接口，保证配置文件中存在名为Smtp的根节点即可自动注册。

方式2：基于配置节点自动匹配 #

适合配置节名称和配置类名严格遵循命名约定的场景，不需要给配置类加额外标记：

// 约定所有配置类均以Options结尾，且类名去掉Options后缀后与JSON根节点名一致
var optionTypeMap = Assembly.GetExecutingAssembly()
    .GetTypes()
    .Where(t => t.IsClass && !t.IsAbstract && t.Name.EndsWith("Options"))
    .ToDictionary(t => t.Name.Replace("Options", string.Empty), StringComparer.OrdinalIgnoreCase);

foreach (var childSection in configuration.GetChildren())
{
    if (optionTypeMap.TryGetValue(childSection.Key, out var matchedOptionType))
    {
        services.Configure(matchedOptionType, childSection);
    }
}

补充说明 #

• 以上两种注册方式和根配置MyConfiguration的注册完全独立，互不冲突，如果业务中需要注入全量配置，单独保留services.Configure<MyConfiguration>(configuration);即可。
• 批量注册逻辑可以封装为IServiceCollection的扩展方法，后续项目中直接一行调用即可完成所有配置注册。

内容的提问来源于stack exchange，提问作者gaborhodi