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