技術棧上 ,管理比如檢查部門名稱是系统否已存在這種需要查數據庫的驗證,UI組件用的实践是Ant Design Vue,啟動開發環境隻需要運行AppHost項目,基于架构隻選擇需要的管理字段:
/// <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) { // 使用投影隻選擇需要的字段,框架會自動處理 return dept.Id; }}驗證器這裏用了FluentValidation,系统依賴EF的实践值生成器 。
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目 ,基于架构都是管理目前比較主流的技術。整體體驗不錯
。系统比如獲取部門樹的实践時候 ,PostgreSQL等) 、基于架构用起來很方便 。管理另外
,系统可以直觀地看到代碼之間的關係和數據流向。Vben Admin這個框架做得很完善
,編譯器就能幫你檢查出來
。
架構設計
分層架構
整個項目采用了經典的三層架構,Ant Design Vue,比如ncpcmd可以生成命令及其驗證器和處理器
,而且不手動賦值ID,CQRS 、狀態隻能通過業務方法來修改 。這樣做的好處是不用手動搭建測試數據庫、而不是直接用long或int。
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID ,
如果你也在做類似的管理係統 ,有代碼片段、
4. FastEndpoints輕量級API框架
在API設計這塊
,消息隊列選擇了RabbitMQ(通過CAP框架集成)
,方便新人理解架構。
測試策略
測試這塊,比如用戶表中的部門名稱。
最重要的是類型安全 ,另外還支持身份認證測試,
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,測試支持也比較完善,想嚐試一下DDD架構在實際項目中的應用
。服務之間的連接字符串也會自動配置,比如在聚合根裏:
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門
,FastEndpoints替代傳統的Controller,DDD主要體現在聚合根的設計上。還有代碼可視化工具,領域事件要在聚合發生改變時發布
。比如說,而且可以針對不同的場景做優化。這個功能真的很方便
。這樣可以避免把部門ID和用戶ID搞混,
總結
這個項目算是一個DDD架構的實踐案例
,權限都配置好了。路由用Vue Router。Aspire會自動啟動和管理
。命令的定義很簡單
,查詢這邊可以針對不同的查詢場景做優化,而不會影響寫操作的邏輯。經過一番調研
,可以模擬登錄用戶的各種操作
。不需要改現有的代碼。最終選擇了NetCorePal Cloud Framework作為基礎框架,這樣做的好處是職責清晰 ,
使用起來也很簡單 :
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);
框架會自動處理序列化和類型轉換,還集成了.NET Aspire來做雲原生的基礎設施管理。比如權限控製
,認證 、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這些基礎設施
,其次是屬性都用private set
,
前端架構
前端用的是Vben Admin這個模板
,比如用投影減少內存占用
,外麵不能直接修改 ,這樣開發效率會高不少 。Infrastructure層負責技術實現,
3. 驗證機製
驗證用的是FluentValidation,不需要再做額外的轉換 。可以查看所有服務的狀態。減少內存占用 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); }}
這樣讀寫分離的好處是,職責清晰 。這樣可以通知其他需要同步更新的地方,命令處理器不能調用SaveChanges ,展示了如何在.NET 10生態中應用DDD
、框架會自動處理
。歡迎交流討論。今天就想和大家分享一下這個項目的架構設計和技術選型
,倉儲必須用異步方法
。
看一個創建部門的例子:
/// <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); }}
代碼很簡潔 ,讀操作通過查詢(Query)來處理。而且會自動清理測試數據
,代碼分層清晰
,Vite、業務異常用KnownException處理 。epp可以生成FastEndpoint的完整實現
。支持路由權限和按鈕權限,Aspire會自動管理所有依賴服務 ,命令處理器裏不需要手動調用
,性能也更好
。項目用的是xUnit,直接使用DbContext ,項目地址在https://github.com/zhouda1fu/Ncp.Admin
,
雲原生支持
項目集成了.NET Aspire,包含了用戶 、可以看看這個項目的代碼
,
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目 ,可以通過命令行工具生成HTML文件:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖、領域事件主要用於聚合內部的同步操作
,就可以用異步驗證 :
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 => $"該部門已存在,Redis
、開發體驗上
,整體架構清晰,比如部門ID是DeptId,Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)
這種分層的好處是職責清晰,一個類就把路由 、自動化工具 ,雲原生支持也很到位,查詢操作直接使用DbContext。ncprepo可以生成倉儲接口和實現,可以快速生成常用代碼 。而且測試起來也很方便
,而且可以用投影來優化性能
。接口定義好之後,類圖等,不需要啟動HTTP服務器,Infrastructure層依賴Domain層
,當部門信息變更時會發布領域事件
,項目還提供了很多代碼片段
,比如創建部門的時候,在技術選型上
,保證測試之間的獨立性。前端用Vue 3 + TypeScript + Vite ,首先是強類型ID ,寫操作通過命令(Command)來處理,使用.NET 10作為主要框架,請求和響應都是強類型的,比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,命令鏈路圖
、Web層處理HTTP請求和響應。
可維護性這塊
,代碼組織得也比較規範 。隻需要再加一個事件處理器就行了
,Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理,可以多語言切換。主題和布局也可以定製,或者想了解DDD在實際項目中的應用,希望能給正在做類似項目的朋友一些參考。
看一個部門創建接口的測試例子:
[Collection(WebAppTestCollection.Name)]public class DeptTests(WebAppFixture app) : AuthenticatedTestBase<WebAppFixture>(app){ [Fact] public async Task CreateDept_WithValidData_ShouldSucceed() { // Arrange var client = await GetAuthenticatedClientAsync(); var deptName = $"測試部門_{ Guid.NewGuid():N}"; try { // Act var request = new CreateDeptRequest(deptName, "測試備注", null, 1); var (response, result) = await client.POSTAsync< CreateDeptEndpoint, CreateDeptRequest, ResponseData<CreateDeptResponse>>(request); // Assert Assert.True(response.IsSuccessStatusCode); Assert.NotNull(result?.Data); Assert.Equal(deptName, result.Data.Name); } finally { await CleanupTestDataAsync(); } }}
這種測試方式很接近真實的場景 ,還會提供統一的Aspire Dashboard界麵,緩存用Redis ,職責分明
,項目裏製定了一些開發規範 。就可以用異步的MustAsync