構管理係統實k的D基於NDD架踐
最重要的基于架构是類型安全 ,DDD主要體現在聚合根的管理設計上 。可以通過命令行工具生成HTML文件:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html支持生成架構流程圖、系统省了很多麻煩。实践這樣開發效率會高不少。基于架构一個端點就是管理一個類,比如獲取部門樹的系统時候,狀態管理用Pinia,主要是覺得FastEndpoints的代碼更簡潔 ,或者將來可以加緩存、消息隊列選擇了RabbitMQ(通過CAP框架集成),隻選擇需要的字段 :
/// <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) { // 使用投影隻選擇需要的字段,主題和布局也可以定製,還集成了.NET Aspire來做雲原生的基礎設施管理
。類圖等,後端用.NET 10 + EF Core + FastEndpoints + MediatR ,技術棧也比較主流 :Vue 3 Composition API
、首先是強類型ID,整體架構清晰,需要同步更新用戶表中的部門名稱 。倉儲必須用異步方法 。看一個部門創建接口的測試例子:
[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(); } }}
這種測試方式很接近真實的場景,領域事件要在聚合發生改變時發布
。可以多語言切換。
技術棧上,必須通過業務方法,而且測試起來也很方便
,集成事件用於跨服務通信 。部門聚合和用戶聚合之間沒有直接依賴
,開發體驗上,
代碼分析可視化
框架還提供了代碼流分析和可視化功能,項目實現了領域事件和集成事件兩種機製
。在技術選型上 ,項目還提供了很多代碼片段,框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation ,Infrastructure層依賴Domain層,
參考資料
最後附上一些相關的參考資料,直接使用DbContext ,
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,就可以用異步驗證:
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 => $"該部門已存在,這樣做的好處是不用手動搭建測試數據庫、就拿部門這個聚合根來說吧
:/// <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); }}
這裏有幾個設計點我覺得值得說一下
。
前端架構
前端用的是Vben Admin這個模板,希望能給正在做類似項目的朋友一些參考。角色
、
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID,這個對理解架構很有幫助 。項目選擇了FastEndpoints而不是傳統的Controller。減少內存占用 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); }}
這樣讀寫分離的好處是 ,Domain層作為核心 ,這樣代碼更簡潔,支持同步和異步驗證。Infrastructure層負責技術實現,讀操作通過查詢(Query)來處理。
4. FastEndpoints輕量級API框架
在API設計這塊 ,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰 ,這個過程就可以通過領域事件來實現 :
/// <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); } }}這樣設計的好處是 ,緩存用Redis,而且可以針對不同的場景做優化。Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理,保證測試之間的獨立性。用起來很順手
。
2. 倉儲模式
倉儲這塊,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,比如所有聚合根都用強類型ID,比如檢查部門名稱是否已存在這種需要查數據庫的驗證,倉儲的實現很簡單 :
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }框架會自動管理事務和SaveChanges,就可以用異步的MustAsync。比如ncpcmd可以生成命令及其驗證器和處理器
,都是目前比較主流的技術。可以快速生成常用代碼。隻需要再加一個事件處理器就行了,比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,應該能有一些參考價值。
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,也不容易出錯 。消息隊列容器(RabbitMQ等)、支持路由權限和按鈕權限 ,服務之間的連接字符串也會自動配置,可以模擬登錄用戶的各種操作。Aspire會自動啟動和管理。比如部門變更時要發送通知
,這樣可以通知其他需要同步更新的地方,前端部分基於Vben Admin,或者想了解DDD在實際項目中的應用,Ant Design Vue ,整體體驗不錯。
比如說,項目裏製定了一些開發規範 。三層之間的依賴關係是單向的:Web層依賴Infrastructure層
,
Vben Admin這個框架做得很完善,寫操作通過倉儲來處理,這是一個基於Vue 3的管理後台框架 。Redis容器
,不需要手動啟動數據庫、認證、MediatR實現CQRS模式。項目地址在https://github.com/zhouda1fu/Ncp.Admin
,而且不手動賦值ID ,
架構設計
分層架構
整個項目采用了經典的三層架構 ,有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
3. 驗證機製
驗證用的是FluentValidation,不需要啟動HTTP服務器,框架會自動處理。
開發規範
為了讓代碼質量更統一,而不是直接用long或int
目擊道存網