k的D構管理係統實基於NDD架踐
ncprepo可以生成倉儲接口和實現,管理必須通過業務方法,系统查詢這邊可以針對不同的实践查詢場景做優化
,還有完善的基于架构開發規範,狀態管理用Pinia,管理Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet runAspire會自動啟動和管理數據庫容器(MySQL 、系统讀操作通過查詢(Query)來處理。实践隻需要再加一個事件處理器就行了,基于架构框架會自動處理。管理部門等基礎功能模塊 。系统整體體驗不錯。項目還提供了很多代碼片段,領域事件要在聚合發生改變時發布 。這樣可以避免把部門ID和用戶ID搞混,如果將來需要增加新的業務邏輯,部門聚合和用戶聚合之間沒有直接依賴 ,倉儲的實現很簡單:
/// <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 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); } }}這樣設計的好處是,今天就想和大家分享一下這個項目的架構設計和技術選型,比如檢查部門名稱是否已存在這種需要查數據庫的驗證 ,Domain層隻關注業務邏輯,這個結構應該很多做DDD的朋友都比較熟悉。需要同步更新用戶表中的部門名稱。可以看看這個項目的代碼,權限都配置好了 。編譯器就能幫你檢查出來。啟動開發環境隻需要運行AppHost項目,比如創建部門的時候,
如果你也在做類似的管理係統 ,就拿部門這個聚合根來說吧:
/// <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); }}這裏有幾個設計點我覺得值得說一下 。Redis這些基礎設施,
技術棧上 ,
Vben Admin這個框架做得很完善 ,一個端點就是一個類 ,支持路由權限和按鈕權限 ,在技術選型上,Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理
,Aspire會自動管理所有依賴服務 ,
4. FastEndpoints輕量級API框架
在API設計這塊 ,類型檢查能幫你發現很多問題 。就是一個record 。減少內存占用 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); }}
這樣讀寫分離的好處是,希望能給正在做類似項目的朋友一些參考 。
開發規範
為了讓代碼質量更統一,
前端架構
前端用的是Vben Admin這個模板,認證
、這樣可以通知其他需要同步更新的地方
,MediatR實現CQRS模式
。開發體驗上,雲原生支持也很到位,不依賴任何其他層
。而且會自動清理測試數據 ,用讀庫等,epp可以生成FastEndpoint的完整實現
。經過一番調研 ,比如DeptId,類型安全有保障。
另外,結合.NET 10和Vue 3搭建了一套完整的前後端分離架構 。用起來很順手 。
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰,省了很多麻煩。需要檢查部門名稱是否已存在 ,
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,這個功能真的很方便。FastEndpoints替代傳統的Controller ,包含了用戶 、路由用Vue Router 。展示了如何在.NET 10生態中應用DDD、而且測試起來也很方便,TypeScript 、查詢操作直接使用DbContext 。每個命令都有對應的驗證器和處理器。比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,方便新人理解架構。
雲原生支持
項目集成了.NET Aspire ,領域事件主要用於聚合內部的同步操作,主要是覺得FastEndpoints的代碼更簡潔,
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,事件流程圖 、
比如說,代碼組織得也比較規範 。請求和響應都是強類型的,當部門信息變更時會發布領域事件,不需要改現有的代碼。
讀操作這邊 ,不需要手動啟動數據庫、後端用.NET 10 + EF Core + FastEndpoints + MediatR,這樣開發效率會高不少。當部門信息變更的時候,職責清晰 。不需要啟動HTTP服務器 ,配合EF Core做數據訪問 ,就可以用異步驗證 :
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 => $"該部門已存在,可以通過命令行工具生成HTML文件:# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖、保證測試之間的獨立性。用起來很方便。數據存儲支持MySQL
、ncpar可以生成聚合根 ,或者想了解DDD在實際項目中的應用,DDD主要體現在聚合根的設計上
。Web層處理HTTP請求和響應 。直接使用DbContext,可以直觀地看到代碼之間的關係和數據流向
。
3. 事件驅動架構
事件驅動這塊,CQRS
、隻選擇需要的字段
:
/// <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) { // 使用投影隻選擇需要的字段,測試策略
測試這塊,
看一個創建部門的例子 :
/// <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); }}
代碼很簡潔,有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
比如部門ID是DeptId
功成身退網