当前位置：首页 > news >正文

NetCorePal.Aspire 项目介绍

news 2026/6/7 0:00:58

NetCorePal.Aspire 项目介绍

netcorepal-aspire

NetCorePal.Aspire 是面向 .NET Aspire 的托管扩展包集合，致力于为企业级分布式应用提供统一、规范的基础设施集成能力。

项目聚焦国产化数据库场景，围绕 netcorepal-cloud-framework 的工程实践需求，提供与 .NET Aspire 生态一致的资源托管、依赖编排和本地开发支持能力，帮助开发团队在国产化基础设施环境下获得更完整、更高效的开发与交付体验。

NetCorePal.Aspire 已集成至 netcorepal-cloud-template，可随模板工程直接使用，具备开箱即用的应用基础。

当前能力

目前，NetCorePal.Aspire 已提供以下托管扩展能力：

OpenGauss 托管扩展

提供 NetCorePal.Aspire.Hosting.OpenGauss 包，用于在 Aspire 应用中声明和管理 OpenGauss 资源，主要支持：

OpenGauss 服务与数据库资源添加
自动连接字符串管理
内置健康检查
数据卷与绑定挂载
初始化脚本挂载
自定义端口与凭据配置
数据库兼容模式支持

其中，数据库创建支持以下兼容模式：

PG：PostgreSQL 兼容
A：Oracle 兼容
B：MySQL 兼容

DMDB 托管扩展

提供 NetCorePal.Aspire.Hosting.DMDB 包，用于支持达梦数据库资源的托管与编排，主要支持：

基于容器的 DMDB 部署
用户密码与 DBA 密码配置
主机端口映射
数据持久化支持
数据库创建能力
服务器级与数据库级健康检查
与 WaitFor 机制协同启动依赖服务

MongoDB 扩展能力

项目同时提供 NetCorePal.Aspire.Hosting.MongoDB 扩展，用于支持 MongoDB 副本集能力接入 Aspire 应用，满足分布式应用场景下的基础设施扩展需求。

代码示例

NetCorePal.Aspire 采用与 .NET Aspire 一致的资源声明方式，可在应用启动阶段统一定义数据库资源、依赖关系和连接引用。以下示例展示了常见使用方式。

OpenGauss 基本用法

以下示例展示了如何在 Aspire 应用中添加 OpenGauss 服务和数据库资源，并将数据库连接能力提供给业务服务使用。

var builder = DistributedApplication.CreateBuilder(args);var openGauss = builder.AddOpenGauss("opengauss");
var appDb = openGauss.AddDatabase("appdb");builder.AddProject<Projects.Api>("api")
.WithReference(appDb)
.WaitFor(appDb);builder.Build().Run();

该方式适用于本地开发、联调测试和示例项目场景。业务服务通过 WithReference(appDb) 即可获得对应的连接信息，数据库资源就绪后服务再启动。

OpenGauss 兼容模式配置

OpenGauss 支持在创建数据库时指定兼容模式，以适配不同数据库方言场景。

var builder = DistributedApplication.CreateBuilder(args);var openGauss = builder.AddOpenGauss("opengauss");var pgDb = openGauss.AddDatabase("pgdb", dbcompatibility: "PG");
var oracleDb = openGauss.AddDatabase("oracledb", dbcompatibility: "A");
var mysqlDb = openGauss.AddDatabase("mysqldb", dbcompatibility: "B");builder.AddProject<Projects.Api>("api")
.WithReference(pgDb)
.WaitFor(pgDb);builder.Build().Run();

当前支持的兼容模式包括：

PG：PostgreSQL 兼容
A：Oracle 兼容
B：MySQL 兼容

该能力适合在数据库迁移、兼容性验证和多方言适配场景中使用。

OpenGauss 自定义凭据与数据持久化

以下示例展示了如何通过 Aspire 参数配置数据库密码，并启用数据持久化能力。

var builder = DistributedApplication.CreateBuilder(args);var password = builder.AddParameter("opengauss-password", secret: true);var openGauss = builder.AddOpenGauss("opengauss", password: password, port: 5432)
.WithDataVolume();var appDb = openGauss.AddDatabase("appdb");builder.AddProject<Projects.Api>("api")
.WithReference(appDb)
.WaitFor(appDb);builder.Build().Run();

在该场景下：

数据库密码通过参数统一管理
端口可按本地环境需要进行配置
WithDataVolume() 可用于保留数据库数据，便于本地开发阶段重复使用环境

如需将初始化脚本挂载到容器，也可以进一步进行扩展配置。

var builder = DistributedApplication.CreateBuilder(args);var openGauss = builder.AddOpenGauss("opengauss")
.WithDataVolume()
.WithInitBindMount("./init-scripts");var appDb = openGauss.AddDatabase("appdb");builder.Build().Run();

DMDB 基本用法

以下示例展示了如何在 Aspire 应用中添加达梦数据库资源，并将其作为服务依赖进行统一编排。

var builder = DistributedApplication.CreateBuilder(args);var dmdb = builder.AddDmdb("dmdb");
var database = dmdb.AddDatabase("appdb");builder.AddProject<Projects.Api>("api")
.WithReference(database)
.WaitFor(database);builder.Build().Run();

该方式可用于基于达梦数据库的本地开发和集成调试场景，数据库资源启动后，依赖服务将按顺序启动。

DMDB 自定义配置

以下示例展示了如何配置达梦数据库的用户信息、DBA 密码、主机端口和数据持久化。

var builder = DistributedApplication.CreateBuilder(args);var password = builder.AddParameter("dmdb-password", secret: true);
var dbaPassword = builder.AddParameter("dmdb-dba-password", secret: true);
var userName = builder.AddParameter("dmdb-user");var dmdb = builder.AddDmdb(
"dmdb",
userName: userName,
password: password,
dbaPassword: dbaPassword)
.WithHostPort(5236)
.WithDataVolume();var database = dmdb.AddDatabase("appdb");builder.AddProject<Projects.Api>("api")
.WithReference(database)
.WaitFor(database);builder.Build().Run();

该示例适用于需要保留本地测试数据、使用固定端口连接数据库或统一管理访问凭据的场景。

MongoDB 副本集示例

除关系型数据库外，NetCorePal.Aspire 也支持 MongoDB 副本集能力，以满足分布式应用中对高可用 MongoDB 开发环境的需求。

var builder = DistributedApplication.CreateBuilder(args);var username = builder.AddParameter("mongo-user", "admin");
var password = builder.AddParameter("mongo-password", "admin");var mongo = builder
.AddMongoDB("mongo", 27017, username, password)
.WithReplicaSet();var mongoDb = mongo.AddDatabase("appdb");var replicaSet = builder.AddMongoReplicaSet("mongo-rs", mongoDb.Resource);builder.AddProject<Projects.Api>("api")
.WithReference(mongoDb)
.WithReference(replicaSet)
.WaitFor(mongoDb)
.WaitFor(replicaSet);await builder.Build().RunAsync();

该方式适合需要在本地环境验证 MongoDB 副本集行为的开发和测试场景。

模板工程中的使用方式

NetCorePal.Aspire 已集成到 netcorepal-cloud-template。基于模板创建工程后，可直接在 AppHost 中声明基础设施资源，无需额外完成接入封装。

以下示例展示了模板工程中多个服务共享数据库资源的典型写法：

var builder = DistributedApplication.CreateBuilder(args);var openGauss = builder.AddOpenGauss("opengauss");
var appDb = openGauss.AddDatabase("appdb");builder.AddProject<Projects.IdentityService>("identity-service")
.WithReference(appDb)
.WaitFor(appDb);builder.AddProject<Projects.OrderService>("order-service")
.WithReference(appDb)
.WaitFor(appDb);builder.Build().Run();

通过这种方式，项目可以在统一的应用模型下完成数据库资源声明、依赖注入和服务编排，实现开箱即用的开发体验。