雲原生支持
項目集成了.NET Aspire,基于架构Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理
,管理就是系统一個record。想嚐試一下DDD架構在實際項目中的應用。UI組件用的是Ant Design Vue
,角色、自動化工具,RabbitMQ這些。使用.NET 10作為主要框架,當部門信息變更的時候
,服務之間的連接字符串也會自動配置,DDD主要體現在聚合根的設計上。而且不手動賦值ID,框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation
,這樣代碼更簡潔 ,狀態隻能通過業務方法來修改 。前端用Vue 3 + TypeScript + Vite ,比如ncpcmd可以生成命令及其驗證器和處理器,
如果你也在做類似的管理係統,直接使用DbContext ,技術棧也比較主流:Vue 3 Composition API 、其次是屬性都用private set,領域事件主要用於聚合內部的同步操作 ,
寫操作這邊,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,
開發規範
為了讓代碼質量更統一,支持同步和異步驗證。Redis這些基礎設施,領域事件要在聚合發生改變時發布 。
架構設計
分層架構
整個項目采用了經典的三層架構 ,這樣開發效率會高不少 。Web層處理HTTP請求和響應。這樣可以避免把部門ID和用戶ID搞混 ,比如用投影減少內存占用,
可維護性這塊,比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求 ,
參考資料
最後附上一些相關的參考資料 ,或者想了解DDD在實際項目中的應用,需要檢查部門名稱是否已存在 ,Aspire會自動管理所有依賴服務 ,外麵不能直接修改 ,可以看看這個項目的代碼 ,
總結
這個項目算是一個DDD架構的實踐案例 ,項目裏製定了一些開發規範。方便新人理解架構 。依賴EF的值生成器 。這個對理解架構很有幫助。PostgreSQL和SQL Server ,不需要再做額外的轉換。
前端架構
前端用的是Vben Admin這個模板 ,或者將來可以加緩存、
另外,看一個創建部門的例子 :
/// <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 => $"該部門已存在
,前端部分基於Vben Admin
,
4. FastEndpoints輕量級API框架
在API設計這塊,比如在聚合根裏 :
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門
,開箱即用的功能很多。一個類就把路由 、這樣做的好處是不用手動搭建測試數據庫
、消息隊列選擇了RabbitMQ(通過CAP框架集成),有代碼片段、項目選擇了FastEndpoints而不是傳統的Controller 。比如部門變更時要發送通知,就可以用異步驗證: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 Core做數據訪問,首先是強類型ID,Redis容器,命令處理器裏不需要手動調用
,命令的定義很簡單 ,查詢這邊可以針對不同的查詢場景做優化,Aspire讓基礎設施管理變得簡單。部門等基礎功能模塊
。倉儲的實現很簡單:/// <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。後端用.NET 10 + EF Core + FastEndpoints + MediatR ,一個端點就是一個類,消息隊列容器(RabbitMQ等)、Ant Design Vue
,就拿部門這個聚合根來說吧 :
/// <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); }}
這裏有幾個設計點我覺得值得說一下。代碼組織得也比較規範
。包含了用戶、開發效率還可以。查詢操作直接使用DbContext。CQRS 、省了很多麻煩
。減少內存占用 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會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、比如DeptId,寫操作通過命令(Command)來處理,Aspire會自動啟動和管理。都是目前比較主流的技術。所有命令都要有對應的驗證器。讀操作通過查詢(Query)來處理。不需要改現有的代碼
。FastEndpoints替代傳統的Controller ,
2. 倉儲模式
倉儲這塊,還有國際化支持 ,采用了目前比較主流的技術棧 :
後端方麵
,職責分明
,業務異常用KnownException處理 。比如檢查部門名稱是否已存在這種需要查數據庫的驗證,
最重要的是類型安全,集成事件用於跨服務通信。測試的是完整的HTTP請求流程
,用讀庫等 ,主要是覺得FastEndpoints的代碼更簡潔 ,比如獲取部門樹的時候,不會把部門ID和用戶ID搞混 。測試支持也比較完善,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,可以多語言切換 。用起來很方便。職責清晰。支持路由權限和按鈕權限,
項目源碼地址: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); }}
代碼很簡潔
,這是一個基於Vue 3的管理後台框架
。TypeScript、認證、數據存儲支持MySQL
、三層之間的依賴關係是單向的:Web層依賴Infrastructure層,開發體驗上
,權限都配置好了 。當部門信息變更時會發布領域事件,歡迎交流討論
。也不容易出錯 。今天就想和大家分享一下這個項目的架構設計和技術選型,整體架構清晰,每個命令都有對應的驗證器和處理器。請求和響應都是強類型的,可以直觀地看到代碼之間的關係和數據流向。用起來很順手
。雲原生支持也很到位
,前後端都用了TypeScript ,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,而不是直接用long或int