قبل ار اینکه به پیاده سازی CQRS بپردازیم کمی به علت استفاده از آن میپردازیم.
هدف از استفاده از الگوی CQRS (Command and Query Responsibility Segregation) کدنویسی بهینه تر در بخشهایی از پروژه که دارای پیچیدگی زیادی دارند می باشند.لذا در این بخش بصورت خیلی ساده و به دور از هرگونه توضیحات اضافه که فقط باعث سختتر شدن فهم مطالب برای شما هنرجویان میشود ، خواهیم پرداخت.
در این سناریو پیاده سازی عملیات CRUD برای موجودیت Product با استفاده از CQRS و Mediator انجام خواهد شد.
دقت داشته باشید هنگام پیاده سازی عملیات CRUD با استفاده از الگوی CQRS ، عملیات خواندن داده ها (Read) را درون پوشه Query قرار می دهیم و سایر دستورات ( Insert / Update یا Delete ) را درون پوشه Comman قرار می دهیم لذا در این مثال پس از ایجاد پروژه یک پوشه به نام CQRS ایجاد میکنیم و سپس درون آن پوشه ای به نام ProductCommandQuery و درون آن دو پوشه به نامهای Command و Query ایجاد میکنیم.
در این مثال موجودیت Product با صفات زیر را در نظر بگیرید.
public class Product{
[Key]
public int Id { get; set; }
public string ProductName { get; set; }
public long Price { get; set; }
}
و کلاس Context را بصورت زیر در نظر میگیریم.
public class EshopDbContext : DbContext{
public EshopDbContext(DbContextOptions options):base(options)
{
}
public DbSet<Product> Products =>Set<Product>();
}
}
نکته : تنظیمات رشته اتصال درون app.setting و عملیات Migration انجام شود.
برای فراخوانیهای سرویسهای درون CQRS از یک واسط به نام Mediator استفاده میکنیم لذا در این قسمت از برنامه از طریق nuget کتابخانه مورد نظر را به پروژه اضافه میکنیم.
MediatR.Extensions.Microsoft.DependencyInjection
پیاده سازی الگوی ریپازیتوری(Repository) :
درون پوشه ای به نام Repositositories کلاسی به نام IRepository ایجاد میکنیم و اینترفیس IProductRepository را بصورت زیر ویرایش میکنیم.
public interface IProductRepository
{
Task<Product> GetAsync(int id);
Task<List<Product>> GetAllAsync();
Task<int> InsertAsync(Product product);
}
البته بر اساس نیاز میتوانید امضای متدهای بیشتری را درون آن قرار دهید.
سپس درون پوشه Repositories کلاس ProductRepositories را بصورت زیر درج میکنیم.
internal class ProductRepositories : IProductRepository
{
private readonly EshopDbContext context;
public ProductRepositories(EshopDbContext context)
{
this.context = context;
}
public async Task<Product> GetAsync(int id)
{
return await context.Products.FindAsync(id);
}
public Task<List<Product>> GetAllAsync()
{
throw new NotImplementedException();
}
public async Task<int> InsertAsync(Product product)
{
await context.AddAsync(product);
return product.Id;
}
}
پیاده سازی UnitOfwork :
جهت جدا سازی عملیات ذخیره سازی داده ها از الگوی Repository باید از مفهوم UnitOfWork استفاده نماییم. برای پیاده سازی آن ابتدا یک اینترفیس به نام IUnitOfwork بصورت زیر ایجاده میکنیم.
public interface IUnitOfWork:IDisposable
{
Task<int> SaveChangesAsync();
}
سپس کلاس UnitOfwork را بصورت زیر درج میکنیم.
public class UnitOfWork : IUnitOfWork
{
private readonly EshopDbContext context;
public UnitOfWork(EshopDbContext context)
{
this.context = context;
}
public void Dispose()
{
context.Dispose();
}
public async Task<int> SaveChangesAsync()
{
return await context.SaveChangesAsync();
}
}
برای پیاده سازی عملیات ذخیره سازی داده با استفاده از CQRS کلاسی به نام SaveProductCommand درون پوشه Command ایجاد میکنیم.
using Microsoft.EntityFrameworkCore.Storage;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace Application.CQRS.ProductCommandQuery.Command;
public class SaveProductCommand : IRequest<SaveProductCommandResponse>
{
public string ProductName { get; set; }
public int CategoryId { get; set; }
public long Price { get; set; }
public string Description { get; set; }
}
public class SaveProductCommandResponse
{
public int ProductId { get; set; }
}
public class SaveProductCommandHandler : IRequestHandler<SaveProductCommand, SaveProductCommandResponse>
{
private readonly IProductRepository repository;
private readonly IUnitOfWork unitOfWork;
public SaveProductCommandHandler(IProductRepository repository,IUnitOfWork unitOfWork)
{
this.repository = repository;
this.unitOfWork = unitOfWork;
}
public async Task<SaveProductCommandResponse> Handle(SaveProductCommand request, CancellationToken cancellationToken)
{
var product = new Product
{
ProductName = request.ProductName,
Price= request.Price
};
await repository.InsertAsync(product);
await unitOfWork.SaveChangesAsync();
var response = new SaveProductCommandResponse
{
ProductId = product.Id
};
return response;
}
کلاس SaveProductCommand برای دریافت داده ها از ورودی مورد استفاده قرار میگیرد لذا باید از این کلاس جهت پر کردن مقادیر ورودی استفاده کنیم.
کلاس SaveProductCommandResponse جهت بازگرداندن خروجی مورد استفاده قرار میگیرد لذا شما بر اساس نیاز پروژه فیلدهای مورد نظر را تعریف نمایید.
کلاس SaveProductCommandHandler جهت اجرای دستورات با استفاده از mediator مورد استفاده قرار میگیرد. که با فراخوانی متد Handle آن دستورات اجرا شده و داده ها درون دیتابیس ذخیره میشود.
اکنون یک Api به نام ProductController جهت استفاد و اجرای برنامه بصورت زیر ایجاد میکنیم.
[ApiController]
[Route("api/[controller]")]
public class ProductController : ControllerBase
{
private readonly IMediator mediator;
public ProductCQRSController(IMediator mediator)
{
this.mediator = mediator;
}
[HttpPost]
public async Task <IActionResult> Create(SaveProductCommand saveProductCommand)
{
var result=await mediator.Send(saveProductCommand);
return Ok(result);
}
}
دقت نمایید با استفاده از mediator سرویس مورد نظر را درون متد Send اجرا میکنیم.