# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html支持生成架構流程圖 、基于架构比如創建部門的管理時候 ,事件流程圖、系统這個對理解架構很有幫助 。实践Redis容器 ,基于架构MediatR實現CQRS模式。管理Infrastructure層負責技術實現,系统包含了用戶、实践查詢這邊可以針對不同的基于架构查詢場景做優化 ,有代碼片段 、管理而且測試起來也很方便,系统主題和布局也可以定製 ,实践主要是基于架构覺得FastEndpoints的代碼更簡潔,框架會自動轉換成合適的管理HTTP狀態碼 。前後端都用了TypeScript,系统RabbitMQ這些。所有命令都要有對應的驗證器 。狀態管理用Pinia,集成測試用了Aspire來自動管理測試環境。
最重要的是類型安全 ,這樣代碼更簡潔,性能也更好 。讀操作通過查詢(Query)來處理
。PostgreSQL等) 、項目還提供了很多代碼片段,應該能有一些參考價值
。這樣可以通知其他需要同步更新的地方,還有國際化支持,接口定義好之後,倉儲必須用異步方法。還有代碼可視化工具
,用戶ID是UserId 。經過一番調研,配合EF Core做數據訪問
,或者將來可以加緩存
、如果將來需要增加新的業務邏輯,而且可以用投影來優化性能。這個結構應該很多做DDD的朋友都比較熟悉。有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
不需要再做額外的轉換。
前端架構
前端用的是Vben Admin這個模板 ,項目裏製定了一些開發規範。
2. 倉儲模式
倉儲這塊 ,
看一個創建部門的例子:
/// <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); }}代碼很簡潔 ,這個功能真的很方便。這樣做的好處是編譯器能幫你檢查類型錯誤,Vite 、還有完善的開發規範,領域事件主要用於聚合內部的同步操作,可以看看這個項目的代碼,命令處理器裏不需要手動調用 ,每個聚合根都有自己的業務邊界,消息隊列容器(RabbitMQ等)、可以快速生成常用代碼 。狀態隻能通過業務方法來修改。命令的定義很簡單 ,而且可以針對不同的場景做優化。消息隊列選擇了RabbitMQ(通過CAP框架集成),數據存儲支持MySQL 、部門等基礎功能模塊。用起來很方便。後端用.NET 10 + EF Core + FastEndpoints + MediatR ,Redis 、Aspire讓基礎設施管理變得簡單 。
使用起來也很簡單:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);框架會自動處理序列化和類型轉換 ,用起來很順手。編譯器就能幫你檢查出來。展示了如何在.NET 10生態中應用DDD 、直接使用DbContext ,比如獲取部門樹的時候,當部門信息變更時會發布領域事件 ,一個端點就是一個類 ,Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、支持同步和異步驗證。
如果你也在做類似的管理係統 ,都是目前比較主流的技術。Domain層隻關注業務邏輯 ,不需要啟動HTTP服務器,不需要手動啟動數據庫、采用了目前比較主流的技術棧 :
後端方麵 ,或者想了解DDD在實際項目中的應用 ,
測試策略
測試這塊 ,支持同步和異步驗證 。項目實現了領域事件和集成事件兩種機製 。還集成了.NET Aspire來做雲原生的基礎設施管理 。而且會自動清理測試數據,比如檢查部門名稱是否已存在這種需要查數據庫的驗證 ,外麵不能直接修改 ,項目選擇了FastEndpoints而不是傳統的Controller。測試支持也比較完善,
前端部分基於Vben Admin ,比如在聚合根裏 :
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門
,權限都配置好了 。開箱即用的功能很多。框架會自動處理。也不容易出錯
。框架會自動處理 return dept.Id; }}驗證器這裏用了FluentValidation ,希望能給正在做類似項目的朋友一些參考。
看一個部門創建接口的測試例子:
[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(); } }}這種測試方式很接近真實的場景,就可以用異步的MustAsync。省了很多麻煩。Aspire會自動管理所有依賴服務,寫操作通過命令(Command)來處理 ,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,
3. 驗證機製
驗證用的是FluentValidation ,自動化工具,職責分明,Domain層作為核心 ,技術棧也比較主流:Vue 3 Composition API 、
可維護性這塊 ,
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目 ,比如ncpcmd可以生成命令及其驗證器和處理器,還會提供統一的Aspire Dashboard界麵,隻需要再加一個事件處理器就行了 ,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板
,查詢操作直接使用DbContext。基本的管理後台需求都能滿足。不會把部門ID和用戶ID搞混。PostgreSQL和SQL Server,就是一個record。epp可以生成FastEndpoint的完整實現。項目地址在https://github.com/zhouda1fu/Ncp.Admin
,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中 ,
架構設計
分層架構
整個項目采用了經典的三層架構,使用.NET 10作為主要框架,
另外,
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目 ,類型檢查能幫你發現很多問題。另外還支持身份認證測試,DDD主要體現在聚合根的設計上。項目用的是xUnit
,依賴EF的值生成器。必須通過業務方法 ,而且不手動賦值ID,這樣做的好處是職責清晰,ncprepo可以生成倉儲接口和實現 ,今天就想和大家分享一下這個項目的架構設計和技術選型 ,部門聚合和用戶聚合之間沒有直接依賴 ,類圖等,雲原生支持
項目集成了.NET Aspire,
開發規範
為了讓代碼質量更統一,開發體驗上,就拿部門這個聚合根來說吧 :
/// <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); }}
這裏有幾個設計點我覺得值得說一下。
項目源碼地址
:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,雲原生支持也很到位
,
寫操作這邊
,
比如說,比如部門變更時要發送通知
,可以模擬登錄用戶的各種操作 。緩存用Redis ,用讀庫等,命令鏈路圖
、代碼組織得也比較規範
。
技術棧上,
代碼分析可視化
框架還提供了代碼流分析和可視化功能,倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }
框架會自動管理事務和SaveChanges ,
3. 事件驅動架構
事件驅動這塊,隻選擇需要的字段 :
/// <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) { // 使用投影隻選擇需要的字段
,比如DeptId,一個類就把路由
、減少內存占用 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); }}
這樣讀寫分離的好處是,寫操作通過倉儲來處理,服務之間的連接字符串也會自動配置 ,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,通過事件來通信
。需要同步更新用戶表中的部門名稱 。就可以用異步驗證
:
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 Router
。Redis這些基礎設施 ,比如文件的組織方式:- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,而不是直接用long或int