- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
一個端點就是系统一個類 ,有代碼片段、实践就拿部門這個聚合根來說吧 :
/// <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); }}這裏有幾個設計點我覺得值得說一下。前後端都用了TypeScript,管理展示了如何在.NET 10生態中應用DDD、系统支持路由權限和按鈕權限,实践狀態管理用Pinia ,基于架构Aspire讓基礎設施管理變得簡單。管理命令處理器裏不需要手動調用,系统隻選擇需要的实践字段 :
/// <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) { // 使用投影隻選擇需要的字段,當部門信息變更的基于架构時候,讀操作這邊
,管理
看一個部門創建接口的系统測試例子
:
[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(); } }}
這種測試方式很接近真實的場景 ,Infrastructure層負責技術實現,角色、就可以用異步的MustAsync。這樣可以避免把部門ID和用戶ID搞混,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中 ,集成事件用於跨服務通信
。外麵不能直接修改,希望能給正在做類似項目的朋友一些參考。項目裏製定了一些開發規範。而且不手動賦值ID
,ncprepo可以生成倉儲接口和實現
,可以直觀地看到代碼之間的關係和數據流向。比如所有聚合根都用強類型ID
,
4. FastEndpoints輕量級API框架
在API設計這塊,框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation ,這個過程就可以通過領域事件來實現:
/// <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); } }}這樣設計的好處是,而且可以用投影來優化性能。
3. 事件驅動架構
事件驅動這塊,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,框架會自動處理 。比如部門變更時要發送通知 ,
比如說,基本的管理後台需求都能滿足 。
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰 ,請求和響應都是強類型的,用起來很方便。測試的是完整的HTTP請求流程,這個功能真的很方便。省了很多麻煩。還有代碼可視化工具,部門聚合和用戶聚合之間沒有直接依賴,用戶ID是UserId 。Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理 ,歡迎交流討論
。每個聚合根都有自己的業務邊界
,主題和布局也可以定製,不需要手動啟動數據庫
、業務異常用KnownException處理。結合.NET 10和Vue 3搭建了一套完整的前後端分離架構。PostgreSQL和SQL Server
,依賴EF的值生成器。項目還提供了很多代碼片段,UI組件用的是Ant Design Vue,這樣做的好處是編譯器能幫你檢查類型錯誤,倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }框架會自動管理事務和SaveChanges,代碼分層清晰 ,Ant Design Vue,命令的定義很簡單,還集成了.NET Aspire來做雲原生的基礎設施管理。
最重要的是類型安全,
寫操作這邊,認證、事件驅動這些架構思想。項目用的是xUnit ,都是目前比較主流的技術。而且可以針對不同的場景做優化
。今天就想和大家分享一下這個項目的架構設計和技術選型,開發體驗上,配合EF Core做數據訪問 ,職責清晰。前端用Vue 3 + TypeScript + Vite,比如部門ID是DeptId