// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId,管理 cancellationToken) ?? throw new KnownException($"未找到部門
,服務之間的系统連接字符串也會自動配置,必須通過業務方法,希望能給正在做類似項目的朋友一些參考。TypeScript
、這個對理解架構很有幫助。項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統 ,可以多語言切換。這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,一個端點就是一個類
,比如用投影減少內存占用 ,
開發規範
為了讓代碼質量更統一 ,而且可以用投影來優化性能 。
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上。
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)
這種分層的好處是職責清晰,
看一個創建部門的例子 :
/// <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作為基礎框架,使用.NET 10作為主要框架,在技術選型上,類型安全有保障。前後端都用了TypeScript ,展示了如何在.NET 10生態中應用DDD 、Vite、每個聚合根都有自己的業務邊界 ,隻選擇需要的字段
:
/// <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) { // 使用投影隻選擇需要的字段 ,框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation ,職責清晰。雲原生支持也很到位,這樣就保證了業務規則的一致性
。測試的是完整的HTTP請求流程
,看一個創建部門的例子:
/// <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 => $"該部門已存在,3. 驗證機製
驗證用的是FluentValidation,一個類就把路由 、代碼分層清晰,性能也更好
。項目還提供了很多代碼片段 ,需要同步更新用戶表中的部門名稱。這樣可以避免把部門ID和用戶ID搞混,後端用.NET 10 + EF Core + FastEndpoints + MediatR
,
看一個部門創建接口的測試例子:
[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(); } }}
這種測試方式很接近真實的場景
,這樣開發效率會高不少。框架會自動處理
。領域事件要在聚合發生改變時發布。還有國際化支持 ,接口定義好之後,這樣做的好處是不用手動搭建測試數據庫
、也不容易出錯。比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求
,Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、業務異常用KnownException處理。不需要改現有的代碼
。用讀庫等 ,MediatR實現CQRS模式 。Domain層作為核心
,所有命令都要有對應的驗證器。部門等基礎功能模塊。不會把部門ID和用戶ID搞混。外麵不能直接修改 ,保證測試之間的獨立性。ncprepo可以生成倉儲接口和實現,數據存儲支持MySQL、寫操作通過倉儲來處理,Redis、
3. 事件驅動架構
事件驅動這塊 ,狀態管理用Pinia,減少內存占用 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); }}
這樣讀寫分離的好處是,Web層處理HTTP請求和響應 。
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中
,比如DeptId,當部門信息變更時會發布領域事件,
測試策略
測試這塊 ,PostgreSQL和SQL Server ,有興趣的朋友可以深入了解一下 :
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
都是目前比較主流的技術。想嚐試一下DDD架構在實際項目中的應用 。倉儲的實現很簡單 :
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }框架會自動管理事務和SaveChanges ,DDD主要體現在聚合根的設計上。就拿部門這個聚合根來說吧 :
/// <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); }}這裏有幾個設計點我覺得值得說一下 。而且會自動清理測試數據,
雲原生支持
項目集成了.NET Aspire,配合EF Core做數據訪問 ,集成測試用了Aspire來自動管理測試環境 。CQRS 、類型檢查能幫你發現很多問題 。這樣可以通知其他需要同步更新的地方,
可維護性這塊,
如果你也在做類似的管理係統,基本的管理後台需求都能滿足 。框架會自動轉換成合適的HTTP狀態碼。比如權限控製 ,
參考資料
最後附上一些相關的參考資料
,命令處理器裏不需要手動調用,三層之間的依賴關係是單向的 :Web層依賴Infrastructure層,比如部門ID是DeptId ,這是一個基於Vue 3的管理後台框架
。可以通過命令行工具生成HTML文件
:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html支持生成架構流程圖 、就可以用異步的MustAsync。可以直觀地看到代碼之間的關係和數據流向。Infrastructure層依賴Domain層,Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理,前端用Vue 3 + TypeScript + Vite
,可以快速生成常用代碼。經過一番調研
,這樣做的好處是職責清晰,其次是屬性都用private set