ASP.NET Core中使用IOptions无法从appsettings加载配置项

我在ASP.NET Core项目中尝试从appsettings文件加载配置数据，此前曾成功实现该功能，但当前无法正常运行。我试图将名为Images的配置段绑定到包含图片集合信息的WorkImageOptions对象，使用IOptionsSnapshot获取配置值时始终为空，尽管配置段中存在有效数据。

相关代码 #

Program.cs #

using SLT.Bohem63.Peachie.Config;

WebApplicationBuilder builder = WebApplication.CreateBuilder(args);
builder.Services
    .Configure<WorkImageOptions>(builder.Configuration.GetSection(WorkImageOptions.SectionName));

builder.Services.AddControllersWithViews();

WebApplication app = builder.Build();

app.UseRouting();
app.MapStaticAssets();

app.MapControllerRoute(
    name: "default",
    pattern: "{controller=Bohem63}/{action=Index}/{id?}")
    .WithStaticAssets();

app.Run();

WorkImageOptions.cs #

public sealed class WorkImageOptions
{
    public IEnumerable<WorkImageInfo> Images { get; set; }

    public static string SectionName => "Images";
}

WorkImageInfo.cs #

namespace SLT.Bohem63.Peachie.Models.Data
{
    public interface IWorkImageInfo
    {
        string Filename { get; set; }
        string Title { get; set; }
        string Description { get; set; }
        int Likes { get; set; }
    }

    public sealed class WorkImageInfo : IWorkImageInfo
    {
        public string Filename { get; set; }
        public string Title { get; set; }
        public string Description { get; set; }
        public int Likes { get; set; } = 0;
    }
}

配置获取代码 #

public class Bohem63Controller(IOptionsSnapshot<WorkImageOptions> options) : Controller { }

appsettings.json #

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*",
  "Images": {
    "filename": "pic1.jpg",
    "title": "",
    "description": "",
    "likes": 0
  }
}

问题原因 #

核心问题是配置结构与模型类型不匹配：

• WorkImageOptions中的Images属性是IEnumerable<WorkImageInfo>集合类型，期望绑定数组格式的配置。
• 但appsettings.json中的Images是单个对象，不是数组，ASP.NET Core配置绑定无法自动将单个对象转换为集合，导致绑定失败，最终Images属性为空。

修复方案 #

1. 修正appsettings.json的配置结构 #

将单个Images对象改为数组格式，匹配模型的集合类型：

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*",
  "Images": [
    {
      "filename": "pic1.jpg",
      "title": "",
      "description": "",
      "likes": 0
    }
  ]
}

2. 优化模型集合类型（可选但推荐） #

将WorkImageOptions中的IEnumerable<WorkImageInfo>改为具体的List<WorkImageInfo>，并添加默认初始化避免空引用：

public sealed class WorkImageOptions
{
    public List<WorkImageInfo> Images { get; set; } = new List<WorkImageInfo>();

    public static string SectionName => "Images";
}

3. 验证配置绑定结果 #

在控制器中添加代码确认配置是否成功加载：

public class Bohem63Controller(IOptionsSnapshot<WorkImageOptions> options) : Controller
{
    public IActionResult Index()
    {
        var imageOptions = options.Value;
        // 可通过调试或日志查看Images集合是否有数据
        return View(imageOptions.Images);
    }
}

额外排查点 #

• 确认WorkImageOptions和WorkImageInfo的属性名称与配置键完全匹配（大小写不敏感，但名称需一致）。
• 检查是否存在环境特定配置文件（如appsettings.Development.json）覆盖了Images配置段。
• 确认Program.cs中配置注册代码正确，builder.Configuration.GetSection(WorkImageOptions.SectionName)指向了正确的配置节点。

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