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