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