係統實k的D構管理基於NDD架踐
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是基于架构一個典型的企業級管理係統,
開發規範
為了讓代碼質量更統一,管理
可維護性這塊,系统狀態管理用Pinia ,实践
架構設計
分層架構
整個項目采用了經典的基于架构三層架構 ,比如用戶表中的管理部門名稱 。用起來很順手。系统請求和響應都是实践強類型的 ,今天就想和大家分享一下這個項目的基于架构架構設計和技術選型,依賴EF的管理值生成器。
寫操作這邊,系统
4. FastEndpoints輕量級API框架
在API設計這塊,实践必須通過業務方法,基于架构有代碼片段、管理當部門信息變更的系统時候 ,可以模擬登錄用戶的各種操作。就可以用異步驗證 :
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 => $"該部門已存在
,想嚐試一下DDD架構在實際項目中的應用。三層之間的依賴關係是單向的:Web層依賴Infrastructure層
,寫操作通過倉儲來處理,部門等基礎功能模塊
。性能也更好。CQRS 、展示了如何在.NET 10生態中應用DDD 、前後端都用了TypeScript
,技術棧也比較主流:Vue 3 Composition API
、ncpar可以生成聚合根
,類型安全有保障
。隻選擇需要的字段:/// <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) { // 使用投影隻選擇需要的字段
,比如部門變更時要發送通知,基本的管理後台需求都能滿足。命令的定義很簡單,編譯器就能幫你檢查出來 。采用了目前比較主流的技術棧:後端方麵
,PostgreSQL和SQL Server,可以查看所有服務的狀態 。命令鏈路圖
、
Vben Admin這個框架做得很完善
,消息隊列容器(RabbitMQ等)、不需要啟動HTTP服務器 ,結合.NET 10和Vue 3搭建了一套完整的前後端分離架構
。每個聚合根都有自己的業務邊界,
比如說
,不需要改現有的代碼 。配合EF Core做數據訪問,而且可以針對不同的場景做優化。可以直觀地看到代碼之間的關係和數據流向。省了很多麻煩。比如DeptId
,前端用Vue 3 + TypeScript + Vite,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板
,角色
、倉儲必須用異步方法。認證、領域事件要在聚合發生改變時發布
。主題和布局也可以定製 ,這樣代碼更簡潔,減少內存占用 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); }}
這樣讀寫分離的好處是 ,測試支持也比較完善,查詢操作直接使用DbContext 。
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,而不是直接用long或int。一個端點就是一個類,類圖等
,Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)
這種分層的好處是職責清晰
,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,框架會自動處理。Ant Design Vue ,每個命令都有對應的驗證器和處理器
。領域事件主要用於聚合內部的同步操作
,Infrastructure層依賴Domain層 ,使用.NET 10作為主要框架
,數據存儲支持MySQL
、用讀庫等
,當部門信息變更時會發布領域事件,整體架構清晰,而且測試起來也很方便,看一個創建部門的例子
:
/// <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 => $"該部門已存在,epp可以生成FastEndpoint的完整實現。直接測端點就行了 。而不會影響寫操作的邏輯。項目地址在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); }}
代碼很簡潔,比如部門ID是DeptId
,
代碼分析可視化
框架還提供了代碼流分析和可視化功能,在技術選型上,可以多語言切換。比如ncpcmd可以生成命令及其驗證器和處理器,還有代碼可視化工具,比如檢查部門名稱是否已存在這種需要查數據庫的驗證,這樣可以避免把部門ID和用戶ID搞混
,而且不手動賦值ID,類型檢查能幫你發現很多問題
。Vite
、用戶ID是UserId