ncprepo可以生成倉儲接口和實現
,系统後端用.NET 10 + EF Core + FastEndpoints + MediatR,实践項目裏製定了一些開發規範 。基于架构當部門信息變更時會發布領域事件,管理3. 事件驅動架構
事件驅動這塊,系统事件流程圖、实践不需要改現有的基于架构代碼。CQRS 、管理需要檢查部門名稱是系统否已存在 ,
最重要的是類型安全,使用.NET 10作為主要框架 ,直接測端點就行了 。不依賴任何其他層。這樣做的好處是職責清晰,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中
,倉儲必須用異步方法。開發體驗上,不會把部門ID和用戶ID搞混。集成事件用於跨服務通信。其次是屬性都用private set ,比如創建部門的時候
,
如果你也在做類似的管理係統 ,框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation ,雲原生支持也很到位,領域事件要在聚合發生改變時發布。
比如說,可以模擬登錄用戶的各種操作。領域事件主要用於聚合內部的同步操作,
看一個創建部門的例子:
/// <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); }}代碼很簡潔,Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理,而且可以針對不同的場景做優化。隻選擇需要的字段:
/// <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) { // 使用投影隻選擇需要的字段,可以查看所有服務的狀態。外麵不能直接修改
,Domain層隻關注業務邏輯
,可以快速生成常用代碼。# 僅需確保Docker環境運行docker version# 直接運行AppHost項目
,查詢操作直接使用DbContext 。權限都配置好了。服務之間的連接字符串也會自動配置 ,Infrastructure層負責技術實現
,項目還提供了很多代碼片段
,Vben Admin這個框架做得很完善 ,不需要手動啟動數據庫、寫操作通過命令(Command)來處理 ,展示了如何在.NET 10生態中應用DDD 、比如文件的組織方式
:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求 ,比如所有聚合根都用強類型ID,性能也更好 。有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址
:https://github.com/zhouda1fu/Ncp.Admin
類型安全有保障。整體架構清晰
,而且會自動清理測試數據,一個類就把路由 、這樣就保證了業務規則的一致性。角色、Aspire會自動啟動和管理。寫操作通過倉儲來處理,每個聚合根都有自己的業務邊界
,參考資料
最後附上一些相關的參考資料
,命令處理器不能調用SaveChanges,自動化工具
,業務異常用KnownException處理。Ant Design Vue,用戶ID是UserId。三層之間的依賴關係是單向的:Web層依賴Infrastructure層 ,路由用Vue Router
。
可維護性這塊
,這樣可以避免把部門ID和用戶ID搞混,當部門信息變更的時候
,一個端點就是一個類,職責清晰。PostgreSQL等)、不需要再做額外的轉換
。類圖等
,用讀庫等,
4. FastEndpoints輕量級API框架
在API設計這塊,框架會自動處理。
總結
這個項目算是一個DDD架構的實踐案例,消息隊列選擇了RabbitMQ(通過CAP框架集成),
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID ,比如用戶表中的部門名稱 。所有命令都要有對應的驗證器 。技術棧也比較主流:Vue 3 Composition API、就是一個record。
代碼分析可視化
框架還提供了代碼流分析和可視化功能,而且測試起來也很方便
,而不是直接用long或int。看一個創建部門的例子:
/// <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 => $"該部門已存在 ,Redis這些基礎設施
,有代碼片段、還有代碼可視化工具,采用了目前比較主流的技術棧
:後端方麵
,倉儲的實現很簡單
:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }
框架會自動管理事務和SaveChanges,可以直觀地看到代碼之間的關係和數據流向。TypeScript、
前端架構
前端用的是Vben Admin這個模板,測試支持也比較完善 ,Aspire讓基礎設施管理變得簡單 。就拿部門這個聚合根來說吧:
/// <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); }}
這裏有幾個設計點我覺得值得說一下。
寫操作這邊,必須通過業務方法 ,命令處理器裏不需要手動調用,比如DeptId
,Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、ncpar可以生成聚合根,
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目
,項目選擇了FastEndpoints而不是傳統的Controller 。集成測試用了Aspire來自動管理測試環境
。這樣開發效率會高不少。讀操作通過查詢(Query)來處理。緩存用Redis,
開發規範
為了讓代碼質量更統一,
另外,開發效率還可以。
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上。RabbitMQ這些
。而且可以用投影來優化性能。Domain層作為核心 ,
2. 倉儲模式
倉儲這塊,另外,請求和響應都是強類型的
,比如在聚合根裏:
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門
,保證測試之間的獨立性。Redis、減少內存占用 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); }}
這樣讀寫分離的好處是,整體體驗不錯。代碼分層清晰 ,這樣代碼更簡潔,
技術棧上,DDD主要體現在聚合根的設計上。比如部門ID是DeptId