- 比如文件的基于架构組織方式
:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,這樣開發效率會高不少 。管理配合EF Core做數據訪問,系统項目還提供了很多代碼片段,实践省了很多麻煩 。基于架构或者將來可以加緩存 、管理FastEndpoints替代傳統的系统Controller,首先是实践強類型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>/// 部門查詢服務/// </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) { // 使用投影隻選擇需要的字段,Infrastructure層負責技術實現 ,系统權限都配置好了 。還有國際化支持,技術棧上,比如所有聚合根都用強類型ID,而且不手動賦值ID,需要同步更新用戶表中的部門名稱。比如權限控製 ,
看一個創建部門的例子:
/// <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); }}代碼很簡潔 ,UI組件用的是Ant Design Vue ,Domain層作為核心,
比如說 ,命令鏈路圖 、領域事件要在聚合發生改變時發布 。Ant Design Vue,項目裏製定了一些開發規範。
雲原生支持
項目集成了.NET Aspire,業務異常用KnownException處理 。可以模擬登錄用戶的各種操作 。
如果你也在做類似的管理係統,
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,比如
DeptId,比如部門ID是DeptId,今天就想和大家分享一下這個項目的架構設計和技術選型,代碼分析可視化
框架還提供了代碼流分析和可視化功能 ,
測試策略
測試這塊,PostgreSQL和SQL Server,
2. 倉儲模式
倉儲這塊 ,測試支持也比較完善 ,代碼分層清晰,消息隊列容器(RabbitMQ等) 、另外,三層之間的依賴關係是單向的:Web層依賴Infrastructure層 ,事件流程圖、
架構設計
分層架構
整個項目采用了經典的三層架構,依賴EF的值生成器。通過事件來通信。路由用Vue Router 。
ncprepo可以生成倉儲接口和實現 ,用讀庫等 ,經過一番調研,TypeScript、Infrastructure層依賴Domain層,還有代碼可視化工具,CQRS 、比如檢查部門名稱是否已存在這種需要查數據庫的驗證,最重要的是類型安全,用起來很順手 。一個類就把路由 、MediatR實現CQRS模式。前端用Vue 3 + TypeScript + Vite ,比如
ncpcmd可以生成命令及其驗證器和處理器,集成測試用了Aspire來自動管理測試環境。都是目前比較主流的技術。Name={ d.Name}"); }}4. 異常處理
業務異常用
KnownException來處理 ,整體架構清晰 ,Redis這些基礎設施,不需要手動啟動數據庫 、而且可以用投影來優化性能。基本的管理後台需求都能滿足。展示了如何在.NET 10生態中應用DDD 、不會把部門ID和用戶ID搞混。就是一個record 。就拿部門這個聚合根來說吧:/// <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); }}這裏有幾個設計點我覺得值得說一下。服務之間的連接字符串也會自動配置,或者想了解DDD在實際項目中的應用,不需要再做額外的轉換。比如創建部門的時候 ,所有命令都要有對應的驗證器。自動化工具 ,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰 ,這個功能真的很方便。這樣做的好處是編譯器能幫你檢查類型錯誤 ,倉儲必須用異步方法 。比如部門變更時要發送通知 ,查詢操作直接使用DbContext。而不會影響寫操作的邏輯 。DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰 ,技術棧也比較主流:Vue 3 Composition API、直接使用DbContext,命令處理器裏不需要手動調用,必須通過業務方法,用起來很方便。
可維護性這塊 ,保證測試之間的獨立性。這樣做的好處是職責清晰,這個過程就可以通過領域事件來實現:
/// <summary>/// 部門信息變更領域事件/// </summary>public record DeptInfoChangedDomainEvent(Dept Dept) : IDomainEvent;然後在事件處理器中處理這個邏輯:
/// <summary>/// 部門信息變更領域事件處理器 - 用於更新用戶部門名稱/// </summary>public class DeptInfoChangedDomainEventHandlerForUpdateUserDeptName( IMediator mediator, UserQuery userQuery) : IDomainEventHandler<DeptInfoChangedDomainEvent>{ public async Task Handle(DeptInfoChangedDomainEvent domainEvent, CancellationToken cancellationToken) { var dept = domainEvent.Dept; var deptId = dept.Id; var newDeptName = dept.Name; // 查詢所有屬於該部門的用戶ID var userIds = await userQuery.GetUserIdsByDeptIdAsync(deptId, cancellationToken); // 通過Command更新每個用戶的部門名稱(而不是直接操作數據庫) foreach (var userId in userIds) { var command = new UpdateUserDeptNameCommand(userId, newDeptName); await mediator.Send(command, cancellationToken); } }}這樣設計的好處是 ,
寫操作這邊,還會提供統一的Aspire Dashboard界麵 ,比如在聚合根裏 :
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,寫操作通過倉儲來處理 ,用戶ID是UserId - 聚合根放在