عنوان:

‫پیاده‌سازی الگوی Result در #C


نویسنده: وحید نصیری
تاریخ: ۱۴۰۴/۰۱/۰۷ ۰۸:۵۵
آدرس: www.dntips.ir
مقدمه
در دنیای برنامه‌نویسی، مدیریت خطاها یکی از جنبه‌های حیاتی توسعه نرم‌افزارهای پایدار و قابل اعتماد است. در زبان #C، توسعه‌دهندگان معمولاً از مکانیزم استثناها (Exceptions) برای رسیدگی به خطاها استفاده می‌کنند. با این حال، استفاده بیش از حد از استثناها برای خطاهای قابل پیش‌بینی یا قابل بازیابی می‌تواند به پیچیدگی کد، کاهش خوانایی و افت کارایی منجر شود. الگوی Result راه‌حلی جایگزین و قدرتمند ارائه می‌دهد که با بازگرداندن یک مقدار ساختاریافته، امکان مدیریت صریح موفقیت یا شکست عملیات را فراهم می‌کند. این الگو به‌ویژه برای توسعه‌دهندگان .NET که به دنبال کدی تمیزتر، قابل نگهداری‌تر و با کارایی بالاتر هستند، جذابیت زیادی دارد.
در این مقاله، به بررسی مفهوم الگوی Result، مزایای آن نسبت به استثناها، و نحوه پیاده‌سازی آن در #C می‌پردازیم. همچنین با ارائه مثال‌های عملی، نشان می‌دهیم که چگونه می‌توان از این الگو در برنامه‌های ASP.NET Core بهره برد. هدف این است که توسعه‌دهندگان بتوانند این الگو را به شکلی منسجم در پروژه‌های خود به کار گیرند.

الگوی Result چیست؟
الگوی Result یک روش ساختاریافته برای نشان دادن نتیجه یک عملیات است که می‌تواند موفقیت‌آمیز (Success) یا ناموفق (Failure) باشد. به جای پرتاب استثنا، این الگو یک شیء را بازمی‌گرداند که وضعیت عملیات و اطلاعات مرتبط با آن (مانند مقدار بازگشتی یا پیام خطا) را مشخص می‌کند. این رویکرد از مفاهیم برنامه‌نویسی تابعی (Functional Programming) الهام گرفته شده و به توسعه‌دهندگان اجازه می‌دهد جریان کد را به شکلی واضح‌تر مدیریت کنند.

چرا از الگوی Result استفاده کنیم؟
استفاده از استثناها در #C برای خطاهای قابل انتظار، مشکلاتی به همراه دارد:
  • هزینه عملکردی: پرتاب و گرفتن استثناها (Throwing and Catching Exceptions) عملیاتی پرهزینه است و در برنامه‌های با حجم بالا می‌تواند کارایی را کاهش دهد.
  • پیچیدگی جریان کد: کد پر از بلوک‌های try-catch خواندن و نگهداری آن را دشوار می‌کند.
  • عدم شفافیت: استثناها به وضوح نشان نمی‌دهند که چه نتایجی از یک عملیات ممکن است رخ دهد.

الگوی Result این مشکلات را با موارد زیر برطرف می‌کند:
  • شفافیت: نتیجه موفقیت یا شکست به صورت صریح در نوع بازگشتی مشخص می‌شود.
  • کارایی: با حذف استثناها برای خطاهای پیش‌بینی‌شده، سربار عملکردی کاهش می‌یابد.
  • خوانایی: جریان کد خطی‌تر و قابل فهم‌تر می‌شود.

پیاده‌سازی پایه الگوی Result در #C
برای شروع، یک کلاس پایه برای الگوی Result تعریف می‌کنیم که بتواند موفقیت یا شکست را نشان دهد. در مثال زیر، از یک پیاده‌سازی ساده استفاده شده است:
public class Result<T>
{
    public bool IsSuccess { get; }
    public T Value { get; }
    public string Error { get; }

    protected Result(bool isSuccess, T value, string error)
    {
        IsSuccess = isSuccess;
        Value = value;
        Error = error;
    }

    public static Result<T> Success(T value) => new Result<T>(true, value, null);
    public static Result<T> Failure(string error) => new Result<T>(false, default, error);
}
در این کد:
  • IsSuccess وضعیت عملیات را نشان می‌دهد.
  • Value مقدار بازگشتی در صورت موفقیت است.
  • Error پیام خطا در صورت شکست را نگه می‌دارد.
  • متدهای استاتیک Success و Failure برای ساخت سریع اشیاء Result استفاده می‌شوند.
مثال استفاده:
public Result<int> Divide(int a, int b)
{
    if (b == 0)
        return Result<int>.Failure("تقسیم بر صفر ممکن نیست");
    return Result<int>.Success(a / b);
}

var result = Divide(10, 2);
if (result.IsSuccess)
    Console.WriteLine($"نتیجه: {result.Value}");
else
    Console.WriteLine($"خطا: {result.Error}");

گسترش الگو برای سناریوهای پیچیده‌تر
برای پروژه‌های واقعی، ممکن است نیاز به اطلاعات بیشتری در صورت شکست داشته باشیم. یک کلاس Problem می‌تواند جزئیات خطا را به شکلی ساختاریافته ارائه دهد:
public class Problem
{
    public int StatusCode { get; }
    public string Description { get; }
    public string ErrorCode { get; }
    public List<string> Details { get; }

    public Problem(int statusCode, string description, string errorCode, List<string> details = null)
    {
        StatusCode = statusCode;
        Description = description;
        ErrorCode = errorCode;
        Details = details ?? new List<string>();
    }
}
سپس کلاس Result را به‌روزرسانی می‌کنیم تا از Problem استفاده کند:
public class Result<T>
{
    public bool IsSuccess { get; }
    public T Value { get; }
    public Problem Problem { get; }

    private Result(bool isSuccess, T value, Problem problem)
    {
        IsSuccess = isSuccess;
        Value = value;
        Problem = problem;
    }

    public static Result<T> Success(T value) => new Result<T>(true, value, null);
    public static Result<T> Failure(Problem problem) => new Result<T>(false, default, problem);
}
مثال استفاده در یک API:
public Result<string> GetUserName(int userId)
{
    if (userId <= 0)
        return Result<string>.Failure(new Problem(400, "شناسه کاربر نامعتبر است", "InvalidUserId"));
    return Result<string>.Success("کاربر نمونه");
}

var result = GetUserName(-1);
if (result.IsSuccess)
    Console.WriteLine(result.Value);
else
    Console.WriteLine($"{result.Problem.Description} (کد خطا: {result.Problem.ErrorCode})");

یکپارچه‌سازی با ASP.NET Core
در برنامه‌های ASP.NET Core، می‌توان از الگوی Result برای مدیریت پاسخ‌های API استفاده کرد. برای مثال، یک کنترلر می‌تواند مستقیماً شیء Result را بازگرداند و از طریق middleware یا ActionResult به پاسخ HTTP تبدیل شود.
مثال:
[HttpGet("{id}")]
public Result<string> Get(int id)
{
    if (id <= 0)
        return Result<string>.Failure(new Problem(400, "شناسه نامعتبر", "InvalidId"));
    return Result<string>.Success("داده دریافت شد");
}
برای پشتیبانی از OpenAPI و پاسخ‌های استاندارد، می‌توانید تنظیمات بیشتری به پروژه اضافه کنید، اما این پیاده‌سازی پایه نشان‌دهنده قدرت الگو در ساده‌سازی کدهاست.

مزایای تکمیلی در .NET
با ورود ویژگی‌هایی مانند discriminated unions در نسخه‌های آتی #C، الگوی Result حتی قدرتمندتر خواهد شد. این ویژگی به شما امکان می‌دهد انواع مختلفی از نتایج را به شکلی ایمن و مختصر تعریف کنید، که جایگزینی بومی برای پیاده‌سازی‌های دستی کنونی است.

نتیجه‌گیری
الگوی Result یک رویکرد مدرن و کارآمد برای مدیریت خطاها در برنامه‌نویسی #C است که به‌ویژه برای توسعه‌دهندگان .NET ارزشمند است. این الگو با کاهش وابستگی به استثناها، افزایش خوانایی کد و بهبود کارایی، به ساخت برنامه‌هایی پایدارتر کمک می‌کند. پیاده‌سازی آن ساده است و می‌توان آن را با نیازهای خاص پروژه تطبیق داد.


مشاهده مطلب اصلی