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