前言

在項(xiàng)目開發(fā)中，方法返回的結(jié)果（成功或失?。?duì)我們開發(fā)來說很重要。傳統(tǒng)方法，如通過異常來指示錯(cuò)誤或使用特定的返回類型（如布爾值加輸出參數(shù)），雖然有效，但可能缺乏直觀性和靈活性。

FluentResults庫(kù)應(yīng)運(yùn)而生，它以一種既流暢又富有表達(dá)力的方式，極大地優(yōu)化了這一過程。通過使用FluentResults，能夠以一種更加自然和易于理解的方式傳遞操作結(jié)果，包括成功狀態(tài)、錯(cuò)誤信息、警告以及額外信息，提高代碼的可讀性和可維護(hù)性。

這種方式不僅讓錯(cuò)誤處理更加集中和一致，還使得代碼結(jié)構(gòu)更加清晰，邏輯更加流暢。

項(xiàng)目介紹

FluentResults 是一個(gè)在 .NET 環(huán)境中廣泛使用的庫(kù)，它提供了一種優(yōu)雅的方式來處理方法執(zhí)行的結(jié)果和錯(cuò)誤。

使用 FluentResults，可以很容易地創(chuàng)建包含成功值、錯(cuò)誤、警告或信息的對(duì)象，并通過鏈?zhǔn)秸{(diào)用來處理這些對(duì)象。

那么如何使用 FluentResults 來優(yōu)雅地處理結(jié)果和錯(cuò)誤信息呢？

使用 FluentResults

1、安裝 FluentResults

首先，在項(xiàng)目中安裝 FluentResults，可以通過 NuGet 包管理器來安裝。在 Visual Studio 中也可以通過 NuGet 包管理器控制臺(tái)輸入以下命令：

Install-Package FluentResults

或者，在項(xiàng)目文件中添加 NuGet 包引用。

2、創(chuàng)建 Result 對(duì)象

使用 Result 類的靜態(tài)方法來創(chuàng)建結(jié)果對(duì)象。Result 類提供了多種方法來創(chuàng)建不同類型的結(jié)果，例如成功、失敗、帶有警告或信息的成功等。

using FluentResults;  


static  void Main(string[] args)
{
     var result = IsInteger("");


     if (result.IsSuccess)
     {
         Console.WriteLine($"結(jié)果：{result.Value} ");
     }
     else
     {
         Console.WriteLine($"結(jié)果：{result.Reasons[0].Message}|{result.Errors[0].Message}");
     }
}


public static Result<int>  IsInteger(string input)
{
     // 假設(shè)輸入為空或null，我們可以選擇認(rèn)為它不是數(shù)字  
     if (string.IsNullOrWhiteSpace(input))
     {
         return Result.Fail<int>("輸入為空或null，無(wú)法判斷是否是數(shù)字");
     }
     // 使用int.TryParse嘗試將輸入轉(zhuǎn)換為整數(shù)  
     // 如果轉(zhuǎn)換成功，out參數(shù)將包含轉(zhuǎn)換后的值，方法返回true  
     // 如果轉(zhuǎn)換失敗，方法返回false  
     if (int.TryParse(input, out int result))
     {
         return Result.Ok(result);
     }
     // 如果無(wú)法轉(zhuǎn)換為整數(shù)，則認(rèn)為輸入不是數(shù)字  
     return Result.Fail<int>("輸入不是數(shù)字");
}

運(yùn)行結(jié)果

通過使用Result 類我們可以看到，方法運(yùn)行返回了標(biāo)準(zhǔn)的接口參數(shù)，包括IsSuccess，Message，Errors等參數(shù)，幫我們快速實(shí)現(xiàn)返回結(jié)構(gòu)。

3、鏈?zhǔn)教幚斫Y(jié)果

FluentResults 允許你通過鏈?zhǔn)秸{(diào)用來處理結(jié)果，這使得錯(cuò)誤處理和邏輯流程更加清晰和直觀。

需要注意的是FluentResults 本身的 Result 類型并不直接提供 OnSuccess 和 OnFailure 這樣的鏈?zhǔn)椒椒?，因?yàn)檫@些方法可能是在 FluentResults 的某個(gè)版本中以擴(kuò)展方法的形式添加的，或者是在基于 FluentResults 的自定義擴(kuò)展中定義的。

自定義擴(kuò)展類 

/// <summary>
   /// Result 擴(kuò)展方法
   /// </summary>
   public static class ResultExtensions
   {
       /// <summary>
       /// 成功回調(diào)
       /// </summary>
       /// <param name="result"></param>
       /// <param name="successAction"></param>
       /// <returns></returns>
       public static Result OnSuccess(this Result result, Action successAction)
       {
           if (result.IsSuccess)
           {
               successAction?.Invoke();
           }
           return result; // 返回結(jié)果以支持鏈?zhǔn)秸{(diào)用  
       }


       /// <summary>
       /// 失敗回調(diào)
       /// </summary>
       /// <param name="result"></param>
       /// <param name="failureAction"></param>
       /// <returns></returns>
       public static Result OnFailure(this Result result, Action<IError> failureAction)
       {
           if (!result.IsSuccess && result.Errors!= null)
           {
               foreach (var error in result.Errors)
               {
                   failureAction?.Invoke(error);
               }
           }
           return result; // 返回結(jié)果以支持鏈?zhǔn)秸{(diào)用  
       }
   }

自定義方法

/// <summary>
/// 驗(yàn)證輸入字符串是否為整數(shù)
/// </summary>
/// <param name="input"></param>
/// <returns></returns>
public static Result IsIntegerInfo(string input)
{
    // 假設(shè)輸入為空或null，我們可以選擇認(rèn)為它不是數(shù)字  
    if (string.IsNullOrWhiteSpace(input))
    {
        return Result.Fail("輸入為空或null，無(wú)法判斷是否是數(shù)字");
    }
    // 使用int.TryParse嘗試將輸入轉(zhuǎn)換為整數(shù)  
    // 如果轉(zhuǎn)換成功，out參數(shù)將包含轉(zhuǎn)換后的值，方法返回true  
    // 如果轉(zhuǎn)換失敗，方法返回false  
    if (int.TryParse(input, out int result))
    {
        return Result.Ok();
    }
    // 如果無(wú)法轉(zhuǎn)換為整數(shù)，則認(rèn)為輸入不是數(shù)字  
    return Result.Fail("輸入不是數(shù)字");
}

調(diào)用示例 

var result = IsIntegerInfo("")
     .OnSuccess(() =>
     {
             // 處理成功的情況  
             Console.WriteLine("Success!");
     })
     .OnFailure(error =>
     {
         // 處理失敗的情況  
         Console.WriteLine("Failed: " + error.Message);
     });
 // 注意：在 OnSuccess 或 OnFailure 中使用 result 變量可能不是安全的，  
 // 因?yàn)檫@些回調(diào)可能在這些回調(diào)執(zhí)行之前就被修改了。  
 // 更好的做法是在 OnSuccess/OnFailure 的 lambda 表達(dá)式中使用局部變量。

運(yùn)行結(jié)果

在這個(gè)示例中定義了兩個(gè)擴(kuò)展方法 OnSuccess 和 OnFailure，它們分別接受成功和失敗時(shí)要執(zhí)行的回調(diào)函數(shù)。這些方法首先檢查 Result 對(duì)象的狀態(tài)，然后根據(jù)狀態(tài)調(diào)用相應(yīng)的回調(diào)函數(shù)。最后，它們返回原始的 Result 對(duì)象，以支持鏈?zhǔn)秸{(diào)用。

請(qǐng)注意，示例是為了說明目的而簡(jiǎn)化的，并且可能不包含 FluentResults 庫(kù)中實(shí)際可用的所有功能和優(yōu)化。在實(shí)際應(yīng)用中，應(yīng)該查看 FluentResults 的文檔和源代碼，以了解提供的具體功能。

4、FluentResults 高級(jí)特性

FluentResults提供許多高級(jí)特性，如鏈?zhǔn)秸{(diào)用、自定義錯(cuò)誤類型、以及包含額外數(shù)據(jù)和元數(shù)據(jù)的錯(cuò)誤對(duì)象。

例如，可以使用Result.Fail的重載版本來包含更多的上下文信息

return Result.Fail("輸入錯(cuò)誤.").WithError("The input value must be greater than zero.");

5、自定義 Result 類型

FluentResults 還支持通過繼承 Result 類來創(chuàng)建自定義的結(jié)果類型，以便在結(jié)果中攜帶額外的數(shù)據(jù)或狀態(tài)。

public class CommonResult
{
    public Result Result { get; }
    public string MyData { get; }


    public CommonResult(Result result, string myData)
    {
        Result = result;
        MyData = myData;
        Console.WriteLine($"{nameof(CommonResult)}: {MyData}|{result}");
    }
}

調(diào)用示例

public static CommonResult DemoResult(string input)
 {
     bool isSuccess =false;
     string errorMessage = "輸入的字符串不是數(shù)字";
     string myData = "測(cè)試一下";


     Result result = isSuccess ? Result.Ok() : Result.Fail(errorMessage);
     return new CommonResult(result, myData);
 }

運(yùn)行結(jié)果

通過以上步驟，可以在 .NET 應(yīng)用快速、方便的使用 FluentResults 來處理結(jié)果和錯(cuò)誤?？梢蕴岣叽a的可讀性和可維護(hù)性，還可以使錯(cuò)誤處理更加集中和統(tǒng)一規(guī)范。

使用場(chǎng)景

API 開發(fā)：在處理 HTTP 請(qǐng)求和響應(yīng)時(shí)，F(xiàn)luentResults 構(gòu)建清晰、一致和易于理解的錯(cuò)誤響應(yīng)。

業(yè)務(wù)邏輯驗(yàn)證：在執(zhí)行業(yè)務(wù)邏輯驗(yàn)證時(shí)，F(xiàn)luentResults 可以驗(yàn)證多個(gè)錯(cuò)誤，并一次性返回。

復(fù)雜操作的結(jié)果處理：當(dāng)需要處理包含多個(gè)步驟的復(fù)雜操作時(shí)，F(xiàn)luentResults 可以幫助管理每個(gè)步驟的結(jié)果，并將它們組合成一個(gè)最終的結(jié)果。

總結(jié)

FluentResults 提供了豐富的 API，可以靈活使用，與現(xiàn)有的 .NET 代碼庫(kù)和框架集成，如 ASP.NET Core、Entity Framework 等，還可以與其他第三方庫(kù)一起使用，以提供更全面的錯(cuò)誤處理和結(jié)果功能。

如果你的項(xiàng)目中需要一種更好的方式來處理結(jié)果，并希望提高代碼的可讀性和可維護(hù)性，那么 FluentResults 是一個(gè)不錯(cuò)的選擇。

開源地址

https://github.com/altmann/FluentResults

轉(zhuǎn)自https://www.cnblogs.com/1312mn/p/18336221