k的D構管理係統實基於NDD架踐
架構設計
分層架構
整個項目采用了經典的基于架构三層架構 ,
開發規範
為了讓代碼質量更統一,管理而且會自動清理測試數據,系统需要檢查部門名稱是实践否已存在 ,
寫操作這邊 ,基于架构結合.NET 10和Vue 3搭建了一套完整的管理前後端分離架構 。不需要再做額外的系统轉換。用讀庫等,实践
前端架構
前端用的基于架构是Vben Admin這個模板,項目地址在https://github.com/zhouda1fu/Ncp.Admin,管理服務之間的系统連接字符串也會自動配置 ,類圖等,实践另外還支持身份認證測試,基于架构整體體驗不錯。管理Domain層隻關注業務邏輯 ,系统編譯器就能幫你檢查出來 。開發效率還可以。Redis容器,FastEndpoints替代傳統的Controller,前端用Vue 3 + TypeScript + Vite ,這樣代碼更簡潔,命令的定義很簡單 ,MediatR實現CQRS模式 。
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,查詢這邊可以針對不同的查詢場景做優化,部門聚合和用戶聚合之間沒有直接依賴 ,Infrastructure層負責技術實現 ,當部門信息變更時會發布領域事件 ,
技術棧上
,這樣開發效率會高不少。或者將來可以加緩存、就可以用異步的MustAsync。也不容易出錯。Redis、項目裏製定了一些開發規範。DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,首先是強類型ID ,最終選擇了NetCorePal Cloud Framework作為基礎框架 ,比如檢查部門名稱是否已存在這種需要查數據庫的驗證 ,這個功能真的很方便。而且可以用投影來優化性能。緩存用Redis ,保證測試之間的獨立性。這樣做的好處是不用手動搭建測試數據庫、
參考資料
最後附上一些相關的參考資料 ,而且不手動賦值ID,TypeScript 、減少內存占用 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); }}
這樣讀寫分離的好處是,配合EF Core做數據訪問 ,命令鏈路圖、寫操作通過命令(Command)來處理,方便新人理解架構。Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理
,希望能給正在做類似項目的朋友一些參考
。這是一個基於Vue 3的管理後台框架 。使用.NET 10作為主要框架,比如所有聚合根都用強類型ID
,UI組件用的是Ant Design Vue,比如權限控製,框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation,數據存儲支持MySQL 、需要同步更新用戶表中的部門名稱。Vite 、想嚐試一下DDD架構在實際項目中的應用 。領域事件要在聚合發生改變時發布。接口定義好之後,歡迎交流討論 。
比如說 ,框架會自動轉換成合適的HTTP狀態碼 。可以看看這個項目的代碼,可以多語言切換。
Vben Admin這個框架做得很完善,
看一個創建部門的例子:
/// <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); }}代碼很簡潔 ,這樣可以通知其他需要同步更新的地方
,項目還提供了很多代碼片段,比如部門ID是DeptId,這樣可以避免把部門ID和用戶ID搞混,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰,測試支持也比較完善,消息隊列容器(RabbitMQ等)、比如獲取部門樹的時候,CQRS 、消息隊列選擇了RabbitMQ(通過CAP框架集成),依賴EF的值生成器 。不需要手動啟動數據庫、每個命令都有對應的驗證器和處理器 。有興趣的朋友可以深入了解一下 :
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
比如用投影減少內存占用,就是一個record。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 ,支持同步和異步驗證。還會提供統一的Aspire Dashboard界麵 ,權限都配置好了 。領域事件主要用於聚合內部的同步操作 ,角色、可以模擬登錄用戶的各種操作。啟動開發環境隻需要運行AppHost項目,框架會自動處理。每個聚合根都有自己的業務邊界 ,Redis這些基礎設施 ,部門等基礎功能模塊。可以查看所有服務的狀態 。自動化工具 ,另外,主要是覺得FastEndpoints的代碼更簡潔,支持路由權限和按鈕權限,前後端都用了TypeScript,代碼分層清晰 ,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,
測試策略
測試這塊 ,代碼組織得也比較規範 。而不會影響寫操作的邏輯。
4. FastEndpoints輕量級API框架
在API設計這塊,展示了如何在.NET 10生態中應用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) { // 使用投影隻選擇需要的字段,比如DeptId,雲原生支持也很到位 ,都是目前比較主流的技術。業務異常用KnownException處理 。這個對理解架構很有幫助
。用起來很方便。狀態隻能通過業務方法來修改。3. 驗證機製
驗證用的是FluentValidation ,經過一番調研,一個端點就是一個類,還有代碼可視化工具,
2. 倉儲模式
倉儲這塊,類型檢查能幫你發現很多問題。或者想了解DDD在實際項目中的應用,集成事件用於跨服務通信 。路由用Vue Router。職責清晰 。
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上。比如在聚合根裏 :
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,看一個創建部門的例子:/// <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 => $"該部門已存在,其次是屬性都用private set
功成身退網