CQRS متن باز برای دنیای .NET

میثم سلیمانی
میثم سلیمانی
@meysams
· 30 آبان 1405 · 7 دقیقه مطالعه · 2 بازدید

یک راهکار متن‌باز برای پیاده‌سازی CQRS در اکوسیستم .NET

اگر مدتی در اکوسیستم .NET توسعه نرم‌افزار انجام داده باشید، احتمالاً با الگوی معماری CQRS و کتابخانه‌هایی مانند MediatR آشنا هستید.

برای سال‌ها، MediatR یکی از انتخاب‌های رایج توسعه‌دهندگان دات‌نت برای پیاده‌سازی Command، Query، Handler و Pipeline Behavior بود. اما تغییر مدل لایسنس این کتابخانه از نسخه 13 به بعد، در سال 2025، باعث شد بسیاری از توسعه‌دهندگان و تیم‌های نرم‌افزاری دوباره درباره وابستگی به ابزارهای زیرساختی و هزینه‌های احتمالی آن‌ها فکر کنند.

البته MediatR همچنان برای برخی شرایط دارای مجوز Community رایگان است و استفاده تجاری از نسخه‌های جدید آن الزاماً برای همه به معنای پرداخت هزینه نیست. با این حال، تغییر مدل لایسنس، موضوع مهمی را دوباره مطرح کرد:


آیا برای پیاده‌سازی یک الگوی معماری مانند CQRS، واقعاً باید به یک کتابخانه مشخص وابسته باشیم؟

این سؤال یکی از انگیزه‌های من برای توسعه پروژه BitWrite.Cqrs بود.

ایجاد یک کتابخانه مستقل، سبک و قابل توسعه برای پیاده‌سازی CQRS که علاوه بر جداسازی مسئولیت‌های خواندن و نوشتن، امکانات موردنیاز پروژه‌های واقعی را نیز در اختیار توسعه‌دهندگان قرار دهد.

در این پروژه تصمیم گرفتم به‌جای ساخت یک Wrapper ساده برای MediatR، پیاده‌سازی مستقلی از مفاهیم Command، Query، Event و پردازشگرهای مربوط به آن‌ها ارائه کنم.

BitWrite.Cqrs چیست؟

BitWrite.Cqrs یک کتابخانه متن‌باز مبتنی بر .NET 9 است که برای پیاده‌سازی الگوی CQRS طراحی شده است.

این کتابخانه امکاناتی برای مدیریت Commandها، Queryها، Eventها و پردازش دستورات داخلی فراهم می‌کند.

برخی از قابلیت‌های اصلی آن عبارت‌اند از:

۱. Command Processing

تعریف Commandهای Strongly Typed

مدیریت Create، Update و Delete

پیاده‌سازی Pipeline Behavior

اعتبارسنجی با FluentValidation

Logging و Error Handling

مکانیزم Retry با تنظیمات قابل پیکربندی

پشتیبانی از Transaction و Deadlock Retry

مدیریت نتیجه اجرای Command

پشتیبانی اختیاری از Command Versioning

۲. Query Processing

در بخش Query تلاش شده است مسئولیت خواندن داده‌ها کاملاً از عملیات تغییر وضعیت سیستم جدا باشد.

قابلیت‌های این بخش شامل:

تعریف Queryهای Strongly Typed

پیاده‌سازی Query Handler

پشتیبانی از Async/Await

یکپارچگی با Dependency Injection

ثبت خودکار Handlerها

۳. Event Processing

یکی دیگر از بخش‌های کتابخانه، مدیریت رویدادهاست.

قابلیت‌های این قسمت:

انتشار Event

پشتیبانی از چند Handler برای یک Event

ثبت خودکار Event Handlerها

پردازش غیرهم‌زمان

Logging و مدیریت خطا

۴. Internal Commands و Outbox Pattern

یکی از قابلیت‌هایی که برای من اهمیت زیادی داشت، امکان اجرای دستورات در آینده و خارج از جریان درخواست جاری بود.

برای این منظور، مکانیزم Internal Command در کتابخانه پیاده‌سازی شده است.

این قابلیت شامل موارد زیر است:

زمان‌بندی اجرای Commandها

پردازش توسط Background Service

Retry Policy قابل تنظیم

نگهداری وضعیت اجرای دستورات

ثبت خطاهای پردازش

پاک‌سازی خودکار دستورات قدیمی

پشتیبانی از Storage Providerهای مختلف

برای ذخیره‌سازی نیز امکان استفاده از In-Memory، PostgreSQL و MongoDB در نظر گرفته شده است.

۵. Transaction Management

در سیستم‌های سازمانی، مدیریت تراکنش و کنترل خطاهای هم‌زمانی اهمیت زیادی دارد.

به همین دلیل قابلیت‌هایی مانند موارد زیر در کتابخانه پیش‌بینی شده‌اند:

تنظیم Isolation Level

تعیین Transaction Timeout

پشتیبانی از تراکنش‌های موجود

تشخیص Deadlock

تلاش مجدد در صورت وقوع Deadlock

مدیریت Rollback در صورت شکست عملیات

استفاده از کتابخانه چقدر ساده است؟

یکی از اولویت‌های من در طراحی این کتابخانه، تجربه توسعه‌دهنده و سادگی راه‌اندازی بوده است.

برای نصب می‌توانید از NuGet استفاده کنید:

dotnet add package BitWrite.Cqrs

سپس سرویس‌های موردنیاز را در Dependency Injection ثبت کنید:

services.AddBwCqrs(builder =>
{
    builder
        .AddValidation()
        .AddLogging()
        .AddErrorHandling()
        .AddRetry(
            maxRetries: 3,
            delayMilliseconds: 1000
        );
}, typeof(Program).Assembly);

برای تعریف یک Command، کافی است مدل موردنظر را تعریف کرده و Handler مربوط به آن را پیاده‌سازی کنید:

public class CreateUserCommand
    : CreateCommand<CreateUserRequest>
{
    public CreateUserCommand(CreateUserRequest data)
        : base(data)
    {
    }
}

و Handler:

public class CreateUserCommandHandler
    : ICommandHandler<CreateUserCommand>
{
    private readonly IUserRepository _userRepository;

    public CreateUserCommandHandler(
        IUserRepository userRepository)
    {
        _userRepository = userRepository;
    }

    public async Task<IResult> HandleAsync(
        CreateUserCommand command)
    {
        var user = new User(
            command.Data.Username,
            command.Data.Email
        );

        await _userRepository.AddAsync(user);

        return CommandResult.Success();
    }
}

به این ترتیب، مسئولیت اجرای عملیات در یک Handler مشخص قرار می‌گیرد و دغدغه‌هایی مانند اعتبارسنجی، Logging و مدیریت خطا می‌توانند در Pipeline مدیریت شوند.

چرا یک پروژه متن‌باز؟

به اعتقاد من، زیرساخت‌های نرم‌افزاری باید تا حد امکان شفاف، قابل بررسی و قابل توسعه باشند.

هدف از انتشار BitWrite.Cqrs این است که توسعه‌دهندگان بتوانند بدون وابستگی اجباری به یک چارچوب تجاری مشخص، از یک پیاده‌سازی مستقل CQRS در پروژه‌های خود استفاده کنند.

این پروژه تحت مجوز MIT منتشر شده است و سورس کد آن در GitHub در دسترس قرار دارد.

همچنین از مشارکت توسعه‌دهندگان، گزارش مشکلات، پیشنهاد قابلیت‌های جدید و Pull Request استقبال می‌کنم.

آیا BitWrite.Cqrs جایگزین کامل MediatR است؟

هدف من ساخت یک Clone از MediatR نبوده است.

این پروژه با رویکرد و طراحی مستقل توسعه داده شده و تلاش می‌کند مجموعه‌ای از امکانات کاربردی CQRS را در قالب یک کتابخانه قابل استفاده ارائه کند.

انتخاب بین کتابخانه‌های مختلف باید بر اساس نیاز پروژه، معماری، قابلیت‌های موردنیاز، هزینه نگهداری و شرایط لایسنس انجام شود.

BitWrite.Cqrs یکی از گزینه‌هایی است که توسعه‌دهندگان .NET می‌توانند برای بررسی و استفاده در پروژه‌های خود در نظر بگیرند.

در پایان

توسعه BitWrite.Cqrs برای من صرفاً پیاده‌سازی چند Interface و Handler نبوده است؛ بلکه تلاشی برای ساخت یک زیرساخت نرم‌افزاری قابل استفاده در پروژه‌های واقعی بوده است.

امیدوارم این پروژه بتواند برای توسعه‌دهندگان .NET مفید باشد و بستری برای تبادل تجربه و مشارکت جامعه برنامه‌نویسی فراهم کند.

اگر به معماری نرم‌افزار، CQRS و توسعه سیستم‌های مبتنی بر .NET علاقه‌مند هستید، خوشحال می‌شوم پروژه را بررسی کنید و نظرات و پیشنهادهای خودتان را با من به اشتراک بگذارید.

لینک پروژه در GitHub:

https://github.com/MeysamS/BwCqrs

نویسنده و توسعه‌دهنده: میثم سلیمانی

#CSharp #DotNet #CQRS #MediatR #SoftwareArchitecture #OpenSource #BitWrite

به این مقاله چه واکنشی داری؟
2 بازدید
☕

اگر این مقاله برات مفید بود، از نویسنده حمایت کن

کامنت‌ها
برای ثبت کامنت وارد شوید.
0 دنبال‌کننده
1 مقاله
ورود برای دنبال کردن مشاهده پروفایل
اشتراک‌گذاری