0

0

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

星降

星降

发布时间:2026-01-25 12:12:12

|

111人浏览过

|

来源于php中文网

原创

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

c# 调用api方法 c#如何实现调用web api

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 里,也不要在查询参数中传。

Android JNI开发入门与提高 中文WORD版
Android JNI开发入门与提高 中文WORD版

本文档主要讲述的是Android JNI开发入门与提高;JNI在Android系统中有着广泛的应用。Android系统底层都是C/C++实现的,上层提供的API都是Java的,Java通过JNI调用底层的实现。比如:Android API多媒体接口MediaPlayer类,其实底层通过JNI调用libmedia库。希望本文档会给有需要的朋友带来帮助;感兴趣的朋友可以过来看看

下载
  • 设置方式: 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 刷新、错误重试、超时分级、日志追踪——这些细节不压到具体场景里反复调,很容易在线上突然崩一下。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

417

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

535

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

311

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

76

2025.09.10

curl_exec
curl_exec

curl_exec函数是PHP cURL函数列表中的一种,它的功能是执行一个cURL会话。给大家总结了一下php curl_exec函数的一些用法实例,这个函数应该在初始化一个cURL会话并且全部的选项都被设置后被调用。他的返回值成功时返回TRUE, 或者在失败时返回FALSE。

439

2023.06.14

linux常见下载安装工具
linux常见下载安装工具

linux常见下载安装工具有APT、YUM、DNF、Snapcraft、Flatpak、AppImage、Wget、Curl等。想了解更多linux常见下载安装工具相关内容,可以阅读本专题下面的文章。

175

2023.10.30

登录token无效
登录token无效

登录token无效解决方法:1、检查token的有效期限,如果token已经过期,需要重新获取一个新的token;2、检查token的签名,如果签名不正确,需要重新获取一个新的token;3、检查密钥的正确性,如果密钥不正确,需要重新获取一个新的token;4、使用HTTPS协议传输token,建议使用HTTPS协议进行传输 ;5、使用双因素认证,双因素认证可以提高账户的安全性。

6112

2023.09.14

登录token无效怎么办
登录token无效怎么办

登录token无效的解决办法有检查Token是否过期、检查Token是否正确、检查Token是否被篡改、检查Token是否与用户匹配、清除缓存或Cookie、检查网络连接和服务器状态、重新登录或请求新的Token、联系技术支持或开发人员等。本专题为大家提供token相关的文章、下载、课程内容,供大家免费下载体验。

816

2023.09.14

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

45

2026.01.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.5万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号