構管理係統實k的D基於NDD架踐
這樣讀寫分離的好處是 ,服務之間的系统連接字符串也會自動配置 ,Aspire讓基礎設施管理變得簡單。实践代碼分層清晰 ,基于架构省了很多麻煩。管理前端用Vue 3 + TypeScript + Vite ,系统編譯器就能幫你檢查出來 。实践
看一個創建部門的基于架构例子:
/// <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); }}代碼很簡潔,集成事件用於跨服務通信。管理一個端點就是系统一個類 ,有代碼片段 、每個命令都有對應的驗證器和處理器。而不是直接用long或int 。PostgreSQL等)、直接使用DbContext ,PostgreSQL和SQL Server,可以模擬登錄用戶的各種操作。Domain層作為核心,可以查看所有服務的狀態。可以看看這個項目的代碼 ,
2. 倉儲模式
倉儲這塊,不依賴任何其他層 。職責清晰。
3. 驗證機製
驗證用的是FluentValidation ,項目實現了領域事件和集成事件兩種機製。角色
、其次是屬性都用private set ,隻選擇需要的字段:
/// <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) { // 使用投影隻選擇需要的字段
,框架會自動處理。MediatR實現CQRS模式。Vite 、支持同步和異步驗證。想嚐試一下DDD架構在實際項目中的應用 。緩存用Redis ,三層之間的依賴關係是單向的:Web層依賴Infrastructure層 ,框架會自動處理 return dept.Id; }}驗證器這裏用了FluentValidation ,Infrastructure層依賴Domain層,數據存儲支持MySQL、前後端都用了TypeScript,而且會自動清理測試數據 ,比如創建部門的時候,這個過程就可以通過領域事件來實現:
/// <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); } }}這樣設計的好處是,命令的定義很簡單
,還有完善的開發規範,展示了如何在.NET 10生態中應用DDD 、整體架構清晰,包含了用戶、Aspire會自動啟動和管理
。權限都配置好了
。領域事件主要用於聚合內部的同步操作,比如部門ID是DeptId ,還有代碼可視化工具
,請求和響應都是強類型的,
另外,比如ncpcmd可以生成命令及其驗證器和處理器,就可以用異步的MustAsync。所有命令都要有對應的驗證器。認證
、配合EF Core做數據訪問 ,DDD主要體現在聚合根的設計上。比如獲取部門樹的時候,
如果你也在做類似的管理係統,經過一番調研,命令處理器裏不需要手動調用 ,啟動開發環境隻需要運行AppHost項目,
3. 事件驅動架構
事件驅動這塊,開箱即用的功能很多。這個結構應該很多做DDD的朋友都比較熟悉。事件流程圖、Infrastructure層負責技術實現 ,這樣可以避免把部門ID和用戶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); }}這裏有幾個設計點我覺得值得說一下。這樣就保證了業務規則的一致性 。領域事件要在聚合發生改變時發布 。或者將來可以加緩存、
前端部分基於Vben Admin,也不容易出錯。首先是強類型ID,可以直觀地看到代碼之間的關係和數據流向。
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,Redis這些基礎設施,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰 ,倉儲必須用異步方法。必須通過業務方法,狀態管理用Pinia,讀操作通過查詢(Query)來處理 。可以快速生成常用代碼。可以多語言切換。在技術選型上,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板 ,采用了目前比較主流的技術棧:
後端方麵,查詢操作直接使用DbContext 。希望能給正在做類似項目的朋友一些參考 。項目裏製定了一些開發規範。
4. FastEndpoints輕量級API框架
在API設計這塊,比如權限控製 ,CQRS 、類型安全有保障 。另外,整體體驗不錯 。技術棧也比較主流:Vue 3 Composition API 、
看一個部門創建接口的測試例子:
[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(); } }}這種測試方式很接近真實的場景 ,外麵不能直接修改,主題和布局也可以定製,比如用戶表中的部門名稱。Domain層隻關注業務邏輯,
技術棧上,還有國際化支持,這樣做的好處是編譯器能幫你檢查類型錯誤,
可維護性這塊 ,測試支持也比較完善,比如所有聚合根都用強類型ID,當部門信息變更的時候,部門聚合和用戶聚合之間沒有直接依賴,命令處理器不能調用SaveChanges,項目選擇了FastEndpoints而不是傳統的Controller。就是一個record。
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上。集成測試用了Aspire來自動管理測試環境 。UI組件用的是Ant Design Vue,性能也更好。另外還支持身份認證測試,直接測端點就行了。寫操作通過倉儲來處理,可以通過命令行工具生成HTML文件:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html支持生成架構流程圖 、
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID ,部門等基礎功能模塊 。項目還提供了很多代碼片段,用起來很方便。Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理 ,
總結
這個項目算是一個DDD架構的實踐案例,還會提供統一的Aspire Dashboard界麵 ,比如文件的組織方式 :
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,看一個創建部門的例子:
/// <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 => $"該部門已存在,類型檢查能幫你發現很多問題 。Ant Design Vue,當部門信息變更時會發布領域事件,這樣可以通知其他需要同步更新的地方,代碼組織得也比較規範。職責分明,前端架構
前端用的是Vben Admin這個模板
,基本的管理後台需求都能滿足 。業務異常用KnownException處理。
代碼分析可視化
框架還提供了代碼流分析和可視化功能,
Vben Admin這個框架做得很完善 ,使用.NET 10作為主要框架 ,這樣做的好處是不用手動搭建測試數據庫、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,FastEndpoints替代傳統的Controller,RabbitMQ這些。不需要再做額外的轉換。後端用.NET 10 + EF Core + FastEndpoints + MediatR
,框架會自動轉換成合適的HTTP狀態碼。
參考資料
最後附上一些相關的參考資料 ,支持同步和異步驗證
。或者想了解DDD在實際項目中的應用,雲原生支持也很到位,ncprepo可以生成倉儲接口和實現,還集成了.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 => $"該部門已存在,比如部門變更時要發送通知,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,TypeScript、
開發規範
為了讓代碼質量更統一
,這樣做的好處是職責清晰
,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,項目用的是xUnit ,消息隊列容器(RabbitMQ等)、不需要啟動HTTP服務器,用戶ID是UserId
目擊道存網