C# 调用API方法 C#如何实现调用Web API

最稳妥方式是复用单例 HttpClient 并设置 BaseAddress,异步调用 GetAsync/PostAsJsonAsync,检查 IsSuccessStatusCode,Bearer 认证设 DefaultRequestHeaders,合理配置超时与异常处理。

HttpClient 发起 GET 请求最稳妥

直接实例化 HttpClient 是最常用也最可控的方式,避免使用已弃用的 WebClient 或过时的 HttpWebRequest。注意不要为每次请求都新建 HttpClient 实例——它本就是线程安全、设计为长期复用的。

  • 推荐在类级别或依赖注入容器中声明单例或作用域生命周期的 HttpClient
  • 设置 BaseAddress 可简化后续请求路径拼接
  • 务必用 await 等待 GetAsyncPostAsJsonAsync 等异步方法,否则可能引发死锁(尤其在 WinForms/WPF 同步上下文中)
  • 检查 HttpResponseMessage.IsSuccessStatusCode 再读取内容,避免对 4xx/5xx 响应直接调用 ReadAsStringAsync() 导致异常
var client = new HttpClient { BaseAddress = new Uri("https://api.example.com/") };
var response = await client.GetAsync("v1/users/123");
if (response.IsSuccessStatusCode)
{
    var json = await response.Content.ReadAsStringAsync();
    // 解析 json
}

POST JSON 数据要用 PostAsJsonAsync 或手动构造 StringContent

.NET 5+ 的 HttpClient 扩展方法 PostAsJsonAsync 自动序列化对象并设好 Content-Type: application/json,省去手动处理。若用低版本 .NET 或需精细控制(如自定义序列化选项),则需用 StringContent + JsonSerializer.Serialize

  • PostAsJsonAsync 要求引用 System.Net.Http.Json NuGet 包(.NET Core 3.1+ 默认包含)
  • 手动构造时,必须显式指定 UTF-8 编码:new StringContent(json, Encoding.UTF8, "application/json")
  • 别漏掉 await —— PostAsJsonAsync 是异步方法,返回 Task
var user = new { Name = "Alice", Email = "a@example.com" };
var response = await client.PostAsJsonAsync("v1/users", user);
// 或手动方式(兼容更老版本)
var json = JsonSerializer.Serialize(user);
var content = new StringContent(json

, Encoding.UTF8, "application/json"); response = await client.PostAsync("v1/users", content);

处理认证:Bearer Token 最常见,加在 Authorization 请求头

绝大多数现代 Web API 使用 Bearer Token 认证。Token 通常来自登录接口返回,之后所有请求需在请求头中带上 Authorization: Bearer xxx。别把它拼在 URL 里,也不要在查询参数中传。

  • 设置方式: client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token)
  • 如果 token 会刷新(如 OAuth2),建议封装一个带自动续期逻辑的 DelegatingHandler,而不是每次请求前手动重设
  • 调试时可用 Fiddler 或 curl -H "Authorization: Bearer xxx" ... 验证 token 是否有效

超时和异常不能只靠 try-catch

HttpClient 默认超时是 100 秒,生产环境通常要调短(比如 15–30 秒)。仅用 try/catch 捕获 HttpRequestException 不够——网络中断、DNS 失败、连接被拒绝等底层错误可能抛出不同异常类型,甚至触发 OperationCanceledException(超时本质是 CancellationToken 触发)。

  • 通过 client.Timeout = TimeSpan.FromSeconds(15); 设置全局超时
  • 更灵活的做法是用 CancellationTokenSource 控制单次请求超时,并在 catch 块中区分 OperationCanceledException(很可能是超时)和 HttpRequestException(HTTP 层错误)
  • 注意:超时后 HttpClient 会主动取消请求,但连接可能仍处于挂起状态,不主动 dispose 可能导致端口耗尽
实际用起来,最难的往往不是“怎么发请求”,而是“怎么稳住请求”:连接复用、token 刷新、错误重试、超时分级、日志追踪——这些细节不压到具体场景里反复调,很容易在线上突然崩一下。