.NET Aspire中如何从AppHost传递配置并使用IOptions

问题背景 #

• 原架构：多个Worker服务基于HostApplicationBuilder和HostedServices运行在同一项目，通过appsettings.json和IOptions读取配置。
• 迁移目标：将每个HostedServices拆分为独立主机/容器部署，希望从AppHost传递配置，避免手动维护大量环境变量，理想状态是Worker能直接使用AppHost的appsettings.json配置并注入为IOptions。
• 当前问题：尝试在AddServiceDefaults中调用自定义配置方法，但注入的IOptions始终为空——因为Worker服务读取的是自身项目的配置文件，而非AppHost的。

项目结构 #

└── 带有appsettings.json的AppHost项目
    ├── WorkerProject01（由AppHost引用并启动）
    └── WorkerProject02（由AppHost引用并启动）

尝试的自定义配置代码 #

private static TBuilder ConfigureOptions<TBuilder>(this TBuilder builder) where TBuilder : IHostApplicationBuilder
{
    var cfgBuilder = new ConfigurationBuilder()
        .SetBasePath(Directory.GetCurrentDirectory());

    cfgBuilder.AddJsonFile($"appsettings.json", true, true)
        .AddJsonFile($"appsettings.dev.json", true, true)
        .AddEnvironmentVariables();

    var configuration = cfgBuilder.Build();

    builder.Services.Configure<SqlOptions>(configuration.GetSection("sql"));
    builder.Services.Configure<ScheduleOptions>(configuration.GetSection("schedule"));
    return builder;
}

解决方案 #

方法1：为单个Worker服务精准传递配置节 #

在AppHost中读取自身配置，然后将需要的配置节直接绑定到对应的Worker服务，Worker端无需自定义读取逻辑：

AppHost 代码（Program.cs）

var builder = DistributedApplication.CreateBuilder(args);

// 读取AppHost自身的目标配置节
var sqlConfig = builder.Configuration.GetSection("sql");
var scheduleConfig = builder.Configuration.GetSection("schedule");

// 添加Worker服务时传递指定配置
var worker01 = builder.AddProject<Projects.WorkerProject01>("worker-01")
    .WithConfiguration("sql", sqlConfig)
    .WithConfiguration("schedule", scheduleConfig);

var worker02 = builder.AddProject<Projects.WorkerProject02>("worker-02")
    .WithConfiguration("sql", sqlConfig)
    .WithConfiguration("schedule", scheduleConfig);

builder.Build().Run();

Worker服务代码（Program.cs）

保持常规的IOptions绑定逻辑即可，框架会自动接收AppHost传递的配置：

var builder = Host.CreateDefaultBuilder(args)
    .ConfigureServices((context, services) =>
    {
        services.Configure<SqlOptions>(context.Configuration.GetSection("sql"));
        services.Configure<ScheduleOptions>(context.Configuration.GetSection("schedule"));
        services.AddHostedService<Worker>();
    });

builder.Build().Run();

方法2：通过ServiceDefaults共享全局配置 #

如果多个Worker服务需要共享相同的配置传递规则，可以通过AddServiceDefaults实现全局配置共享：

AppHost 代码（Program.cs）

var builder = DistributedApplication.CreateBuilder(args);

// 配置全局服务默认值，将AppHost的配置传递给所有使用默认设置的服务
builder.Services.ConfigureDefaults(services =>
{
    services.AddConfiguration(builder.Configuration);
});

// 添加Worker服务时自动继承全局配置
builder.AddProject<Projects.WorkerProject01>("worker-01");
builder.AddProject<Projects.WorkerProject02>("worker-02");

builder.Build().Run();

Worker服务代码（Program.cs）

使用AddServiceDefaults简化配置，直接绑定IOptions：

var builder = Host.CreateDefaultBuilder(args)
    .AddServiceDefaults()
    .ConfigureServices((context, services) =>
    {
        services.Configure<SqlOptions>(context.Configuration.GetSection("sql"));
        services.Configure<ScheduleOptions>(context.Configuration.GetSection("schedule"));
        services.AddHostedService<Worker>();
    });

builder.Build().Run();

核心注意事项 #

• 禁止让Worker服务直接读取AppHost的appsettings.json文件：在容器或独立部署场景下，文件路径、访问权限均不支持这种跨项目读取方式。
• Aspire的WithConfiguration/AddConfiguration会自动处理配置到环境变量的转换，无需手动编写环境变量映射代码。
• 全局配置共享适合多服务复用相同配置的场景，精准传递配置则适合需要为不同Worker定制配置的场景。

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