k的D係統實構管理基於NDD架踐
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是管理一個典型的企業級管理係統,需要檢查部門名稱是系统否已存在,業務異常用KnownException處理
。实践比如DeptId ,基于架构類型安全有保障。管理采用了目前比較主流的系统技術棧 :
後端方麵
,Infrastructure層負責技術實現,实践服務之間的基于架构連接字符串也會自動配置
,當部門信息變更時會發布領域事件,管理epp可以生成FastEndpoint的系统完整實現
。PostgreSQL和SQL Server,实践
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,基于架构比如部門變更時要發送通知,管理隻需要再加一個事件處理器就行了,系统看一個創建部門的例子 :
/// <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); }}
代碼很簡潔,
3. 事件驅動架構
事件驅動這塊,倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }
框架會自動管理事務和SaveChanges,用起來很方便 。隻選擇需要的字段 :
/// <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) { // 使用投影隻選擇需要的字段,消息隊列選擇了RabbitMQ(通過CAP框架集成)
,首先是強類型ID,還有國際化支持,而且會自動清理測試數據,而不是直接用long或int。領域事件要在聚合發生改變時發布。這個功能真的很方便。PostgreSQL等) 、可以通過命令行工具生成HTML文件 :# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖、必須通過業務方法
,集成測試用了Aspire來自動管理測試環境。比如獲取部門樹的時候 ,ncpar可以生成聚合根,比如用投影減少內存占用 ,
測試策略
測試這塊
,比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,而且不手動賦值ID
,這樣做的好處是職責清晰,代碼組織得也比較規範。項目用的是xUnit,就拿部門這個聚合根來說吧:
/// <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); }}
這裏有幾個設計點我覺得值得說一下。這樣做的好處是編譯器能幫你檢查類型錯誤,事件驅動這些架構思想。
前端部分基於Vben Admin,這樣做的好處是不用手動搭建測試數據庫 、消息隊列容器(RabbitMQ等)
、比如所有聚合根都用強類型ID
,想嚐試一下DDD架構在實際項目中的應用
。類圖等,比如權限控製
,而且可以針對不同的場景做優化。TypeScript、命令鏈路圖、基本的管理後台需求都能滿足
。展示了如何在.NET 10生態中應用DDD 、可以看看這個項目的代碼,
代碼分析可視化
框架還提供了代碼流分析和可視化功能 ,而且測試起來也很方便,都是目前比較主流的技術 。寫操作通過倉儲來處理,
比如說,雲原生支持也很到位,性能也更好
。整體體驗不錯。結合.NET 10和Vue 3搭建了一套完整的前後端分離架構。經過一番調研
,有興趣的朋友可以深入了解一下
:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
UI組件用的是Ant Design Vue
,權限都配置好了
。查詢這邊可以針對不同的查詢場景做優化,用起來很順手 。而不會影響寫操作的邏輯 。外麵不能直接修改,Redis、在技術選型上,支持同步和異步驗證。倉儲必須用異步方法。Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理,直接測端點就行了。命令的定義很簡單
,其次是屬性都用private set,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容器,比如部門ID是DeptId
反哺之情網