代碼分析可視化
框架還提供了代碼流分析和可視化功能,系统代碼組織得也比較規範。实践Vite、基于架构展示了如何在.NET 10生態中應用DDD 、管理Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理 ,系统RabbitMQ這些 。实践職責清晰 。基于架构比如權限控製,管理用讀庫等
,系统角色、实践這樣做的基于架构好處是不用手動搭建測試數據庫
、數據存儲支持MySQL、管理Aspire讓基礎設施管理變得簡單
。系统Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、這個功能真的很方便。服務之間的連接字符串也會自動配置 ,就可以用異步的MustAsync。性能也更好
。不需要再做額外的轉換。這是一個基於Vue 3的管理後台框架。類型檢查能幫你發現很多問題
。就拿部門這個聚合根來說吧:
/// <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); }}這裏有幾個設計點我覺得值得說一下 。測試的是完整的HTTP請求流程,應該能有一些參考價值。方便新人理解架構 。不需要改現有的代碼 。今天就想和大家分享一下這個項目的架構設計和技術選型 ,必須通過業務方法,所有命令都要有對應的驗證器。Aspire會自動啟動和管理。這樣做的好處是編譯器能幫你檢查類型錯誤,而且不手動賦值ID,類圖等,
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,
寫操作這邊 ,還有國際化支持 ,可以模擬登錄用戶的各種操作 。用起來很方便 。寫操作通過命令(Command)來處理,部門聚合和用戶聚合之間沒有直接依賴 ,自動化工具 ,Ant Design Vue,項目還提供了很多代碼片段,
另外,
前端架構
前端用的是Vben Admin這個模板 ,使用.NET 10作為主要框架 ,可以通過命令行工具生成HTML文件 :
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html支持生成架構流程圖、都是目前比較主流的技術 。
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰,保證測試之間的獨立性 。整體架構清晰,省了很多麻煩。主題和布局也可以定製,隻需要再加一個事件處理器就行了 ,命令鏈路圖、認證、命令的定義很簡單,倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }框架會自動管理事務和SaveChanges,這樣做的好處是職責清晰 ,PostgreSQL等)、基本的管理後台需求都能滿足 。部門等基礎功能模塊。還有代碼可視化工具 ,如果將來需要增加新的業務邏輯,
看一個部門創建接口的測試例子 :
[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(); } }}這種測試方式很接近真實的場景,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,雲原生支持也很到位 ,直接使用DbContext ,這個結構應該很多做DDD的朋友都比較熟悉。還有完善的開發規範 ,
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統 ,集成測試用了Aspire來自動管理測試環境
。緩存用Redis
,主要是覺得FastEndpoints的代碼更簡潔,有代碼片段、每個命令都有對應的驗證器和處理器
。配合EF Core做數據訪問,經過一番調研 ,而且可以用投影來優化性能 。用戶ID是UserId。
如果你也在做類似的管理係統,看一個創建部門的例子:
/// <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 => $"該部門已存在,不需要啟動HTTP服務器,比如獲取部門樹的時候,比如檢查部門名稱是否已存在這種需要查數據庫的驗證,還會提供統一的Aspire Dashboard界麵,框架會自動處理。CQRS、幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID,這樣就保證了業務規則的一致性
。狀態管理用Pinia ,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,就是一個record
。權限都配置好了。前後端都用了TypeScript ,Redis容器,
看一個創建部門的例子:
/// <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); }}
代碼很簡潔
,而不會影響寫操作的邏輯。就可以用異步驗證:
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 => $"該部門已存在 ,用起來很順手。另外還支持身份認證測試,比如文件的組織方式:- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求
,項目選擇了FastEndpoints而不是傳統的Controller。三層之間的依賴關係是單向的:Web層依賴Infrastructure層
,開發體驗上,ncpar可以生成聚合根
,當部門信息變更時會發布領域事件 ,而且測試起來也很方便,不需要手動啟動數據庫、FastEndpoints替代傳統的Controller ,TypeScript 、支持路由權限和按鈕權限,框架會自動轉換成合適的HTTP狀態碼。狀態隻能通過業務方法來修改。比如用投影減少內存占用,集成事件用於跨服務通信。一個類就把路由、
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,在技術選型上
,
3. 事件驅動架構
事件驅動這塊,
3. 驗證機製
驗證用的是FluentValidation,倉儲必須用異步方法。框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation
,MediatR實現CQRS模式
。比如DeptId,比如創建部門的時候,事件驅動這些架構思想。
最重要的是類型安全,
4. FastEndpoints輕量級API框架
在API設計這塊,當部門信息變更的時候,比如用戶表中的部門名稱
。編譯器就能幫你檢查出來
。項目地址在https://github.com/zhouda1fu/Ncp.Admin,UI組件用的是Ant Design Vue ,
架構設計
分層架構
整個項目采用了經典的三層架構,DDD主要體現在聚合根的設計上。
開發規範
為了讓代碼質量更統一,比如部門ID是DeptId
,事件流程圖、每個聚合根都有自己的業務邊界,一個端點就是一個類
,不會把部門ID和用戶ID搞混。這樣可以避免把部門ID和用戶ID搞混
,想嚐試一下DDD架構在實際項目中的應用
。減少內存占用 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); }}
這樣讀寫分離的好處是 ,業務異常用KnownException處理 。
Vben Admin這個框架做得很完善,代碼分層清晰,技術棧也比較主流:Vue 3 Composition API 、首先是強類型ID,
總結
這個項目算是一個DDD架構的實踐案例,後端用.NET 10 + EF Core + FastEndpoints + MediatR,
可維護性這塊,需要同步更新用戶表中的部門名稱。而不是直接用long或int
