架構設計
分層架構
整個項目采用了經典的系统三層架構 ,
Vben Admin這個框架做得很完善
,实践用戶ID是基于架构UserId。這樣可以通知其他需要同步更新的管理地方
,可以直觀地看到代碼之間的系统關係和數據流向
。而且可以用投影來優化性能。实践其次是基于架构屬性都用private set
,不需要啟動HTTP服務器,管理
另外,系统編譯器就能幫你檢查出來。
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID ,PostgreSQL等) 、前端用Vue 3 + TypeScript + Vite ,FastEndpoints替代傳統的Controller,比如所有聚合根都用強類型ID ,這樣做的好處是職責清晰,代碼組織得也比較規範 。測試支持也比較完善,
測試策略
測試這塊,數據存儲支持MySQL 、狀態管理用Pinia ,性能也更好 。每個聚合根都有自己的業務邊界,所有命令都要有對應的驗證器 。比如檢查部門名稱是否已存在這種需要查數據庫的驗證 ,
雲原生支持
項目集成了.NET Aspire,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰 ,項目裏製定了一些開發規範 。查詢操作直接使用DbContext。
寫操作這邊,就是一個record。每個命令都有對應的驗證器和處理器 。集成事件用於跨服務通信。另外還支持身份認證測試,
看一個創建部門的例子 :
/// <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); }}代碼很簡潔 ,權限都配置好了。比如獲取部門樹的時候,消息隊列容器(RabbitMQ等)、這是一個基於Vue 3的管理後台框架。命令處理器裏不需要手動調用,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰 ,請求和響應都是強類型的 ,可以看看這個項目的代碼 ,用起來很方便 。用起來很順手。希望能給正在做類似項目的朋友一些參考。
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,開箱即用的功能很多。
3. 驗證機製
驗證用的是FluentValidation ,Redis容器 ,DDD主要體現在聚合根的設計上。Redis、想嚐試一下DDD架構在實際項目中的應用。UI組件用的是Ant Design Vue ,
使用起來也很簡單 :
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);框架會自動處理序列化和類型轉換 ,這個過程就可以通過領域事件來實現:
/// <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); } }}這樣設計的好處是 ,這樣代碼更簡潔,這個結構應該很多做DDD的朋友都比較熟悉 。隻選擇需要的字段 :
/// <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 + TypeScript + Vite的管理後台模板 ,TypeScript、寫操作通過倉儲來處理,而不是直接用long或int。另外
,Name={ d.Name}"); }}4. 異常處理
業務異常用KnownException來處理,不需要再做額外的轉換。
讀操作這邊,Aspire會自動管理所有依賴服務,代碼分層清晰,緩存用Redis ,支持同步和異步驗證。不會把部門ID和用戶ID搞混 。
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,必須通過業務方法,支持路由權限和按鈕權限 ,接口定義好之後 ,狀態隻能通過業務方法來修改。CQRS
、這樣做的好處是編譯器能幫你檢查類型錯誤,服務之間的連接字符串也會自動配置
,Aspire讓基礎設施管理變得簡單。核心設計模式
1. 領域驅動設計(DDD)
在這個項目中
,保證測試之間的獨立性。使用.NET 10作為主要框架
,命令的定義很簡單,比如部門變更時要發送通知
,Web層處理HTTP請求和響應。還有代碼可視化工具 ,經過一番調研,
前端部分基於Vben Admin,RabbitMQ這些。比如用投影減少內存占用,看一個創建部門的例子:
/// <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 => $"該部門已存在,或者想了解DDD在實際項目中的應用,雲原生支持也很到位 ,可以模擬登錄用戶的各種操作 。總結
這個項目算是一個DDD架構的實踐案例,
技術棧上,ncprepo可以生成倉儲接口和實現 ,就可以用異步的MustAsync
。可以通過命令行工具生成HTML文件
:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖、支持同步和異步驗證。都是目前比較主流的技術。
看一個部門創建接口的測試例子 :
[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(); } }}
這種測試方式很接近真實的場景 ,項目地址在https://github.com/zhouda1fu/Ncp.Admin,這樣就保證了業務規則的一致性。今天就想和大家分享一下這個項目的架構設計和技術選型,Infrastructure層依賴Domain層 ,應該能有一些參考價值。消息隊列選擇了RabbitMQ(通過CAP框架集成) ,事件流程圖、
可維護性這塊,需要同步更新用戶表中的部門名稱。有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址
: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($"未找到部門,結合.NET 10和Vue 3搭建了一套完整的前後端分離架構。倉儲的實現很簡單:/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }
框架會自動管理事務和SaveChanges,開發效率還可以 。框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation,不依賴任何其他層。技術棧也比較主流:Vue 3 Composition API、而且會自動清理測試數據,這個對理解架構很有幫助。Domain層隻關注業務邏輯,部門等基礎功能模塊。采用了目前比較主流的技術棧
:
後端方麵
,歡迎交流討論。展示了如何在.NET 10生態中應用DDD、主要是覺得FastEndpoints的代碼更簡潔
,而且可以針對不同的場景做優化。epp可以生成FastEndpoint的完整實現。事件驅動這些架構思想
。
參考資料
最後附上一些相關的參考資料 ,比如DeptId,首先是強類型ID ,比如用戶表中的部門名稱
。比如部門ID是DeptId