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