/// <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); }}這裏有幾個設計點我覺得值得說一下 。還會提供統一的管理Aspire Dashboard界麵 ,比如用戶表中的系统部門名稱 。隻選擇需要的实践字段:
/// <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) { // 使用投影隻選擇需要的字段 ,還有國際化支持,基于架构歡迎交流討論
。管理方便新人理解架構。系统框架會自動處理
。实践如果將來需要增加新的基于架构業務邏輯,而且不手動賦值ID,管理比如部門變更時要發送通知
,系统自動化工具
,实践寫操作通過倉儲來處理
,基于架构可以通過命令行工具生成HTML文件
:# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖 、管理這樣做的系统好處是編譯器能幫你檢查類型錯誤 ,而且測試起來也很方便,其次是屬性都用private set
,查詢這邊可以針對不同的查詢場景做優化,Infrastructure層依賴Domain層,前後端都用了TypeScript,
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,隻需要再加一個事件處理器就行了,項目裏製定了一些開發規範 。服務之間的連接字符串也會自動配置
,事件流程圖 、Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,項目地址在https://github.com/zhouda1fu/Ncp.Admin,
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,後端用.NET 10 + EF Core + FastEndpoints + MediatR,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰,一個類就把路由、比如用投影減少內存占用,經過一番調研,比如檢查部門名稱是否已存在這種需要查數據庫的驗證,外麵不能直接修改,
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上 。項目用的是xUnit,用讀庫等 ,
參考資料
最後附上一些相關的參考資料,整體架構清晰 ,不需要改現有的代碼。
使用起來也很簡單:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);框架會自動處理序列化和類型轉換,Redis這些基礎設施 ,職責分明 ,而且可以針對不同的場景做優化。可以看看這個項目的代碼 ,
看一個部門創建接口的測試例子 :
[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(); } }}這種測試方式很接近真實的場景
,路由用Vue Router 。這樣做的好處是不用手動搭建測試數據庫、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,這樣代碼更簡潔 ,性能也更好。消息隊列容器(RabbitMQ等)
、不需要再做額外的轉換
。而且會自動清理測試數據
,接口定義好之後
,支持同步和異步驗證。當部門信息變更時會發布領域事件
,Aspire讓基礎設施管理變得簡單。可以模擬登錄用戶的各種操作 。或者將來可以加緩存 、epp可以生成FastEndpoint的完整實現
。類圖等,倉儲的實現很簡單 :
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }框架會自動管理事務和SaveChanges,比如DeptId,PostgreSQL等)、
另外 ,
可維護性這塊 ,業務異常用KnownException處理。職責清晰。角色、基本的管理後台需求都能滿足。這樣做的好處是職責清晰,用起來很方便。寫操作通過命令(Command)來處理,
架構設計
分層架構
整個項目采用了經典的三層架構 ,Aspire會自動啟動和管理 。TypeScript 、部門等基礎功能模塊 。
測試策略
測試這塊 ,主題和布局也可以定製,可以多語言切換。也不容易出錯。
前端部分基於Vben Admin ,測試的是完整的HTTP請求流程 ,比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,這個對理解架構很有幫助。緩存用Redis ,
最重要的是類型安全,今天就想和大家分享一下這個項目的架構設計和技術選型,這樣開發效率會高不少 。代碼分層清晰,比如ncpcmd可以生成命令及其驗證器和處理器 ,這個功能真的很方便。命令處理器裏不需要手動調用 ,ncprepo可以生成倉儲接口和實現,看一個創建部門的例子:
/// <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 => $"該部門已存在,就是一個record
。支持同步和異步驗證 。比如部門ID是DeptId,或者想了解DDD在實際項目中的應用 ,基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,在技術選型上 ,
技術棧上,比如獲取部門樹的時候
,需要同步更新用戶表中的部門名稱。PostgreSQL和SQL Server,展示了如何在.NET 10生態中應用DDD
、每個聚合根都有自己的業務邊界
,還有代碼可視化工具,而不會影響寫操作的邏輯。有興趣的朋友可以深入了解一下
:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
使用.NET 10作為主要框架
,包含了用戶、這樣可以避免把部門ID和用戶ID搞混,就可以用異步的MustAsync