.NET Aspire中如何自定义连接字符串配置节路径（替代默认的ConnectionStrings）

嘿，我来帮你搞定这个问题！在.NET Aspire里，如果不想用默认的ConnectionStrings配置节来存放SQL Server的连接字符串，其实有几种灵活的方式可以自定义路径，下面给你详细说说：

方法一：用WithConnectionStringKey直接指定自定义键 #

这是最直接省心的方式，在配置SQL Server资源的时候，直接追加WithConnectionStringKey方法，就能把连接字符串放到你想要的配置路径下。比如你想把连接字符串放到DatabaseSettings:SqlServer这个嵌套节里，代码可以这么改：

var sqlServerPassword = builder.AddParameter("sqlServerPassword", "Password12*", secret: true);  
var sqlServer = builder.AddSqlServer("sqlServer", password: sqlServerPassword, port: 5515)
    .WithImageRegistry("my private registry")
    .WithImage("mssql/server:2017-latest")
    .WithLifetime(ContainerLifetime.Persistent)
    // 指定自定义的配置键路径
    .WithConnectionStringKey("DatabaseSettings:SqlServer");

var orderApi = builder.AddProject<Projects.OrderApi>("orderapi")
    // 正常引用SQL Server资源即可，Aspire会自动把连接字符串注入到指定路径
    .WithReference(sqlServer);

这样配置后，连接字符串就不会默认存到ConnectionStrings:sqlServer，而是直接放到DatabaseSettings:SqlServer里，你的OrderApi项目直接读取这个路径就行。

方法二：手动构建并添加到自定义配置节 #

如果需要更精细的控制，比如要给不同环境配置不同的路径，你可以手动获取生成的连接字符串，再添加到自定义配置中：

var sqlServerPassword = builder.AddParameter("sqlServerPassword", "Password12*", secret: true);  
var sqlServer = builder.AddSqlServer("sqlServer", password: sqlServerPassword, port: 5515)
    .WithImageRegistry("my private registry")
    .WithImage("mssql/server:2017-latest")
    .WithLifetime(ContainerLifetime.Persistent);

var orderApi = builder.AddProject<Projects.OrderApi>("orderapi")
    .WithReference(sqlServer)
    // 手动把连接字符串注入到自定义配置节
    .WithConfiguration("DatabaseSettings:SqlServer", sqlServer.GetConnectionString());

这种方式自由度更高，不管是单层还是多层嵌套的配置路径都能轻松实现。

方法三：在项目内部做配置映射 #

要是不想改动Aspire AppHost的配置，也可以在你的OrderApi项目内部做映射。比如先保留默认的ConnectionStrings，然后通过配置绑定把它映射到自定义的配置类里：

首先定义配置类：

public class DatabaseSettings
{
    public string SqlServer { get; set; } = string.Empty;
}

然后在项目的Program.cs里绑定配置：

// 方式1：直接绑定自定义配置节（如果AppHost里已经把连接字符串放到这个路径）
builder.Services.Configure<DatabaseSettings>(builder.Configuration.GetSection("DatabaseSettings"));

// 方式2：把默认ConnectionStrings里的值映射过来
builder.Services.Configure<DatabaseSettings>(settings => 
{
    settings.SqlServer = builder.Configuration.GetConnectionString("sqlServer");
});

这种方式适合不想调整AppHost配置逻辑，只在业务项目里做适配的场景。

总的来说，第一种方法是最推荐的，直接在AppHost里指定自定义路径，Aspire会自动帮你完成后续的注入工作，非常省心。

备注：内容来源于stack exchange，提问作者burakergun