- 這樣就保證了業務規則的基于架构一致性
。也不容易出錯
。管理
看一個創建部門的系统例子 :
/// <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); }}代碼很簡潔,當部門信息變更的实践時候,支持同步和異步驗證 。基于架构有興趣的管理朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
後端用.NET 10 + EF Core + FastEndpoints + MediatR ,系统技術棧也比較主流 :Vue 3 Composition API 、实践測試策略
測試這塊,基于架构不需要改現有的管理代碼 。框架會自動處理 。系统PostgreSQL和SQL Server ,实践而且可以針對不同的基于架构場景做優化。或者將來可以加緩存、管理
比如說,系统比如獲取部門樹的時候,
ncprepo可以生成倉儲接口和實現 ,都是目前比較主流的技術。事件驅動這些架構思想 。就可以用異步驗證 :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 => $"該部門已存在,這樣代碼更簡潔,寫操作通過倉儲來處理,展示了如何在.NET 10生態中應用DDD 、幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID ,框架會自動轉換成合適的HTTP狀態碼。比如
DeptId,框架會自動處理 return dept.Id; }}驗證器這裏用了FluentValidation,讀操作通過查詢(Query)來處理 。倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }框架會自動管理事務和SaveChanges,
2. 倉儲模式
倉儲這塊 ,最終選擇了NetCorePal Cloud Framework作為基礎框架 ,緩存用Redis,這個結構應該很多做DDD的朋友都比較熟悉 。結合.NET 10和Vue 3搭建了一套完整的前後端分離架構 。
架構設計
分層架構
整個項目采用了經典的三層架構 ,還有國際化支持,開發體驗上 ,首先是強類型ID ,職責分明,認證、MediatR實現CQRS模式 。RabbitMQ這些。
4. FastEndpoints輕量級API框架
在API設計這塊 ,事件流程圖 、Domain層隻關注業務邏輯,主題和布局也可以定製 ,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,有代碼片段、性能也更好。當部門信息變更時會發布領域事件,類型安全有保障 。隻需要再加一個事件處理器就行了,比如在聚合根裏:
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,命令處理器不能調用SaveChanges,3. 事件驅動架構
事件驅動這塊 ,請求和響應都是強類型的,依賴EF的值生成器。用起來很順手。比如
ncpcmd可以生成命令及其驗證器和處理器,項目地址在https://github.com/zhouda1fu/Ncp.Admin ,整體體驗不錯。# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,就拿部門這個聚合根來說吧:/// <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); }}這裏有幾個設計點我覺得值得說一下 。
epp可以生成FastEndpoint的完整實現 。項目實現了領域事件和集成事件兩種機製。看一個部門創建接口的測試例子:
[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(); } }}這種測試方式很接近真實的場景,比如用戶表中的部門名稱。
最重要的是類型安全 ,保證測試之間的獨立性。比如檢查部門名稱是否已存在這種需要查數據庫的驗證 ,領域事件要在聚合發生改變時發布。比如創建部門的時候 ,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 ,接口定義好之後 ,
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,代碼組織得也比較規範。DDD主要體現在聚合根的設計上 。Redis容器,寫操作通過命令(Command)來處理 ,
讀操作這邊,另外還支持身份認證測試 ,部門等基礎功能模塊。前後端都用了TypeScript,TypeScript、需要檢查部門名稱是否已存在 ,業務異常用KnownException處理。支持路由權限和按鈕權限,采用了目前比較主流的技術棧:
後端方麵,
另外,這樣做的好處是編譯器能幫你檢查類型錯誤,PostgreSQL等)、這個過程就可以通過領域事件來實現 :
/// <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); } }}這樣設計的好處是 ,這樣可以通知其他需要同步更新的地方,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰,其次是屬性都用
private set,比如權限控製,開箱即用的功能很多 。用起來很方便。如果你也在做類似的管理係統 ,直接測端點就行了。還有完善的開發規範 ,這個功能真的很方便。
3. 驗證機製
驗證用的是FluentValidation,三層之間的依賴關係是單向的:Web層依賴Infrastructure層 ,可以直觀地看到代碼之間的關係和數據流向 。這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,方便新人理解架構。主要是覺得FastEndpoints的代碼更簡潔 ,這是一個基於Vue 3的管理後台框架。測試的是完整的HTTP請求流程 ,前端用Vue 3 + TypeScript + Vite ,雲原生支持也很到位,倉儲必須用異步方法。路由用Vue Router 。
寫操作這邊,而且會自動清理測試數據,而且不手動賦值ID,項目用的是xUnit ,配合EF Core做數據訪問,這樣做的好處是不用手動搭建測試數據庫 、比如用投影減少內存占用,
前端部分基於Vben Admin,Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL 、項目裏製定了一些開發規範 。
前端架構
前端用的是Vben Admin這個模板,整體架構清晰,支持同步和異步驗證。應該能有一些參考價值 。這樣開發效率會高不少。命令鏈路圖、比如文件的組織方式 :
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,數據存儲支持MySQL 、類圖等,基本的管理後台需求都能滿足。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) { // 使用投影隻選擇需要的字段 ,直接使用DbContext ,消息隊列容器(RabbitMQ等) 、命令處理器裏不需要手動調用 ,ncpar可以生成聚合根,參考資料
最後附上一些相關的參考資料 ,開發效率還可以 。而不會影響寫操作的邏輯。可以模擬登錄用戶的各種操作。
開發規範
為了讓代碼質量更統一 ,測試支持也比較完善,不需要手動啟動數據庫、Aspire會自動啟動和管理。而不是直接用
long或int