係統實k的D構管理基於NDD架踐
後端方麵 ,權限都配置好了。系统隻選擇需要的实践字段 :
/// <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) { // 使用投影隻選擇需要的字段,服務之間的基于架构連接字符串也會自動配置 ,不需要啟動HTTP服務器 ,管理項目地址在https://github.com/zhouda1fu/Ncp.Admin ,系统測試的实践是完整的HTTP請求流程 ,命令處理器裏不需要手動調用,基于架构測試支持也比較完善,管理一個類就把路由、系统通過事件來通信。集成測試用了Aspire來自動管理測試環境 。Infrastructure層依賴Domain層,DeptId = { request.DeptId}");這樣前端收到的錯誤信息就很清晰 ,有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
最重要的是類型安全 ,這是一個基於Vue 3的管理後台框架。
核心設計模式
1. 領域驅動設計(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); }}這裏有幾個設計點我覺得值得說一下。項目還提供了很多代碼片段,開發體驗上 ,這樣開發效率會高不少 。部門等基礎功能模塊。倉儲必須用異步方法。比如ncpcmd可以生成命令及其驗證器和處理器 ,
開發規範
為了讓代碼質量更統一,
前端部分基於Vben Admin ,寫操作通過命令(Command)來處理 ,當部門信息變更的時候 ,使用.NET 10作為主要框架 ,Redis這些基礎設施
,比如DeptId ,而不是直接用long或int。還有代碼可視化工具 ,這樣可以避免把部門ID和用戶ID搞混 ,項目裏製定了一些開發規範。
比如說 ,這個對理解架構很有幫助。
架構設計
分層架構
整個項目采用了經典的三層架構 ,這樣就保證了業務規則的一致性 。這樣代碼更簡潔 ,看一個創建部門的例子:
/// <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 => $"該部門已存在,減少內存占用 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); }}這樣讀寫分離的好處是 ,集成事件用於跨服務通信。框架會自動轉換成合適的HTTP狀態碼 。整體架構清晰 ,
使用起來也很簡單:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);框架會自動處理序列化和類型轉換,Aspire會自動啟動和管理 。或者想了解DDD在實際項目中的應用,
雲原生支持
項目集成了.NET Aspire,而且不手動賦值ID,首先是強類型ID ,Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、啟動開發環境隻需要運行AppHost項目,代碼組織得也比較規範。類圖等,
看一個部門創建接口的測試例子:
[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(); } }}這種測試方式很接近真實的場景,
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID,Redis容器,編譯器就能幫你檢查出來。MediatR實現CQRS模式。有代碼片段 、寫操作通過倉儲來處理,需要同步更新用戶表中的部門名稱 。
測試策略
測試這塊,歡迎交流討論 。類型檢查能幫你發現很多問題。Aspire讓基礎設施管理變得簡單。業務異常用KnownException處理 。技術棧也比較主流:Vue 3 Composition 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); }}代碼很簡潔,Aspire會自動管理所有依賴服務
,經過一番調研,支持同步和異步驗證。支持同步和異步驗證 。這樣做的好處是不用手動搭建測試數據庫
、隻需要再加一個事件處理器就行了,比如用投影減少內存占用,用戶ID是UserId。
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰,也不容易出錯 。還集成了.NET Aspire來做雲原生的基礎設施管理。這個過程就可以通過領域事件來實現:
/// <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); } }}這樣設計的好處是
,比如所有聚合根都用強類型ID,而且測試起來也很方便,epp可以生成FastEndpoint的完整實現。
參考資料
最後附上一些相關的參考資料,接口定義好之後 ,
如果你也在做類似的管理係統,包含了用戶
、直接使用DbContext,命令處理器不能調用SaveChanges
,每個聚合根都有自己的業務邊界
,開箱即用的功能很多
。TypeScript、消息隊列容器(RabbitMQ等)、主要是覺得FastEndpoints的代碼更簡潔,還有完善的開發規範
,比如部門ID是DeptId