商城首页欢迎来到中国正版软件门户

您的位置:首页 >C#使用RestSharp发送请求详解

C#使用RestSharp发送请求详解

  发布于2026-04-12 阅读(0)

扫一扫,手机访问

RestSharp 初始化必须指定 BaseUrl,否则因空引用或 URI 格式异常崩溃;需显式设 Content-Type 才能正确发送 JSON;同步调用在旧框架易死锁,应 ConfigureAwait(false);非 200 响应默认不反序列化。

c#如何使用RestSharp发送请求_c#RestSharp发送请求深入理解与底层原理

RestSharp 初始化时为什么必须指定 BaseUrl

不设 BaseUrl 会导致所有请求都报 NullReferenceExceptionUriFormatException,因为 RestClient 内部用它拼接完整 URL;即使你传了完整地址(如 "https://api.example.com/v1/users"),底层仍会尝试以 BaseUrl 为根做相对解析,没设就崩。

正确做法是初始化时明确传入基础域名:

var client = new RestClient("https://api.example.com");

后续所有 RestRequest 只需写路径部分:

var request = new RestRequest("/v1/users/{id}");
  • BaseUrl 末尾不加 / —— RestSharp 不会自动补,加了反而可能变成 https://api.example.com//v1/...
  • 若需动态切环境(dev/staging/prod),建议封装工厂方法生成不同 RestClient 实例,别在运行时反复改 BaseUrl
  • RestClient 是线程安全的,但 RestRequest 不是,每次请求必须新建实例

如何正确添加 JSON 请求体并避免 415 Unsupported Media Type

RestSharp 默认不自动设 Content-Type: application/json,即使你调用了 AddJsonBody()。这个行为常被忽略,导致服务端拒收。

必须显式设置请求头或使用带类型推导的方法:

request.AddJsonBody(new { name = "Alice", age = 30 });
request.AddHeader("Content-Type", "application/json");

更稳妥的方式是用 AddJsonBody() 配合 AddParameter() 的重载:

request.AddParameter("application/json", JsonSerializer.Serialize(data), ParameterType.RequestBody);
  • AddJsonBody() 底层调用的是 System.Text.Json(.NET Core 3+)或 Newtonsoft.Json(旧版),取决于你引用的包,不统一容易序列化出错
  • 如果接口要求严格字段顺序或 camelCase,请提前配置 JsonSerializerOptions 并传给 RestClient 构造函数
  • 不要混用 AddJsonBody()AddParameter(..., ParameterType.RequestBody),后者会覆盖前者

同步调用 ExecuteAsync() 却卡死?这是线程上下文陷阱

在 WinForms/WPF 或 ASP.NET Framework(非 Core)中直接 await client.ExecuteAsync(request) 可能死锁,因为默认捕获了 UI 线程或请求上下文,而底层 HttpClient 的完成回调又试图回到该上下文执行,但主线程正等着 await 结果。

根本解法是彻底剥离上下文:

var response = await client.ExecuteAsync(request).ConfigureAwait(false);
  • ASP.NET Core 没这个问题,因它默认无同步上下文(SynchronizationContext)
  • 若必须用同步阻塞(比如老代码没法改 async),请用 .Result 而非 .Wait(),后者更容易引发死锁
  • RestSharp 107+ 已弃用 Execute() 同步方法,强行用会抛 NotSupportedException

响应反序列化失败:为什么 response.Data 总是 null

不是所有 HTTP 成功状态码(2xx)都会触发反序列化——RestSharp 默认只对 200 OK 自动反序列化;遇到 201 Created204 No Content 等,Data 就是 null,哪怕响应体里有 JSON。

解决方式分两种:

  • 手动处理:response.Content 拿原始字符串,再用 JsonSerializer.Deserialize<T>() 解析
  • 扩展自动反序列化范围:通过 RestClientOptions.MaxTimeout 不行,得改 RestRequestOnBeforeDeserialization 回调,或注册自定义 IDeserializer
  • 检查 response.StatusCoderesponse.ContentType —— 如果是 text/plain,RestSharp 根本不会进 JSON 反序列流程

底层原理其实很简单:RestSharp 把反序列化逻辑委托给了 IRestResponse 的泛型约束,而这个约束只在 StatusCode == OKContentType 匹配时才激活。

本文转载于:互联网 如有侵犯,请联系zhengruancom@outlook.com删除。
免责声明:正软商城发布此文仅为传递信息,不代表正软商城认同其观点或证实其描述。

热门关注