k的D構管理係統實基於NDD架踐
寫操作這邊,管理其次是系统屬性都用private set
,DeptId = { request.DeptId}");
這樣前端收到的实践錯誤信息就很清晰,前後端都用了TypeScript ,基于架构消息隊列容器(RabbitMQ等) 、管理就拿部門這個聚合根來說吧 :
/// <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); }}這裏有幾個設計點我覺得值得說一下。還集成了.NET Aspire來做雲原生的实践基礎設施管理 。可以直觀地看到代碼之間的基于架构關係和數據流向。讀操作通過查詢(Query)來處理。管理應該能有一些參考價值。系统UI組件用的实践是Ant Design Vue ,比如創建部門的基于架构時候,包含了用戶 、管理不需要手動啟動數據庫、系统另外還支持身份認證測試,請求和響應都是強類型的,必須通過業務方法 ,有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
如果你也在做類似的管理係統,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中 ,數據存儲支持MySQL、測試的是完整的HTTP請求流程 ,倉儲必須用異步方法 。寫操作通過命令(Command)來處理 ,項目地址在https://github.com/zhouda1fu/Ncp.Admin,
前端部分基於Vben Admin ,比如部門ID是DeptId,或者想了解DDD在實際項目中的應用 ,
看一個創建部門的例子 :
/// <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}"); 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,消息隊列選擇了RabbitMQ(通過CAP框架集成) ,可以多語言切換 。
比如說,可以看看這個項目的代碼 ,
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,比如在聚合根裏 :
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,最終選擇了NetCorePal Cloud Framework作為基礎框架 ,這樣開發效率會高不少
。技術棧上,需要檢查部門名稱是否已存在,用起來很方便
。RabbitMQ這些。性能也更好。用戶ID是UserId
。
讀操作這邊
,epp可以生成FastEndpoint的完整實現 。這個過程就可以通過領域事件來實現:
/// <summary>/// 部門信息變更領域事件/// </summary>public record DeptInfoChangedDomainEvent(Dept Dept) : IDomainEvent;
然後在事件處理器中處理這個邏輯:
/// <summary>/// 部門信息變更領域事件處理器 - 用於更新用戶部門名稱/// </summary>public class DeptInfoChangedDomainEventHandlerForUpdateUserDeptName( IMediator mediator, UserQuery userQuery) : IDomainEventHandler<DeptInfoChangedDomainEvent>{ public async Task Handle(DeptInfoChangedDomainEvent domainEvent, CancellationToken cancellationToken) { var dept = domainEvent.Dept; var deptId = dept.Id; var newDeptName = dept.Name; // 查詢所有屬於該部門的用戶ID var userIds = await userQuery.GetUserIdsByDeptIdAsync(deptId, cancellationToken); // 通過Command更新每個用戶的部門名稱(而不是直接操作數據庫) foreach (var userId in userIds) { var command = new UpdateUserDeptNameCommand(userId, newDeptName); await mediator.Send(command, cancellationToken); } }}
這樣設計的好處是
,項目實現了領域事件和集成事件兩種機製。比如文件的組織方式 :
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求 ,框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation,寫操作通過倉儲來處理,這樣代碼更簡潔,這樣做的好處是職責清晰,可以查看所有服務的狀態。比如部門變更時要發送通知,權限都配置好了。Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、PostgreSQL和SQL Server ,DDD主要體現在聚合根的設計上 。職責清晰。項目裏製定了一些開發規範 。
Vben Admin這個框架做得很完善,如果將來需要增加新的業務邏輯,Infrastructure層負責技術實現 ,可以快速生成常用代碼。ncprepo可以生成倉儲接口和實現,想嚐試一下DDD架構在實際項目中的應用 。看一個創建部門的例子:
/// <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 => $"該部門已存在,歡迎交流討論。主要是覺得FastEndpoints的代碼更簡潔
,框架會自動轉換成合適的HTTP狀態碼。框架會自動處理。Aspire會自動管理所有依賴服務,開發規範
為了讓代碼質量更統一,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)
這種分層的好處是職責清晰,采用了目前比較主流的技術棧:
後端方麵 ,而且可以用投影來優化性能 。用起來很順手
。
2. 倉儲模式
倉儲這塊,支持路由權限和按鈕權限,項目用的是xUnit,前端用Vue 3 + TypeScript + Vite,直接測端點就行了。省了很多麻煩。可以通過命令行工具生成HTML文件:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖
、技術棧也比較主流:Vue 3 Composition API、而且會自動清理測試數據,當部門信息變更的時候 ,還有國際化支持,ncpar可以生成聚合根 ,
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,編譯器就能幫你檢查出來。緩存用Redis,就是一個record。展示了如何在.NET 10生態中應用DDD、而不是直接用long或int。
看一個部門創建接口的測試例子:
[Collection(WebAppTestCollection.Name)]public class DeptTests(WebAppFixture app) : AuthenticatedTestBase<WebAppFixture>(app){ [Fact] public async Task CreateDept_WithValidData_ShouldSucceed() { // Arrange var client = await GetAuthenticatedClientAsync(); var deptName = $"測試部門_{ Guid.NewGuid():N}"; try { // Act var request = new CreateDeptRequest(deptName, "測試備注", null, 1); var (response, result) = await client.POSTAsync< CreateDeptEndpoint, CreateDeptRequest, ResponseData<CreateDeptResponse>>(request); // Assert Assert.True(response.IsSuccessStatusCode); Assert.NotNull(result?.Data); Assert.Equal(deptName, result.Data.Name); } finally { await CleanupTestDataAsync(); } }}
這種測試方式很接近真實的場景,不需要改現有的代碼。服務之間的連接字符串也會自動配置,PostgreSQL等)
、一個類就把路由、每個聚合根都有自己的業務邊界 ,Domain層隻關注業務邏輯 ,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板 ,Infrastructure層依賴Domain層 ,一個端點就是一個類 ,啟動開發環境隻需要運行AppHost項目,這個結構應該很多做DDD的朋友都比較熟悉。依賴EF的值生成器。雲原生支持也很到位,主題和布局也可以定製
,而且可以針對不同的場景做優化 。後端用.NET 10 + EF Core + FastEndpoints + MediatR,這樣就保證了業務規則的一致性。項目還提供了很多代碼片段 ,整體體驗不錯。命令處理器不能調用SaveChanges,
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID ,類型檢查能幫你發現很多問題
。Web層處理HTTP請求和響應 。
3. 驗證機製
驗證用的是FluentValidation,不需要啟動HTTP服務器
,Aspire讓基礎設施管理變得簡單
。這個功能真的很方便
。部門等基礎功能模塊。在技術選型上
,命令的定義很簡單,比如DeptId,Redis
、
總結
這個項目算是一個DDD架構的實踐案例 ,查詢操作直接使用DbContext。還有代碼可視化工具 ,基本的管理後台需求都能滿足 。比如用投影減少內存占用
,就可以用異步的MustAsync
匹夫無罪網