Aspire會自動啟動和管理數據庫容器(MySQL、管理前後端都用了TypeScript,系统希望能給正在做類似項目的实践朋友一些參考。結合.NET 10和Vue 3搭建了一套完整的基于架构前後端分離架構。可以查看所有服務的管理狀態。性能也更好。系统開發體驗上,实践省了很多麻煩 。基于架构還會提供統一的管理Aspire Dashboard界麵,每個聚合根都有自己的系统業務邊界,
看一個創建部門的实践例子:
/// <summary>/// 創建部門的API端點/// </summary>[Tags("Depts")]public class CreateDeptEndpoint(IMediator mediator) : Endpoint<CreateDeptRequest, ResponseData<CreateDeptResponse>>{ public override void Configure() { Post("/api/admin/dept"); AuthSchemes(JwtBearerDefaults.AuthenticationScheme); Permissions(PermissionCodes.AllApiAccess, PermissionCodes.DeptCreate); } public override async Task HandleAsync(CreateDeptRequest req, CancellationToken ct) { var cmd = new CreateDeptCommand(req.Name, req.Remark, req.ParentId, req.Status); var deptId = await mediator.Send(cmd, ct); var response = new CreateDeptResponse(deptId, req.Name, req.Remark); await Send.OkAsync(response.AsResponseData(), cancellation: ct); }}代碼很簡潔 ,想嚐試一下DDD架構在實際項目中的基于架构應用 。隻選擇需要的管理字段 :
/// <summary>/// 部門查詢服務/// </summary>public class DeptQuery(ApplicationDbContext applicationDbContext) : IQuery{ private DbSet<Dept> DeptSet { get; } = applicationDbContext.Depts; /// <summary> /// 獲取部門樹(使用投影優化性能) /// </summary> public async Task<IEnumerable<DeptTreeDto>> GetDeptTreeAsync( bool includeInactive = false, CancellationToken cancellationToken = default) { // 使用投影隻選擇需要的字段
,Name={ d.Name}"); }}4. 異常處理
業務異常用KnownException來處理,系统配合EF Core做數據訪問,用起來很方便。比如在聚合根裏
:
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,雲原生支持也很到位,領域事件要在聚合發生改變時發布
。Aspire讓基礎設施管理變得簡單。一個類就把路由、方便新人理解架構。Vite、ncprepo可以生成倉儲接口和實現 ,代碼分層清晰,路由用Vue Router。總結
這個項目算是一個DDD架構的實踐案例,
如果你也在做類似的管理係統
,
雲原生支持
項目集成了.NET Aspire,開發效率還可以。還有完善的開發規範 ,
技術棧上
,直接使用DbContext
,主題和布局也可以定製,需要檢查部門名稱是否已存在
,PostgreSQL等)
、
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,職責清晰
。就是一個record。另外,就可以用異步驗證 :
public class CreateDeptCommandValidator : AbstractValidator<CreateDeptCommand>{ public CreateDeptCommandValidator(DeptQuery deptQuery) { RuleFor(d => d.Name).NotEmpty().WithMessage("部門名稱不能為空"); // 異步驗證:檢查部門名稱是否已存在 RuleFor(d => d.Name) .MustAsync(async (n, ct) => !await deptQuery.DoesDeptExist(n, ct)) .WithMessage(d => $"該部門已存在,這個對理解架構很有幫助 。請求和響應都是強類型的
,命令處理器不能調用SaveChanges
,Domain層隻關注業務邏輯,後端用.NET 10 + EF Core + FastEndpoints + MediatR
,而且可以針對不同的場景做優化。這個功能真的很方便。展示了如何在.NET 10生態中應用DDD
、項目源碼地址
:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,比如權限控製
,支持同步和異步驗證
。首先是強類型ID,整體體驗不錯。
代碼分析可視化
框架還提供了代碼流分析和可視化功能 ,領域事件主要用於聚合內部的同步操作,整體架構清晰 ,Aspire會自動管理所有依賴服務 ,不依賴任何其他層
。
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目 ,接口定義好之後 ,權限都配置好了。MediatR實現CQRS模式
。
2. 倉儲模式
倉儲這塊,比如DeptId,可以模擬登錄用戶的各種操作。命令處理器裏不需要手動調用
,FastEndpoints替代傳統的Controller ,代碼組織得也比較規範。Name={ d.Name}"); RuleFor(d => d.Status).InclusiveBetween(0, 1).WithMessage("狀態值必須為0或1"); }}/// <summary>/// 命令處理器/// </summary>public class CreateDeptCommandHandler(IDeptRepository deptRepository) : ICommandHandler<CreateDeptCommand, DeptId>{ public async Task<DeptId> Handle(CreateDeptCommand request, CancellationToken cancellationToken) { var parentId = request.ParentId ?? new DeptId(0); var dept = new Dept(request.Name, request.Remark, parentId, request.Status); await deptRepository.AddAsync(dept, cancellationToken); // 注意:不需要手動調用SaveChanges
,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中 ,每個命令都有對應的驗證器和處理器。有興趣的朋友可以深入了解一下 :
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址
:https://github.com/zhouda1fu/Ncp.Admin
可以多語言切換 。經過一番調研
,可以快速生成常用代碼。編譯器就能幫你檢查出來。項目地址在https://github.com/zhouda1fu/Ncp.Admin
,包含了用戶 、歡迎交流討論
。類圖等,比如所有聚合根都用強類型ID ,業務異常用KnownException處理
。這樣做的好處是職責清晰
,這樣做的好處是編譯器能幫你檢查類型錯誤
,另外
,Ant Design Vue ,支持路由權限和按鈕權限
,項目還提供了很多代碼片段,集成測試用了Aspire來自動管理測試環境
。寫操作這邊,Redis容器
,測試支持也比較完善,寫操作通過倉儲來處理 ,今天就想和大家分享一下這個項目的架構設計和技術選型,
前端部分基於Vben Admin
,或者將來可以加緩存、項目裏製定了一些開發規範
。而且可以用投影來優化性能 。
3. 事件驅動架構
事件驅動這塊,必須通過業務方法,比如創建部門的時候
,
讀操作這邊,這樣開發效率會高不少。開箱即用的功能很多
。直接測端點就行了
。依賴EF的值生成器 。
參考資料
最後附上一些相關的參考資料 ,事件驅動這些架構思想
。當部門信息變更時會發布領域事件,框架會自動處理。PostgreSQL和SQL Server,框架會自動轉換成合適的HTTP狀態碼。數據存儲支持MySQL、倉儲必須用異步方法
。這樣可以避免把部門ID和用戶ID搞混 ,使用.NET 10作為主要框架,其次是屬性都用private set,Redis
、消息隊列容器(RabbitMQ等)、隻需要再加一個事件處理器就行了,
前端架構
前端用的是Vben Admin這個模板
,一個端點就是一個類 ,這樣可以通知其他需要同步更新的地方
,消息隊列選擇了RabbitMQ(通過CAP框架集成),用戶ID是UserId。前端用Vue 3 + TypeScript + Vite,角色
、這個結構應該很多做DDD的朋友都比較熟悉。測試的是完整的HTTP請求流程,不需要手動啟動數據庫、就拿部門這個聚合根來說吧
:
/// <summary>/// 部門ID(強類型ID)/// </summary>public partial record DeptId : IInt64StronglyTypedId;/// <summary>/// 部門聚合根/// </summary>public class Dept : Entity<DeptId>, IAggregateRoot{ public string Name { get; private set; } = string.Empty; public string Remark { get; private set; } = string.Empty; public DeptId ParentId { get; private set; } = default!; public int Status { get; private set; } = 1; protected Dept() { } // 業務方法
:更新部門信息 public void UpdateInfo(string name, string remark, DeptId parentId, int status) { Name = name; Remark = remark; ParentId = parentId; Status = status; UpdateTime = new UpdateTime(DateTimeOffset.UtcNow); // 發布領域事件 AddDomainEvent(new DeptInfoChangedDomainEvent(this)); } // 軟刪除 public void SoftDelete() { if (IsDeleted) { throw new KnownException("部門已經被刪除"); } IsDeleted = true; UpdateTime = new UpdateTime(DateTimeOffset.UtcNow); }}
這裏有幾個設計點我覺得值得說一下 。可以直觀地看到代碼之間的關係和數據流向
。Aspire會自動啟動和管理。應該能有一些參考價值
。當部門信息變更的時候,有代碼片段 、CQRS
、而且測試起來也很方便
,可以看看這個項目的代碼,或者想了解DDD在實際項目中的應用
,在技術選型上
,需要同步更新用戶表中的部門名稱 。
使用起來也很簡單 :
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);
框架會自動處理序列化和類型轉換
,比如部門變更時要發送通知 ,事件流程圖、不需要再做額外的轉換 。不會把部門ID和用戶ID搞混。
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)
這種分層的好處是職責清晰,比如用戶表中的部門名稱 。UI組件用的是Ant Design Vue,采用了目前比較主流的技術棧:
後端方麵,項目用的是xUnit,
比如說,主要是覺得FastEndpoints的代碼更簡潔,狀態管理用Pinia ,集成事件用於跨服務通信 。不需要啟動HTTP服務器,最終選擇了NetCorePal Cloud Framework作為基礎框架,類型安全有保障。不需要改現有的代碼。Redis這些基礎設施 ,這樣代碼更簡潔
,另外還支持身份認證測試 ,
測試策略
測試這塊,而且會自動清理測試數據,查詢這邊可以針對不同的查詢場景做優化
,
3. 驗證機製
驗證用的是FluentValidation,TypeScript 、Infrastructure層依賴Domain層,狀態隻能通過業務方法來修改。倉儲的實現很簡單 :
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }
框架會自動管理事務和SaveChanges,命令鏈路圖、而且不手動賦值ID,
最重要的是類型安全 ,而不會影響寫操作的邏輯
。還有國際化支持,部門等基礎功能模塊。支持同步和異步驗證。認證、用讀庫等 ,所有命令都要有對應的驗證器 。如果將來需要增加新的業務邏輯,
4. FastEndpoints輕量級API框架
在API設計這塊,可以通過命令行工具生成HTML文件
:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖、讀操作通過查詢(Query)來處理。啟動開發環境隻需要運行AppHost項目,比如用投影減少內存占用
,還有代碼可視化工具,Infrastructure層負責技術實現,看一個創建部門的例子:
/// <summary>/// 創建部門命令/// </summary>public record CreateDeptCommand(string Name, string Remark, DeptId? ParentId, int Status) : ICommand<DeptId>;/// <summary>/// 命令驗證器/// </summary>public class CreateDeptCommandValidator : AbstractValidator<CreateDeptCommand>{ public CreateDeptCommandValidator(DeptQuery deptQuery) { RuleFor(d => d.Name).NotEmpty().WithMessage("部門名稱不能為空"); RuleFor(d => d.Name) .MustAsync(async (n, ct) => !await deptQuery.DoesDeptExist(n, ct)) .WithMessage(d => $"該部門已存在 ,基本的管理後台需求都能滿足。技術棧也比較主流:Vue 3 Composition API
、三層之間的依賴關係是單向的:Web層依賴Infrastructure層 ,緩存用Redis,通過事件來通信。就可以用異步的MustAsync