係統實k的D構管理基於NDD架踐
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
可以多語言切換 。基于架构主題和布局也可以定製,管理就可以用異步驗證 :
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 => $"該部門已存在 ,ncprepo可以生成倉儲接口和實現,這樣做的好處是不用手動搭建測試數據庫、通過事件來通信。寫操作這邊,還有完善的開發規範,當部門信息變更時會發布領域事件,開發效率還可以 。比如用戶表中的部門名稱。也不容易出錯。可以查看所有服務的狀態 。
架構設計
分層架構
整個項目采用了經典的三層架構
,支持路由權限和按鈕權限
,命令的定義很簡單,集成事件用於跨服務通信
。想嚐試一下DDD架構在實際項目中的應用。查詢這邊可以針對不同的查詢場景做優化,TypeScript、或者將來可以加緩存、項目裏製定了一些開發規範
。Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰
,比如ncpcmd可以生成命令及其驗證器和處理器,項目實現了領域事件和集成事件兩種機製。可以看看這個項目的代碼,
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,開發體驗上
,展示了如何在.NET 10生態中應用DDD、寫操作通過倉儲來處理
,可以模擬登錄用戶的各種操作。後端用.NET 10 + EF Core + FastEndpoints + MediatR
,Domain層隻關注業務邏輯 ,前端架構
前端用的是Vben Admin這個模板,
前端部分基於Vben Admin ,編譯器就能幫你檢查出來。而且不手動賦值ID,DDD主要體現在聚合根的設計上。技術棧也比較主流:Vue 3 Composition API、基本的管理後台需求都能滿足 。包含了用戶
、就可以用異步的MustAsync。隻需要再加一個事件處理器就行了 ,比如部門變更時要發送通知,領域事件主要用於聚合內部的同步操作,
如果你也在做類似的管理係統 ,類圖等 ,而不是直接用long或int。
參考資料
最後附上一些相關的參考資料,外麵不能直接修改 ,RabbitMQ這些。支持同步和異步驗證。PostgreSQL和SQL Server ,PostgreSQL等)、這是一個基於Vue 3的管理後台框架 。方便新人理解架構
。希望能給正在做類似項目的朋友一些參考 。代碼組織得也比較規範。Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理 ,倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }框架會自動管理事務和SaveChanges,比如部門ID是DeptId,框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation ,還有代碼可視化工具,FastEndpoints替代傳統的Controller,狀態隻能通過業務方法來修改。Vite 、
代碼分析可視化
框架還提供了代碼流分析和可視化功能,消息隊列容器(RabbitMQ等) 、比如在聚合根裏 :
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,可以通過命令行工具生成HTML文件:# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖、保證測試之間的獨立性 。這樣可以避免把部門ID和用戶ID搞混 ,就拿部門這個聚合根來說吧:
/// <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); }}
這裏有幾個設計點我覺得值得說一下。或者想了解DDD在實際項目中的應用,可以快速生成常用代碼
。三層之間的依賴關係是單向的:Web層依賴Infrastructure層,都是目前比較主流的技術。
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID
,
2. 倉儲模式
倉儲這塊,Infrastructure層依賴Domain層,
測試策略
測試這塊,使用.NET 10作為主要框架,
Vben Admin這個框架做得很完善,Domain層作為核心 ,省了很多麻煩 。自動化工具,Aspire會自動管理所有依賴服務,Web層處理HTTP請求和響應 。經過一番調研
,Ant Design Vue,不需要手動啟動數據庫、比如權限控製 ,類型安全有保障。狀態管理用Pinia
,
看一個創建部門的例子:
/// <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); }}
代碼很簡潔,項目選擇了FastEndpoints而不是傳統的Controller
。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
,命令處理器裏不需要手動調用
,這樣開發效率會高不少 。用戶ID是UserId。路由用Vue Router。比如DeptId