From 6e4d286f869003a79555cf060e0a3e5609aae880 Mon Sep 17 00:00:00 2001 From: hello Date: Tue, 18 Mar 2025 17:33:09 +0800 Subject: [PATCH] =?UTF-8?q?=E9=9B=86=E6=88=90=E5=AE=A2=E6=88=B7=E7=AB=AF?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- notes/helloshop/aspire-host-overview.md | 163 ++++++++++++++++++++++++ notes/helloshop/aspire-postgresql.md | 42 ++++++ 2 files changed, 205 insertions(+) create mode 100644 notes/helloshop/aspire-host-overview.md diff --git a/notes/helloshop/aspire-host-overview.md b/notes/helloshop/aspire-host-overview.md new file mode 100644 index 0000000..2896fe4 --- /dev/null +++ b/notes/helloshop/aspire-host-overview.md @@ -0,0 +1,163 @@ +# 关于 Aspire 应用宿主的编排 + +## 通过 Add 方法添加应用组件 + +通过 AddProject、AddContainer、AddExecutable、AddParameter，AddConnectionString 等方法，可以将应用宿主编排为一个完整的应用。 + +## 配置显式资源启动 + +```csharp +builder.AddProject("dbmigration").WithExplicitStart(); +``` + +使用 WithExplicitStart 方法，可以配置显式资源启动，显式资源启动的资源需要手动启动。 + +## 资源的引用通过 WithReference 方法 + +```csharp +builder.AddProject("myapp").WithReference(postgresdb); +``` + +被引用资源可以是一个终结点，连接字符串，或者其他资源，所引用的资源会通过环境变量的方式传递给引用资源。 + +## 等待资源启动和完成 + +```csharp +builder.AddProject("myapp").WithWaitFor(postgresdb); +``` + +```csharp +builder.AddProject("myapp").WithWaitForCompletion("dbmigration"); +``` + +## 自定义容器的启动参数 + +```csharp +var cache = builder.AddRedis("cache").WithImageTag("latest"); +``` + +## 容器资源生存期 + +```csharp +var cache1 = builder.AddRedis("cache1").WithLifetime(ContainerLifetime.Persistent); +var cache2 = builder.AddRedis("cache1").WithLifetime(ContainerLifetime.Session); +``` + +Persistent 表示容器资源的生存期为持久，Session 表示容器资源的生存期为会话。 + +## 外部参数 + +在 Host 项目的 appsettings.json 配置文件中添加如下节点。 + +```json +{ + "Parameters": { + "myvalue": "local-value" + } +} +``` + +```csharp +var value1 = builder.AddParameter("myvalue"); +var value2 = builder.AddParameter("myvalue", secret: true); + +builder.AddProject("api").WithEnvironment("EXAMPLE_VALUE", value1); +``` + +## 外部连接字符串 + +在 Host 项目的 appsettings.json 配置文件中添加如下节点。 + +```json +{ + "ConnectionStrings": { + "myconnection": "Server=myserver;Database=mydb;User=myuser;Password=mypassword;" + } +} +``` + +```csharp +var connection = builder.AddConnectionString("myconnection"); + +builder.AddProject("api").WithReference(connection); +``` + +## 连接字符串和终结点引用 + +```csharp +var builder = DistributedApplication.CreateBuilder(args); + +var customContainer = builder.AddContainer("myapp", "mycustomcontainer").WithHttpEndpoint(port: 9043, name: "endpoint"); + +var endpoint = customContainer.GetEndpoint("endpoint"); + +var apiservice = builder.AddProject("apiservice").WithReference(endpoint); + +``` + +## 在 Redis 组件上启用管理扩展 + +```csharp +var redis = builder.AddRedis("redis").WithManagement(); +var redis = builder.AddRedis("redis").WithRedisCommander(); +``` + +## 注册生命周期钩子 + +```csharp +using Aspire.Hosting.Lifecycle; +using Microsoft.Extensions.Logging; + +var builder = DistributedApplication.CreateBuilder(args); + +builder.Services.AddLifecycleHook(); + +builder.Build().Run(); + +class LifecycleLogger(ILogger logger): IDistributedApplicationLifecycleHook +{ + public Task BeforeStartAsync(DistributedApplicationModel appModel, CancellationToken cancellationToken = default) + { + logger.LogInformation("BeforeStartAsync"); + return Task.CompletedTask; + } + + public Task AfterEndpointsAllocatedAsync( + DistributedApplicationModel appModel, CancellationToken cancellationToken = default) + { + logger.LogInformation("AfterEndpointsAllocatedAsync"); + return Task.CompletedTask; + } + + public Task AfterResourcesCreatedAsync( + DistributedApplicationModel appModel, CancellationToken cancellationToken = default) + { + logger.LogInformation("AfterResourcesCreatedAsync"); + return Task.CompletedTask; + } +} +``` + +## 网络模型和多副本启动 + +```csharp +builder.AddProject("frontend") + .WithHttpEndpoint(port: 5066, IsExternal: true, IsProxied: true) + .WithReplicas(2); +``` + +IsExternal 和 IsProxied 属性决定了终结点的管理和公开方式，IsExternal 为 true 时，终结点会被公开，IsProxied 为 true 时，终结点会被代理。 + +https://learn.microsoft.com/zh-cn/dotnet/aspire/fundamentals/networking-overview + + +## 其它功能 + +- 自定义资源命令 +- 将 Dockerfiles 添加到 .NET 应用模型 +- 捕获 Aspire 中的事件 + +## 参阅资料 + +https://learn.microsoft.com/zh-cn/dotnet/aspire + diff --git a/notes/helloshop/aspire-postgresql.md b/notes/helloshop/aspire-postgresql.md index e69de29..85ebbe0 100644 --- a/notes/helloshop/aspire-postgresql.md +++ b/notes/helloshop/aspire-postgresql.md @@ -0,0 +1,42 @@ +# 在 Aspire 中集成 PostgreSQL 数据库 + +## 在 Host 项目中添加 PostgreSQL 数据库 + +```shell +dotnet add package Aspire.Hosting.PostgreSQL +``` + +```csharp +var builder = DistributedApplication.CreateBuilder(args); + +var postgres = builder.AddPostgres("postgres"); +var postgresdb = postgres.AddDatabase("postgresdb"); + +var exampleProject = builder.AddProject().WithReference(postgresdb); +``` + +## 添加 PostgreSQL pgAdmin 资源 + +```csharp +var postgres = builder.AddPostgres("postgres").WithPgAdmin(); +``` + + +## 添加 PostgreSQL pgWeb 资源 + +```csharp +var postgres = builder.AddPostgres("postgres").WithPgWeb(); +``` + +## 在最终的应用中引用 PostgreSQL 数据库 + +```shell +dotnet add package Aspire.Npgsql.EntityFrameworkCore.PostgreSQL +``` + +```csharp +builder.AddNpgsqlDbContext(connectionName: DbConstants.ConnectionStringName, configureDbContextOptions: options => +{ + new NpgsqlDbContextOptionsBuilder(options).MigrationsHistoryTable(DbConstants.MigrationsHistoryTableName); +}); +```