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