Refit 原理及使用Refit 和不使用的HTTP请求案例运用对比

一、概念：

        Refit 是一个用于 .NET 的 REST 客户端库，它允许你通过定义接口来调用 HTTP API。它的工作原理是通过使用 C# 接口和属性来描述 HTTP 请求，然后在运行时生成实现这些接口的代码，从而简化了与 RESTful 服务的交互。

二、原理

        Refit 的核心原理是利用 .NET 的反射机制和动态代理技术。在编译时，你只需要定义接口和方法签名，Refit 会在运行时生成这些接口的具体实现，并将其映射到相应的 HTTP 请求上。

三、作用

1. 简化 HTTP 请求：通过定义接口和注解，可以避免手写大量的 HTTP 请求代码。
2. 提高代码可读性：接口定义清晰明了，使得代码更易于维护和理解。
3. 减少重复代码：通过接口复用，可以减少重复的 HTTP 请求代码。

四、使用 Refit 实现实例

步骤一：安装 Refit 包

首先，需要在项目中安装 Refit NuGet 包。可以使用以下命令：

dotnet add package Refit.HttpClient

步骤二：定义接口

定义一个接口来描述你的 API 端点。例如，假设你有一个获取用户信息的 API：

using Refit;
using System.Threading.Tasks;

public interface IMyApi
{
    [Get("/users/{id}")]
    Task<User> GetUserAsync(int id);
}

public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Email { get; set; }
}

步骤三：配置和使用 Refit

在 Program.cs 或者 Startup.cs 中配置 Refit 客户端：

using Microsoft.Extensions.DependencyInjection;
using Refit;
using System;

var builder = WebApplication.CreateBuilder(args);

// 配置 Refit 客户端
builder.Services.AddRefitClient<IMyApi>()
                .ConfigureHttpClient(c => c.BaseAddress = new Uri("https://api.example.com"));

var app = builder.Build();

app.MapGet("/", async (IMyApi api) =>
{
    var user = await api.GetUserAsync(1);
    return Results.Ok(user);
});

app.Run();

完整示例

以下是一个完整的基于 .NET Core 6 的控制台应用程序示例：

using System;
using System.Threading.Tasks;
using Microsoft.Extensions.DependencyInjection;
using Refit;

public interface IMyApi
{
    [Get("/users/{id}")]
    Task<User> GetUserAsync(int id);
}

public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Email { get; set; }
}

class Program
{
    static async Task Main(string[] args)
    {
        var services = new ServiceCollection();
        
        // 配置 Refit 客户端
        services.AddRefitClient<IMyApi>()
                .ConfigureHttpClient(c => c.BaseAddress = new Uri("https://api.example.com"));

        var serviceProvider = services.BuildServiceProvider();
        var api = serviceProvider.GetRequiredService<IMyApi>();

        try
        {
            var user = await api.GetUserAsync(1);
            Console.WriteLine($"ID: {user.Id}, Name: {user.Name}, Email: {user.Email}");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}

五、使用 HttpClient 实现示例

步骤一：定义模型

首先，定义一个用于表示用户信息的模型类：

public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Email { get; set; }
}

步骤二：创建 HttpClient 并发起请求

在控制台应用程序中，使用 HttpClient 发起 HTTP 请求并处理响应：

using System;
using System.Net.Http;
using System.Text.Json;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var baseAddress = new Uri("https://api.example.com");
        using var httpClient = new HttpClient { BaseAddress = baseAddress };

        try
        {
            var response = await httpClient.GetAsync("/users/1");
            response.EnsureSuccessStatusCode();

            var jsonResponse = await response.Content.ReadAsStringAsync();
            var user = JsonSerializer.Deserialize<User>(jsonResponse, new JsonSerializerOptions
            {
                PropertyNameCaseInsensitive = true
            });

            Console.WriteLine($"ID: {user.Id}, Name: {user.Name}, Email: {user.Email}");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}

六、对比分析

使用 Refit 的优点

1. 简化代码：通过接口和注解来描述 HTTP 请求，避免了手写大量的 HTTP 请求代码。
2. 提高可读性：接口定义清晰明了，使得代码更易于维护和理解。
3. 减少重复代码：通过接口复用，可以减少重复的 HTTP 请求代码。
4. 内置错误处理：Refit 提供了一些内置的错误处理机制，可以更方便地处理 HTTP 错误。

使用 HttpClient 的缺点

1. 代码冗长：需要手动编写所有的 HTTP 请求代码，包括 URL 构建、请求发送、响应处理等。
2. 可读性差：由于代码量较大，可读性和维护性较差。
3. 重复代码多：如果有多个类似的请求，需要重复编写相同的代码逻辑。
4. 错误处理复杂：需要手动处理各种可能的 HTTP 错误和异常情况。

七、总结

        通过对比可以看出，使用 Refit 可以大大简化与 RESTful API 的交互代码，通过定义接口并使用依赖注入，你可以轻松地发起 HTTP 请求并处理响应，提高代码的可读性和可维护性。而使用原生的 HttpClient 虽然灵活，但代码量大且容易出错。