OnionArch - 採用DDD+CQRS+.Net 7.0實現的洋蔥架構

来源:https://www.cnblogs.com/xiaozhuang/archive/2022/10/09/16772485.html
-Advertisement-
Play Games

外觀模式是最常用的結構型設計模式,也是一種非常容易理解的設計模式,其核心就是為多個子系統提供一個統一的介面,將這個介面看作是這些子系統的門面。 ...


博主最近失業在家,找工作之餘,看了一些關於洋蔥(整潔)架構的資料和項目,有感而發,自己動手寫了個洋蔥架構解決方案,起名叫OnionArch。基於最新的.Net 7.0 RC1, 資料庫採用PostgreSQL, 目前實現了包括多租戶在內的12個特性。

該架構解決方案主要參考了NorthwindTraders sample-dotnet-core-cqrs-api 項目, B站上楊中科的課程代碼以及博主的一些項目經驗。

洋蔥架構的示意圖如下:

 

一、OnionArch 解決方案說明

解決方案截圖如下:

 

可以看到,該解決方案輕量化實現了洋蔥架構,每個層都只用一個項目表示。建議將該解決方案作為單個微服務使用,不建議在領域層包含太多的領域根。

源代碼分為四個項目:

1. OnionArch.Domain

- 核心領域層,類庫項目,其主要職責實現每個領域內的業務邏輯。設計每個領域的實體(Entity),值對象、領域事件和領域服務,在領域服務中封裝業務邏輯,為應用層服務。
- 領域層也包含資料庫倉儲介面,緩存介面、工作單元介面、基礎實體、基礎領域跟實體、數據分頁實體的定義,以及自定義異常等。

2. OnionArch.Infrastructure

- 基礎架構層,類庫項目,其主要職責是實現領域層定義的各種介面適配器(Adapter)。例如資料庫倉儲介面、工作單元介面和緩存介面,以及領域層需要的其它系統集成介面。
- 基礎架構層也包含Entity Framework基礎DbConext、ORM配置的定義和數據遷移記錄。

3. OnionArch.Application

- 應用(業務用例)層,類庫項目,其主要職責是通過調用領域層服務實現業務用例。一個業務用例通過調用一個或多個領域層服務實現。不建議在本層實現業務邏輯。
- 應用(業務用例)層也包含業務用例實體(Model)、Model和Entity的映射關係定義,業務實基礎命令介面和查詢介面的定義(CQRS),包含公共MediatR管道(AOP)處理和公共Handler的處理邏輯。

4. OnionArch.GrpcService

- 界面(API)層,GRPC介面項目,用於實現GRPC介面。通過MediatR特定業務用例實體(Model)消息來調用應用層的業務用例。
- 界面(API)層也包含對領域層介面的實現,例如通過HttpContext獲取當前租戶和賬號登錄信息。

二、OnionArch已實現特性說明

1.支持多租戶(通過租戶欄位)

基於Entity Framework實體過濾器和實現對租戶數據的查詢過濾

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
//載入配置
modelBuilder.ApplyConfigurationsFromAssembly(typeof(TDbContext).Assembly);

//為每個繼承BaseEntity實體增加租戶過濾器
// Set BaseEntity rules to all loaded entity types
foreach (var entityType in GetBaseEntityTypes(modelBuilder))
{
var method = SetGlobalQueryMethod.MakeGenericMethod(entityType);
method.Invoke(this, new object[] { modelBuilder, entityType });
}
}

在BaseDbContext文件的SaveChanges之前對實體租戶欄位賦值

//為每個繼承BaseEntity的實體的Id主鍵和TenantId賦值
var baseEntities = ChangeTracker.Entries<BaseEntity>();
foreach (var entry in baseEntities)
{
switch (entry.State)
{
case EntityState.Added:
if (entry.Entity.Id == Guid.Empty)
entry.Entity.Id = Guid.NewGuid();
if (entry.Entity.TenantId == Guid.Empty)
entry.Entity.TenantId = _currentTenantService.TenantId;
break;
}
}

多租戶支持全部在底層實現,包括租戶欄位的索引配置等。開發人員不用關心多租戶部分的處理邏輯,只關註業務領域邏輯也業務用例邏輯即可。

2.通用倉儲和緩存介面

實現了泛型通用倉儲介面,批量更新和刪除方法基於最新的Entity Framework 7.0 RC1,為提高查詢效率,查詢方法全部返回IQueryable,包括分頁查詢,方便和其它實體連接後再篩選查詢欄位。

public interface IBaseRepository<TEntity> where TEntity : BaseEntity
{
Task<TEntity> Add(TEntity entity);
Task AddRange(params TEntity[] entities);

Task<TEntity> Update(TEntity entity);
Task<int> UpdateRange(Expression<Func<TEntity, bool>> whereLambda, Expression<Func<SetPropertyCalls<TEntity>, SetPropertyCalls<TEntity>>> setPropertyCalls);
Task<int> UpdateByPK(Guid Id, Expression<Func<SetPropertyCalls<TEntity>, SetPropertyCalls<TEntity>>> setPropertyCalls);


Task<TEntity> Delete(TEntity entity);
Task<int> DeleteRange(Expression<Func<TEntity, bool>> whereLambda);
Task<int> DeleteByPK(Guid Id);
Task<TEntity> DeleteByPK2(Guid Id);


Task<TEntity> SelectByPK(Guid Id);
IQueryable<TEntity> SelectRange<TOrder>(Expression<Func<TEntity, bool>> whereLambda, Expression<Func<TEntity, TOrder>> orderbyLambda, bool isAsc = true);
Task<PagedResult<TEntity>> SelectPaged<TOrder>(Expression<Func<TEntity, bool>> whereLambda, PagedOption pageOption, Expression<Func<TEntity, TOrder>> orderbyLambda, bool isAsc = true);

Task<bool> IsExist(Expression<Func<TEntity, bool>> whereLambda);
}
View Code

3.領域事件自動發佈和保存

在BaseDbContext文件的SaveChanges之前從實體中獲取領域事件併發布領域事件和保存領域事件通知,以備後查。

//所有包含領域事件的領域跟實體
var haveEventEntities = domainRootEntities.Where(x => x.Entity.DomainEvents != null && x.Entity.DomainEvents.Any()).ToList();
//所有的領域事件
var domainEvents = haveEventEntities
.SelectMany(x => x.Entity.DomainEvents)
.ToList();
//根據領域事件生成領域事件通知
var domainEventNotifications = new List<DomainEventNotification>();
foreach (var domainEvent in domainEvents)
{
domainEventNotifications.Add(new DomainEventNotification(nowTime, _currentUserService.UserId, domainEvent.EventType, JsonConvert.SerializeObject(domainEvent)));
}
//清除所有領域根實體的領域事件
haveEventEntities
.ForEach(entity => entity.Entity.ClearDomainEvents());
//生成領域事件任務並執行
var tasks = domainEvents
.Select(async (domainEvent) =>
{
await _mediator.Publish(domainEvent);
});
await Task.WhenAll(tasks);
//保存領域事件通知到數據表中
DomainEventNotifications.AddRange(domainEventNotifications);

領域事件發佈和通知保存在底層實現。開發人員不用關心領域事件發佈和保存邏輯,只關註於領域事件的定義和處理即可。

4.領域根實體審計信息自動記錄

在BaseDbContext文件的Savechanges之前對記錄領域根實體的審計信息。

//為每個繼承AggregateRootEntity領域跟的實體的AddedBy,Added,LastModifiedBy,LastModified賦值
//為刪除的實體生成實體刪除領域事件

DateTime nowTime = DateTime.UtcNow;
var domainRootEntities = ChangeTracker.Entries<AggregateRootEntity>();
foreach (var entry in domainRootEntities)
{
switch (entry.State)
{
case EntityState.Added:
entry.Entity.AddedBy = _currentUserService.UserId;
entry.Entity.Added = nowTime;
break;
case EntityState.Modified:
entry.Entity.LastModifiedBy = _currentUserService.UserId;
entry.Entity.LastModified = nowTime;
break;
case EntityState.Deleted:
EntityDeletedDomainEvent entityDeletedDomainEvent = new EntityDeletedDomainEvent(
_currentUserService.UserId,
entry.Entity.GetType().Name,
entry.Entity.Id,
JsonConvert.SerializeObject(entry.Entity)
);
entry.Entity.AddDomainEvent(entityDeletedDomainEvent);
break;
}
}

領域根實體審計信息記錄在底層實現。開發人員不用關心審計欄位的處理邏輯。

5. 回收站式軟刪除

採用回收站式軟刪除而不採用刪除欄位的軟刪除方式,是為了避免垃圾數據和多次刪除造成的唯一索引問題。
自動生成和發佈實體刪除的領域事件,代碼如上。
通過MediatR Handler,接收實體刪除領域事件,將已刪除的實體保存到回收站中。

public class EntityDeletedDomainEventHandler : INotificationHandler<EntityDeletedDomainEvent>
{
private readonly RecycleDomainService _domainEventService;

public EntityDeletedDomainEventHandler(RecycleDomainService domainEventService)
{
_domainEventService = domainEventService;
}


public async Task Handle(EntityDeletedDomainEvent notification, CancellationToken cancellationToken)
{
var eventData = JsonSerializer.Serialize(notification);
RecycledEntity entity = new RecycledEntity(notification.OccurredOn, notification.OccurredBy, notification.EntityType, notification.EntityId, notification.EntityData);
await _domainEventService.AddRecycledEntity(entity);
}
}

6.CQRS(命令查詢分離)

通過MediatR IRequest 實現了ICommand介面和Iquery介面,業務用例請求命令或者查詢繼承該介面即可。

public interface ICommand : IRequest
{
}

public interface ICommand<out TResult> : IRequest<TResult>
{
}
public interface IQuery<out TResult> : IRequest<TResult>
{

}
public class AddCategoryCommand : ICommand
{
public AddCategoryRequest Model { get; set; }
}

代碼中的AddCategoryCommand 增加類別命令繼承ICommand。

7.自動工作單元Commit

通過MediatR 管道實現了業務Command用例完成後自動Commit,開發人員不需要手動提交。

public class UnitOfWorkProcessor<TRequest, TResponse> : IRequestPostProcessor<TRequest, TResponse> where TRequest : IRequest<TResponse>
{
private readonly IUnitOfWork _unitOfWork;

public UnitOfWorkProcessor(IUnitOfWork unitOfWork)
{
_unitOfWork = unitOfWork;
}
public async Task Process(TRequest request, TResponse response, CancellationToken cancellationToken)
{
if (request is ICommand || request is ICommand<TResponse>)
{
await _unitOfWork.CommitAsync();
}
}
}

8.GRPC Message做為業務用例實體

通過將GRPC proto文件放入Application項目,重用其生成的message作為業務用例實體(Model)。

public class AddCategoryCommand : ICommand
{
public AddCategoryRequest Model { get; set; }
}

其中AddCategoryRequest 為proto生成的message。

9.通用CURD業務用例

在應用層分別實現了CURD的Command(增改刪)和Query(查詢) Handler。

public class CUDCommandHandler<TModel, TEntity> : IRequestHandler<CUDCommand<TModel>> where TEntity : BaseEntity
{
private readonly CURDDomainService<TEntity> _curdDomainService;

public CUDCommandHandler(CURDDomainService<TEntity> curdDomainService)
{
_curdDomainService = curdDomainService;
}

public async Task<Unit> Handle(CUDCommand<TModel> request, CancellationToken cancellationToken)
{
TEntity entity = null;
if (request.Operation == "C" || request.Operation == "U")
{
if (request.Model == null)
{
throw new BadRequestException($"the model of this request is null");
}
entity = request.Model.Adapt<TEntity>();
if (entity == null)
{
throw new ArgumentNullException($"the entity of {nameof(TEntity)} is null");
}
}
if (request.Operation == "U" || request.Operation == "D")
{
if (request.Id == Guid.Empty)
{
throw new BadRequestException($"the Id of this request is null");
}
}

switch (request.Operation)
{
case "C":
await _curdDomainService.Create(entity);
break;
case "U":
await _curdDomainService.Update(entity);
break;
case "D":
await _curdDomainService.Delete(request.Id);
break;
}

return Unit.Value;
}
}
View Code

開發人員只需要在GRPC層簡單調用即可實現CURD業務。

public async override Task<AddProductReply> AddProduct(AddProductRequest request, ServerCallContext context)
{
CUDCommand<AddProductRequest> addProductCommand = new CUDCommand<AddProductRequest>();
addProductCommand.Id = Guid.NewGuid();
addProductCommand.Model = request;
addProductCommand.Operation = "C";
await _mediator.Send(addProductCommand);
return new AddProductReply()
{
Message = "Add Product sucess"
};
}

10. 業務實體驗證

通過FluentValidation和MediatR 管道實現業務實體自動驗證,並自動拋出自定義異常。

public class RequestValidationBehavior<TRequest, TResponse> : IPipelineBehavior<TRequest, TResponse> where TRequest : IRequest<TResponse>
{
private readonly IEnumerable<IValidator<TRequest>> _validators;

public RequestValidationBehavior(IEnumerable<IValidator<TRequest>> validators)
{
_validators = validators;
}

public async Task<TResponse> Handle(TRequest request, CancellationToken cancellationToken, RequestHandlerDelegate<TResponse> next)
{
var errors = _validators
.Select(v => v.Validate(request))
.SelectMany(result => result.Errors)
.Where(error => error != null)
.ToList();

if (errors.Any())
{
var errorBuilder = new StringBuilder();

errorBuilder.AppendLine("Invalid Request, reason: ");

foreach (var error in errors)
{
errorBuilder.AppendLine(error.ErrorMessage);
}

throw new InvalidRequestException(errorBuilder.ToString(), null);
}
return await next();
}
}
View Code

開發人員只需要定義驗證規則即可

public class AddCategoryCommandValidator : AbstractValidator<AddCategoryCommand>
{
public AddCategoryCommandValidator()
{
RuleFor(x => x.Model.CategoryName).NotEmpty().WithMessage(p => "類別名稱不能為空.");
}
}

11.請求日誌和性能日誌記錄

基於MediatR 管道實現請求日誌和性能日誌記錄。

public class RequestPerformanceBehaviour<TRequest, TResponse> : IPipelineBehavior<TRequest, TResponse> where TRequest : IRequest<TResponse>
{
private readonly Stopwatch _timer;
private readonly ILogger<TRequest> _logger;
private readonly ICurrentUserService _currentUserService;
private readonly ICurrentTenantService _currentTenantService;

public RequestPerformanceBehaviour(ILogger<TRequest> logger, ICurrentUserService currentUserService, ICurrentTenantService currentTenantService)
{
_timer = new Stopwatch();

_logger = logger;
_currentUserService = currentUserService;
_currentTenantService = currentTenantService;
}

public async Task<TResponse> Handle(TRequest request, CancellationToken cancellationToken, RequestHandlerDelegate<TResponse> next)
{
_timer.Start();

var response = await next();

_timer.Stop();

if (_timer.ElapsedMilliseconds > 500)
{
var name = typeof(TRequest).Name;

_logger.LogWarning("Request End: {Name} ({ElapsedMilliseconds} milliseconds) {@UserId} {@Request}",
name, _timer.ElapsedMilliseconds, _currentUserService.UserId, request);
}

return response;
}
}
View Code

12. 全局異常捕獲記錄

基於MediatR 異常介面實現異常捕獲。

public class CommonExceptionHandler<TRequest, TResponse, TException> : IRequestExceptionHandler<TRequest, TResponse, TException>
where TException : Exception where TRequest: IRequest<TResponse>
{
private readonly ILogger<CommonExceptionHandler<TRequest, TResponse,TException>> _logger;
private readonly ICurrentUserService _currentUserService;
private readonly ICurrentTenantService _currentTenantService;

public CommonExceptionHandler(ILogger<CommonExceptionHandler<TRequest, TResponse, TException>> logger, ICurrentUserService currentUserService, ICurrentTenantService currentTenantService)
{
this._logger = logger;
_currentUserService = currentUserService;
_currentTenantService = currentTenantService;
}

public Task Handle(TRequest request, TException exception, RequestExceptionHandlerState<TResponse> state, CancellationToken cancellationToken)
{
var name = typeof(TRequest).Name;

_logger.LogError(exception, $"Request Error: {name} {state} Tenant:{_currentTenantService.TenantId} User:{_currentUserService.UserId}", request);

//state.SetHandled();
return Task.CompletedTask;
}

}
View Code

三、相關技術如下

* .NET Core 7.0 RC1

* ASP.NET Core 7.0 RC1

* Entity Framework Core 7.0 RC1

* MediatR 10.0.1

* Npgsql.EntityFrameworkCore.PostgreSQL 7.0.0-rc.1

* Newtonsoft.Json 13.0.1

* Mapster 7.4.0-pre03

* FluentValidation.AspNetCore 11.2.2

* GRPC.Core 2.46.5

四、 找工作

博主有10年以上的軟體技術實施經驗(Tech Leader),專註於軟體架構設計、軟體開發和構建,專註於微服務和雲原生(K8s)架構, .Net Core\Java開發和Devops。

博主有10年以上的軟體交付管理經驗(Project Manager,Product Ower),專註於敏捷(Scrum)項目管理、軟體產品業務分析和原型設計。

博主能熟練配置和使用 Microsoft Azure 和Microsoft 365 雲平臺,獲得相關微軟認證和證書。

我家在廣州,也可以去深圳工作。做架構和項目管理都可以,希望能從事穩定行業的業務數字化轉型。有工作機會推薦的朋友可以加我微信 15920128707,微信名字叫Jerry.


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 摘要:本文從零開始引導與大家一起學習圖知識。希望大家可以通過本教程學習如何使用圖資料庫與圖計算引擎。本篇將以華為雲圖引擎服務來輔助大家學習如何使用圖資料庫與圖計算引擎。 本文分享自華為雲社區《從零開始學Graph Database(1)》,作者:弓乙 。 基礎概念 什麼是圖? 首先,我們需要明確圖 ...
  • 這裡會介紹ClickHouse幾種資料庫引擎,已經對應的特點和應用的場景。資料庫引擎允許您處理數據表。預設情況下,ClickHouse使用Atomic資料庫引擎。它提供了可配置的table engines和SQL dialect。 目前的資料庫引擎: MySQL MaterializeMySQL L ...
  • 我們平時會寫各種各樣或簡單或複雜的sql語句,提交後就會得到我們想要的結果集。比如sql語句,”select * from t_user where user_id > 10;”,意在從表t_user中篩選出user_id大於10的所有記錄。你有沒有想過從一條sql到一個結果集,這中間經歷了多少坎坷... ...
  • 如何使用KrpanoToolJS在瀏覽器切圖 框架DEMO 框架源碼地址 【獨闢蹊徑】逆推Krpano切圖演算法,實現在瀏覽器切多層級瓦片圖 一、功能介紹 在瀏覽器中將全景圖轉為立方體圖、多層級瓦片圖 備註: 切圖的邏輯、縮略圖、預覽圖均以krpano為標準,如果是使用krpano來開發全景的,可以直 ...
  • 摘要:要想減少迴流和重繪的次數,首先要瞭解迴流和重繪是如何觸發的。 本文分享自華為雲社區《前端頁面之“迴流重繪”》,作者:CoderBin。 “迴流重繪”是什麼? 在HTML中,每個元素都可以理解成一個盒子,在瀏覽器解析過程中,會涉及到迴流與重繪: 迴流:佈局引擎會根據各種樣式計算每個盒子在頁面上的 ...
  • 導讀:成為一名架構師可能是很多開發者的技術追求之一。那麼如何理解架構?架構師是一個什麼樣的角色,需要具備什麼樣的能力?在架構師的道路上,會面臨哪些挑戰?本文作者道延分享他對架構以及架構師的思考和相關實踐,希望對同學們有所啟發。 ...
  • 定義抽象基類,規範介面內部方法執行順序 在進階篇中,沒專門提過抽象基類,在這裡順便就提一下 抽象基類的核心特征:不能被直接實例化 相反,抽象基類和元類一樣,一般都被當做頂層基類使用,派生類必須實現抽象類中指定的方法,且方法名也必須保持一致 抽象基類的主要用途:從一種高層次上規範編程介面 話不多說,直 ...
  • 本文詳細介紹了我國銀行核心系統的定義、位置與邊界,發展歷程、更換核心系統的原因,以及新核心建設的五大模式與其特點對比。希望內容能夠幫助銀行科技從業者建立起對銀行核心系統的整體認知,提供一定積極的指導作用與借鑒意義,從而引發思考並促進行業交流與探討,共同為我國的銀行科技蓬勃發展貢獻自己的智慧與經驗。 ... ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...