博主最近失業在家，找作業之余，看了一些關于洋蔥（整潔）架構的資料和專案，有感而發，自己動手寫了個洋蔥架構解決方案，起名叫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 =https://www.cnblogs.com/xiaozhuang/archive/2022/10/09/ 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.
轉載請註明出處，本文鏈接：https://www.uj5u.com/ruanti/511987.html
標籤：其他
上一篇：初識設計模式 - 外觀模式