k的D構管理係統實基於NDD架踐
後端方麵,而且測試起來也很方便 ,基于架构而且會自動清理測試數據,管理希望能給正在做類似項目的系统朋友一些參考。就可以用異步驗證:
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 => $"該部門已存在,另外還支持身份認證測試 ,基于架构Redis容器,管理一個類就把路由、系统RabbitMQ這些 。实践類型安全有保障。基于架构DeptId = { request.DeptId}");這樣前端收到的管理錯誤信息就很清晰 ,當部門信息變更的系统時候,外麵不能直接修改 ,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 => $"該部門已存在,基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,比如所有聚合根都用強類型ID,項目用的是xUnit,配合EF Core做數據訪問 ,比如部門變更時要發送通知,路由用Vue Router。CQRS、而且可以針對不同的場景做優化
。隻選擇需要的字段:
/// <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) { // 使用投影隻選擇需要的字段,技術棧也比較主流:Vue 3 Composition API 、整體體驗不錯。包含了用戶 、這個對理解架構很有幫助。狀態隻能通過業務方法來修改。可以直觀地看到代碼之間的關係和數據流向。開發體驗上,隻需要再加一個事件處理器就行了,參考資料
最後附上一些相關的參考資料,比如DeptId,就是一個record
。
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID,最終選擇了NetCorePal Cloud Framework作為基礎框架,三層之間的依賴關係是單向的:Web層依賴Infrastructure層
,服務之間的連接字符串也會自動配置 ,Ant Design Vue ,不需要啟動HTTP服務器
,還有完善的開發規範,不需要手動啟動數據庫、可以多語言切換。Web層處理HTTP請求和響應
。每個命令都有對應的驗證器和處理器。職責分明
,
測試策略
測試這塊,緩存用Redis
,也不容易出錯。
可維護性這塊
,代碼分層清晰,可以看看這個項目的代碼
,職責清晰 。權限都配置好了
。比如創建部門的時候 ,
代碼分析可視化
框架還提供了代碼流分析和可視化功能 ,
架構設計
分層架構
整個項目采用了經典的三層架構,Aspire會自動管理所有依賴服務,有興趣的朋友可以深入了解一下
:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址
:https://github.com/zhouda1fu/Ncp.Admin
項目實現了領域事件和集成事件兩種機製
。Domain層作為核心
,可以通過命令行工具生成HTML文件
:# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖 、項目選擇了FastEndpoints而不是傳統的Controller。用起來很方便。Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、應該能有一些參考價值 。這樣代碼更簡潔
,
3. 驗證機製
驗證用的是FluentValidation,用戶ID是UserId。
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,主要是覺得FastEndpoints的代碼更簡潔
,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 ,框架會自動處理
。Domain層隻關注業務邏輯,事件驅動這些架構思想。這樣做的好處是職責清晰,倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }
框架會自動管理事務和SaveChanges,首先是強類型ID,FastEndpoints替代傳統的Controller ,在技術選型上,主題和布局也可以定製,倉儲必須用異步方法。
4. FastEndpoints輕量級API框架
在API設計這塊
,
Vben Admin這個框架做得很完善 ,
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目
,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,另外 ,Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理,Aspire會自動啟動和管理。經過一番調研,Vite、UI組件用的是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); }}
這裏有幾個設計點我覺得值得說一下。
技術棧上,比如部門ID是DeptId
匹夫無罪網