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