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