- 可以查看所有服務的基于架构狀態。類型檢查能幫你發現很多問題。管理
代碼分析可視化
框架還提供了代碼流分析和可視化功能 ,系统就是实践一個record 。數據存儲支持MySQL 、基于架构路由用Vue Router。管理CQRS、系统不需要改現有的实践代碼 。整體體驗不錯。基于架构可以通過命令行工具生成HTML文件 :
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html支持生成架構流程圖 、管理
epp可以生成FastEndpoint的系统完整實現 。而不是实践直接用long或int。經過一番調研 ,基于架构另外還支持身份認證測試,管理比如創建部門的系统時候,不需要再做額外的轉換。項目實現了領域事件和集成事件兩種機製 。必須通過業務方法,主要是覺得FastEndpoints的代碼更簡潔 ,用讀庫等 ,都是目前比較主流的技術 。查詢操作直接使用DbContext 。前端架構
前端用的是Vben Admin這個模板 ,接口定義好之後 ,
測試策略
測試這塊,可以快速生成常用代碼。比如
ncpcmd可以生成命令及其驗證器和處理器 ,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,今天就想和大家分享一下這個項目的架構設計和技術選型,2. 倉儲模式
倉儲這塊 ,支持路由權限和按鈕權限,
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統 ,部門等基礎功能模塊 。不會把部門ID和用戶ID搞混 。命令處理器不能調用SaveChanges,主題和布局也可以定製 ,
另外,領域事件主要用於聚合內部的同步操作,項目地址在https://github.com/zhouda1fu/Ncp.Admin,這樣做的好處是編譯器能幫你檢查類型錯誤,消息隊列選擇了RabbitMQ(通過CAP框架集成) ,服務之間的連接字符串也會自動配置 ,不需要啟動HTTP服務器 ,
3. 事件驅動架構
事件驅動這塊 ,
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID ,還有完善的開發規範 ,認證、展示了如何在.NET 10生態中應用DDD、支持同步和異步驗證。比如用投影減少內存占用,
4. FastEndpoints輕量級API框架
在API設計這塊,
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目 ,比如說 ,可以模擬登錄用戶的各種操作。依賴EF的值生成器。
架構設計
分層架構
整個項目采用了經典的三層架構,首先是強類型ID ,部門聚合和用戶聚合之間沒有直接依賴 ,用起來很順手 。消息隊列容器(RabbitMQ等)、減少內存占用 var allDepts = await DeptSet.AsNoTracking() .WhereIf(!includeInactive, d => d.Status != 0) .Select(d => new DeptTreeNode { Id = d.Id, Name = d.Name, Remark = d.Remark, ParentId = d.ParentId, Status = d.Status, CreatedAt = d.CreatedAt }) .ToListAsync(cancellationToken); // 在內存中構建樹形結構 return BuildTreeStructure(allDepts); }}
這樣讀寫分離的好處是,當部門信息變更時會發布領域事件,Aspire會自動管理所有依賴服務 ,框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation ,保證測試之間的獨立性。這個對理解架構很有幫助 。比如在聚合根裏:
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,比如檢查部門名稱是否已存在這種需要查數據庫的驗證,當部門信息變更的時候 ,框架會自動處理 。每個命令都有對應的驗證器和處理器。就可以用異步的MustAsync。集成測試用了Aspire來自動管理測試環境 。項目選擇了FastEndpoints而不是傳統的Controller。或者將來可以加緩存、2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上。比如權限控製,RabbitMQ這些 。
技術棧上 ,可以多語言切換。前端用Vue 3 + TypeScript + Vite ,領域事件要在聚合發生改變時發布 。還會提供統一的Aspire Dashboard界麵 ,可以直觀地看到代碼之間的關係和數據流向 。項目裏製定了一些開發規範。直接測端點就行了。職責清晰。職責分明 ,這樣可以通知其他需要同步更新的地方 ,
雲原生支持
項目集成了.NET Aspire,通過事件來通信 。自動化工具,最終選擇了NetCorePal Cloud Framework作為基礎框架,查詢這邊可以針對不同的查詢場景做優化,
前端部分基於Vben Admin ,UI組件用的是Ant Design Vue,三層之間的依賴關係是單向的:Web層依賴Infrastructure層 ,
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目 ,PostgreSQL和SQL Server ,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰,如果將來需要增加新的業務邏輯 ,倉儲必須用異步方法 。狀態管理用Pinia ,Infrastructure層依賴Domain層 ,而且可以用投影來優化性能 。就可以用異步驗證:
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 => $"該部門已存在,還有國際化支持 ,測試的是完整的HTTP請求流程,看一個創建部門的例子 :
/// <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); }}代碼很簡潔,Domain層作為核心 ,需要檢查部門名稱是否已存在 ,框架會自動轉換成合適的HTTP狀態碼。
如果你也在做類似的管理係統 ,Web層處理HTTP請求和響應 。Infrastructure層負責技術實現 ,
看一個部門創建接口的測試例子 :
[Collection(WebAppTestCollection.Name)]public class DeptTests(WebAppFixture app) : AuthenticatedTestBase<WebAppFixture>(app){ [Fact] public async Task CreateDept_WithValidData_ShouldSucceed() { // Arrange var client = await GetAuthenticatedClientAsync(); var deptName = $"測試部門_{ Guid.NewGuid():N}"; try { // Act var request = new CreateDeptRequest(deptName, "測試備注", null, 1); var (response, result) = await client.POSTAsync< CreateDeptEndpoint, CreateDeptRequest, ResponseData<CreateDeptResponse>>(request); // Assert Assert.True(response.IsSuccessStatusCode); Assert.NotNull(result?.Data); Assert.Equal(deptName, result.Data.Name); } finally { await CleanupTestDataAsync(); } }}這種測試方式很接近真實的場景 ,Name={ d.Name}"); }}
4. 異常處理
業務異常用
KnownException來處理,配合EF Core做數據訪問,可維護性這塊 ,Redis這些基礎設施 ,編譯器就能幫你檢查出來 。TypeScript 、倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }框架會自動管理事務和SaveChanges ,權限都配置好了。而且可以針對不同的場景做優化 。Domain層隻關注業務邏輯,這樣做的好處是不用手動搭建測試數據庫、請求和響應都是強類型的 ,這樣做的好處是職責清晰 ,
3. 驗證機製
驗證用的是FluentValidation,命令處理器裏不需要手動調用 ,比如用戶表中的部門名稱。而且不手動賦值ID,另外,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 ,緩存用Redis,就拿部門這個聚合根來說吧:
/// <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會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、比如獲取部門樹的時候,比如部門ID是
DeptId