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