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