C# API调用工具实战指南：从HttpClient到Refit的深度解析

1次阅读

没有评论

共计 2464 个字符，预计需要花费 7 分钟才能阅读完成。

在现代 C# 开发中，API 调用几乎是每个项目都无法避免的需求。然而，许多开发者在实际使用过程中常常会遇到各种问题，这些问题不仅影响开发效率，更可能在生产环境中造成严重故障。

连接管理混乱 ：不少开发者会在每次调用时创建新的 HttpClient 实例，这可能导致端口耗尽问题（Socket exhaustion）
异常处理不足 ：对 HTTP 状态码和网络异常的处理不够全面，导致系统在遇到临时故障时无法优雅恢复
性能瓶颈 ：缺乏连接池管理和请求批处理机制，造成不必要的性能开销
维护困难 ：代码中分散的 API 调用难以统一管理和重构
安全疏忽 ：对认证凭证、敏感数据的处理不够严谨，存在安全风险

C# 生态中有多个主流的 API 调用工具，各有特点：

优点：
.NET 官方提供，无需额外依赖
高度可配置，支持自定义消息处理器管道
内置连接池管理（从.NET Core 2.1 开始）
缺点：
使用接口较为底层，需要更多样板代码
需要手动处理 JSON 序列化 / 反序列化

优点：
简化了 HTTP 请求构造过程
内置 JSON 序列化支持
社区活跃，文档丰富
缺点：
在某些场景下性能不如原生 HttpClient
需要额外学习其特有的 API 风格

优点：
基于接口的声明式 API 定义
自动处理序列化和反序列化
编译时类型检查
缺点：
灵活性相对较低
调试复杂请求时不够直观

// 推荐使用 IHttpClientFactory 管理生命周期
public class MyApiClient
{
    private readonly HttpClient _httpClient;

    public MyApiClient(HttpClient httpClient)
    {
        _httpClient = httpClient;
        _httpClient.BaseAddress = new Uri("https://api.example.com");
        _httpClient.DefaultRequestHeaders.Add("Accept", "application/json");
    }

    public async Task<User> GetUserAsync(int userId)
    {
        try
        {var response = await _httpClient.GetAsync($"/users/{userId}");
            response.EnsureSuccessStatusCode();
            return await response.Content.ReadAsAsync<User>();}
        catch (HttpRequestException ex) when (ex.StatusCode == HttpStatusCode.NotFound)
        {return null; // 处理特定状态码}
    }
}

public class UserService
{
    private readonly RestClient _client;

    public UserService()
    {_client = new RestClient("https://api.example.com");
        _client.AddDefaultHeader("Accept", "application/json");
    }

    public User GetUser(int userId)
    {var request = new RestRequest($"/users/{userId}", Method.Get);
        var response = _client.Execute<User>(request);

        if (!response.IsSuccessful)
        {throw new ApiException(response.StatusCode, response.ErrorMessage);
        }

        return response.Data;
    }
}

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

// 使用
var userApi = RestService.For<IUserApi>("https://api.example.com");
var user = await userApi.GetUserAsync(123);

我们对三种工具进行了基准测试（1000 次连续调用）：