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