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