首页
/ FluentResults 使用教程

FluentResults 使用教程

2024-09-15 21:48:43作者:昌雅子Ethen

1. 项目介绍

FluentResults 是一个轻量级的 .NET 库,旨在解决一个常见的问题:如何优雅地处理方法执行的成功或失败。它通过返回一个表示操作成功或失败的对象,而不是抛出异常,来实现这一目标。FluentResults 支持多种 .NET 平台,包括 .NET Standard、.NET Core、.NET 5+ 以及 .NET Full Framework。

主要特性

  • 通用容器:适用于所有上下文(如 ASP.NET MVC/WebApi、WPF、DDD 领域模型等)。
  • 存储多个错误:一个 Result 对象可以存储多个错误信息。
  • 对象导向的错误和成功消息:存储强大的 Error 和 Success 对象,而不是简单的字符串消息。
  • 错误链:支持存储错误的根本原因及其链式错误。
  • 支持多种 .NET 平台:包括 .NET Standard、.NET Core、.NET 5+ 和 .NET Full Framework。
  • SourceLink 支持:方便调试和代码导航。
  • 扩展方法:提供丰富的扩展方法,如链式调用、自定义错误类型等。

2. 项目快速启动

安装 FluentResults

首先,通过 NuGet 包管理器安装 FluentResults:

Install-Package FluentResults

创建和处理 Result 对象

以下是一个简单的示例,展示如何创建和处理 Result 对象:

using FluentResults;

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

        if (result.IsSuccess)
        {
            Console.WriteLine($"结果:{result.Value}");
        }
        else
        {
            Console.WriteLine($"结果:{result.Reasons[0].Message}");
        }
    }

    public static Result<int> IsInteger(string input)
    {
        if (string.IsNullOrWhiteSpace(input))
        {
            return Result.Fail<int>("输入为空或null,无法判断是否是数字");
        }

        if (int.TryParse(input, out int result))
        {
            return Result.Ok(result);
        }

        return Result.Fail<int>("输入不是数字");
    }
}

链式处理结果

FluentResults 允许通过链式调用来处理结果,使错误处理和逻辑流程更加清晰和直观:

var result = IsInteger("abc")
    .OnSuccess(() => Console.WriteLine("Success!"))
    .OnFailure(error => Console.WriteLine($"Failed: {error.Message}"));

3. 应用案例和最佳实践

API 开发

在处理 HTTP 请求和响应时,FluentResults 可以帮助构建清晰、一致和易于理解的错误响应:

[HttpGet("Normal")]
public async Task<ActionResult<object>> Normal()
{
    var r1 = Result.Fail("SomeError2");
    return BadRequest(r1);
}

业务逻辑验证

在执行业务逻辑验证时,FluentResults 可以验证多个错误,并一次性返回:

public Result ValidateBusinessLogic()
{
    var result = Result.Ok();

    if (!IsValid())
    {
        result.WithError("业务逻辑验证失败");
    }

    return result;
}

复杂操作的结果处理

当需要处理包含多个步骤的复杂操作时,FluentResults 可以帮助管理每个步骤的结果,并将它们组合成一个最终的结果:

public Result ComplexOperation()
{
    var result = Result.Ok();

    result = result.Bind(() => Step1());
    result = result.Bind(() => Step2());
    result = result.Bind(() => Step3());

    return result;
}

4. 典型生态项目

ASP.NET Core

在 ASP.NET Core 项目中,FluentResults 可以与 MediatR 结合使用,处理请求和响应的结果:

public class GetUserQuery : IRequest<Result<User>>
{
    public int UserId { get; set; }
}

public class GetUserQueryHandler : IRequestHandler<GetUserQuery, Result<User>>
{
    public Task<Result<User>> Handle(GetUserQuery request, CancellationToken cancellationToken)
    {
        if (request.UserId <= 0)
        {
            return Task.FromResult(Result.Fail<User>("无效的用户ID"));
        }

        var user = GetUserFromDatabase(request.UserId);
        return Task.FromResult(Result.Ok(user));
    }
}

Entity Framework

在 Entity Framework 中,FluentResults 可以用于处理数据库操作的结果:

public Result<User> GetUserById(int userId)
{
    var user = _context.Users.FirstOrDefault(u => u.Id == userId);

    if (user == null)
    {
        return Result.Fail<User>("用户不存在");
    }

    return Result.Ok(user);
}

通过以上示例,您可以快速上手并深入了解 FluentResults 的使用方法和最佳实践。

登录后查看全文

项目优选

收起
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
295
946
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
490
393
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
111
195
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
59
140
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
356
321
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
51
14
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
97
251
ArkAnalyzer-HapRayArkAnalyzer-HapRay
ArkAnalyzer-HapRay 是一款专门为OpenHarmony应用性能分析设计的工具。它能够提供应用程序性能的深度洞察,帮助开发者优化应用,以提升用户体验。
Python
18
6
arkanalyzerarkanalyzer
方舟分析器:面向ArkTS语言的静态程序分析框架
TypeScript
32
38
CangjieMagicCangjieMagic
基于仓颉编程语言构建的 LLM Agent 开发框架,其主要特点包括:Agent DSL、支持 MCP 协议,支持模块化调用,支持任务智能规划。
Cangjie
579
41