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