c#如何使用Refit调用API_c#Refit调用API快速上手实战教程

夜晨同学_9181

夜晨同学_9181

2026-04-10

392人浏览

原创

Refit需接口定义+配置HttpClient才能工作,返回类型必须为Task或IObservable,不支持同步方法;注册须用IHttpClientFactory,JSON字段映射用[JsonPropertyName]而非[AliasAs]。

c#如何使用refit调用api_c#refit调用api快速上手实战教程

Refit 不是“开箱即用”的 HTTP 客户端,它依赖接口定义 + 运行时生成实现 —— 如果你直接 new 一个接口或没配好 HttpClient,立刻会报 System.ArgumentException: Type is not a Refit interface 或 NullReferenceException。

定义 API 接口时必须加 [Get] / [Post] 等特性,且返回类型只能是 Task 或 IObservable

Refit 通过特性解析路由和序列化行为,不支持同步方法(如 string GetUser()),也不接受 void 返回。常见错误包括:

  • 写成 public string GetUser(int id) → 编译不报错但运行时报 Type is not a Refit interface
  • 忘了加 [Get("/users/{id}")],只写了方法签名 → 生成的代理无法映射请求
  • 返回 Task → Refit 不处理原始响应,要用 Task>(需引用 Refit.IResponse)

正确示例:

[Get("/users/{id}")]
Task<user> GetUserAsync([AliasAs("id")] int userId);
</user>

注册 Refit 服务时必须传入配置好的 HttpClient 实例,不能只传 BaseAddress

Refit 接口实例由 RestService.For(HttpClient) 创建,而这个 HttpClient 需提前配置好 BaseAddress、超时、认证头等 —— 直接 new HttpClient() 再传进去,容易引发 DNS 缓存、连接泄漏等问题。

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载
  • ASP.NET Core 中推荐用 IHttpClientFactory 注册命名客户端:services.AddRefitClient().ConfigureHttpClient(c => c.BaseAddress = new Uri("https://api.example.com/"));
  • 手动创建时务必设置 BaseAddress,否则所有 URL 被当作绝对地址,[Get("/users")] 会请求 http://users
  • 如果需要 bearer token,别在每个接口方法里加 header,统一用 AddHttpMessageHandler()

反序列化失败常因 JSON 字段名不匹配,优先用 [JsonPropertyName] 而非 [AliasAs]

[AliasAs] 只影响 URL 路径或查询参数的变量名映射(比如把 C# 的 userId 映射为 URL 中的 user_id),不影响 JSON body 或响应体字段。JSON 字段名不一致导致 User.Name 始终为 null,真正该用的是 System.Text.Json.Serialization.JsonPropertyNameAttribute。

  • 服务端返回 {"user_name": "leo"},但你的类写 public string Name { get; set; } → 必须加 [JsonPropertyName("user_name")]
  • 用了 Newtonsoft.Json?换用 [JsonProperty("user_name")],并确保 Refit 初始化时传入 new RefitSettings(new NewtonsoftJsonContentSerializer())
  • 嵌套对象、数组、null 值处理异常?打开 SystemTextJsonSettings.PropertyNamingPolicy = JsonNamingPolicy.CamelCase 可覆盖全局行为

调试 401/404/500 错误时,先确认 Refit 是否发出了请求

Refit 本身不打印日志,HTTP 层错误(如 401)会直接抛出 ApiException,但你可能根本没捕获到 —— 因为默认它包装在 InnerException 里,且 Status、Content 都藏在 ApiResponse 中。

  • 想看原始请求/响应:给 HttpClient 加 LoggingHandler(.NET 6+ 自带 ConsoleLoggingHandler)
  • 捕获异常时别只写 catch (Exception ex),要 catch (ApiException ex) when (ex.StatusCode == HttpStatusCode.Unauthorized)
  • 404 不一定是路径错 —— Refit 默认不发送 Content-Type header,POST JSON 时若服务端严格校验,会直接拒收,需显式加 [Headers("Content-Type: application/json")]

最易被忽略的一点:Refit 生成的代理类是轻量级的,但它背后强依赖 HttpClient 生命周期管理。用完不释放、复用不当、或在 Blazor WebAssembly 里跨组件反复 new Refit 客户端,比序列化问题更早拖垮应用。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关专题

更多
c#是什么意思
c#是什么意思

C#是一种通用的面向对象编程语言,它在.NET框架上运行,可用于开发各种类型的应用程序。本专题为大家提供c#相关的各种文章、以及下载和课程。

2023.08.08

1112

5

什么是c#
什么是c#

C#(读作C Sharp)是一种现代的、通用的、面向对象的编程语言。它由微软公司开发,于2000年首次发布,主要用于开发Windows桌面应用程序、Web应用程序、移动应用程序以及游戏开发等领域。C#是一种类型安全和托管的编程语言,它结合了C++的强大性能和C语言的简单易学特点,并引入了许多新的特性和概念,如委托、属性、泛型和异步编程等,以提高开发效率和代码可维护性。

2023.08.31

3271

3

C#中base关键字的用法
C#中base关键字的用法

在C#中,base关键字用于访问当前类的基类成员,这包括基类的字段、属性、方法、构造函数、索引器以及事件。想了解更多C#的相关内容,可以阅读本专题下面的文章。

2024.03.13

925

8

C#Task用法
C#Task用法

Task在C#中是用于表示异步操作的对象,它位于System.Threading.Tasks命名空间中。想了解更多C#中各种用法的相关内容,可以阅读本专题下面的文章。

2024.03.14

2655

11

C# 并发与异步编程
C# 并发与异步编程

本专题系统讲解 C# 异步编程与并发控制,重点介绍 async 和 await 关键字、Task 类、线程池管理、并发数据结构、死锁与线程安全问题。通过多个实战项目,帮助学习者掌握 如何在 C# 中编写高效的异步代码,提升应用的并发性能与响应速度。

2026.02.03

352

18

C# 多线程与异步编程
C# 多线程与异步编程

本专题深入讲解 C# 中多线程与异步编程的核心概念与实战技巧,包括线程池管理、Task 类的使用、async/await 异步编程模式、并发控制与线程同步、死锁与竞态条件的解决方案。通过实际项目,帮助开发者掌握 如何在 C# 中构建高并发、低延迟的异步系统,提升应用性能和响应速度。

2026.02.06

429

20

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

2026.03.11

631

24

C# Unity游戏开发与ECS架构实践
C# Unity游戏开发与ECS架构实践

本专题聚焦 C# 在 Unity 游戏开发中的应用,系统讲解 ECS(Entity-Component-System)架构设计、游戏对象管理、性能优化与内存控制策略。通过实际游戏案例,帮助开发者构建高性能、结构清晰的游戏系统,提高游戏开发效率与运行性能。

2026.04.13

329

20

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习