如何将appsettings.json中的子配置绑定到自定义类类型

我来帮你搞定这个配置绑定的问题！其实在.NET里把appsettings.json的子配置绑定到自定义类非常简单，我一步步给你讲清楚：

首先你的EmailProviderSettings类属性已经定义好了，那appsettings.json里得有对应的子节点，键名要和类的属性名对应（大小写不敏感，但建议保持一致更清晰），比如：

{
  "EmailProvider": {
    "PopServer": "pop.yourdomain.com",
    "PopPort": 995,
    "SmtpServer": "smtp.yourdomain.com",
    "SmtpPortTls": 587,
    "SmtpPortSsl": 465,
    "ApiKey": "your-actual-api-key",
    "UseSsl": true,
    "UserId": "your-email-user",
    "UserPassword": "your-email-password"
    // 你的类里其他属性也按这个格式补充
  }
}

根据你的.NET版本，绑定方式略有不同：

.NET 6+（使用Top-level Statements的Program.cs） #

有两种常用的绑定方式：

方式1：直接绑定到实例并注册为依赖服务 #

var builder = WebApplication.CreateBuilder(args);

// 从配置节点"EmailProvider"绑定到EmailProviderSettings实例
var emailSettings = builder.Configuration.GetSection("EmailProvider").Get<EmailProviderSettings>();

// 把实例注册为单例服务，方便后续注入使用
builder.Services.AddSingleton<IEmailProviderSettings>(emailSettings);

var app = builder.Build();
// 后续的中间件、路由等配置...

方式2：使用Configure注册，结合IOptions<T>注入 #

这种方式更灵活，适合需要配置重载或者使用选项模式的场景：

var builder = WebApplication.CreateBuilder(args);

// 直接绑定配置节点到EmailProviderSettings，并注册为选项服务
builder.Services.Configure<EmailProviderSettings>(builder.Configuration.GetSection("EmailProvider"));

var app = builder.Build();
// 后续配置...

.NET Core 3.1及更早版本（使用Startup.cs） #

在ConfigureServices方法里完成绑定：

public class Startup
{
    public IConfiguration Configuration { get; }

    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public void ConfigureServices(IServiceCollection services)
    {
        // 方式1：绑定实例后注册
        var emailSettings = Configuration.GetSection("EmailProvider").Get<EmailProviderSettings>();
        services.AddSingleton<IEmailProviderSettings>(emailSettings);

        // 方式2：使用Configure注册选项服务
        services.Configure<EmailProviderSettings>(Configuration.GetSection("EmailProvider"));
    }

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        // 中间件配置...
    }
}

根据你选择的绑定方式，注入方式也不同：

如果用的是方式1（直接注册IEmailProviderSettings） #

直接在构造函数中注入接口即可：

public class EmailService
{
    private readonly IEmailProviderSettings _emailSettings;

    // 构造函数注入
    public EmailService(IEmailProviderSettings emailSettings)
    {
        _emailSettings = emailSettings;
    }

    public void SendTestEmail()
    {
        // 直接使用配置属性
        var smtpServer = _emailSettings.SmtpServer;
        var smtpPort = _emailSettings.SmtpPortTls;
        // ...后续发邮件逻辑
    }
}

如果用的是方式2（Configure注册的选项服务） #

需要注入IOptions<EmailProviderSettings>，然后通过Value属性获取配置实例：

public class EmailService
{
    private readonly EmailProviderSettings _emailSettings;

    public EmailService(IOptions<EmailProviderSettings> emailSettings)
    {
        _emailSettings = emailSettings.Value;
    }

    public void SendTestEmail()
    {
        var popServer = _emailSettings.PopServer;
        // ...逻辑代码
    }
}

• 确保你的EmailProviderSettings类的属性都是公共可读写的（你的代码已经满足这一点啦）
• 如果需要验证配置的合法性，可以给类的属性添加数据注解（比如[Required]、[Range]），然后在绑定的时候启用验证：

  // .NET 6+示例
  builder.Services.AddOptions<EmailProviderSettings>()
      .Bind(builder.Configuration.GetSection("EmailProvider"))
      .ValidateDataAnnotations();
  

• 配置系统支持嵌套类绑定，如果你的配置有层级结构，只要类的结构和json对应，就能自动递归绑定

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