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