RestSharp 是一个用于与 RESTful Web 服务进行通信的 .NET 客户端库。它提供了一种简单而灵活的方式来构建 HTTP 请求并处理响应。下面是使用 RestSharp 的一般步骤以及几个常见用例的详细示例。
- 安装 RestSharp：
在 Visual Studio 中，你可以使用 NuGet 包管理器来安装 RestSharp。打开你的项目，点击“项目”->“管理 NuGet 包”->搜索“RestSharp”->点击“安装”。
2. 创建 RestSharp 客户端实例：
在使用 RestSharp 发送请求之前，你需要创建一个 RestClient 实例。
var client = new RestClient("http://example.com");
- 发送 HTTP 请求：
RestSharp 允许你发送各种 HTTP 请求，如 GET、POST、PUT 和 DELETE。
var request = new RestRequest(Method.GET);
var response = client.Execute(request);
- 处理响应：
你可以从响应对象中获取 HTTP 状态码、响应内容等信息。
if (response.StatusCode == HttpStatusCode.OK)
{
var content = response.Content; // 响应内容
// 处理内容...
}
- 使用查询参数：
你可以使用 RestSharp 的 AddQueryParameter 方法添加查询参数。
var request = new RestRequest(Method.GET);
request.AddQueryParameter("name", "John");
request.AddQueryParameter("age", "30");
var response = client.Execute(request);
- 发送 POST 请求：
发送 POST 请求时，你通常要发送一些数据。你可以使用 AddParameter 方法来添加 POST 参数。
var request = new RestRequest(Method.POST);
request.AddParameter("application/json", "{\"name\":\"John\", \"age\":30}", ParameterType.RequestBody);
var response = client.Execute(request);
- 处理 JSON 响应：
如果响应是 JSON 格式，你可以使用 RestSharp 的 Deserialize 方法将其解析为对象。
if (response.StatusCode == HttpStatusCode.OK)
{
var myObject = response.Deserialize(); // MyObject 是你的类型
// 处理 myObject...
}
- 错误处理：
你可以通过检查响应状态码来确定请求是否成功。此外，你还可以通过捕获异常来处理错误。
try
{
var response = client.Execute(request);
if (response.StatusCode != HttpStatusCode.OK)
{
// 处理错误...
}
}
catch (Exception ex)
{
// 处理异常...
}
- 使用自定义 HTTP 头：
如果你需要与服务器交换特定的 HTTP 头，你可以使用 AddHeader 方法。
request.AddHeader("Authorization", "Bearer your_token_here");
- 处理文件上传和下载： RestSharp 支持文件上传和下载。你只需要使用 MultipartFormDataContent 类来上传文件，使用 HttpClient 请求来下载文件。
// 上传文件
var client = new RestClient();
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "multipart/form-data");
var content = new MultipartFormDataContent();
content.Add(new StringContent("your text here"), "text_field");
content.Add(new ByteArrayContent(fileBytes), "file_field", "filename.jpg");
request.Content = content;
var response = client.Execute(request);
// 下载文件
var client = new RestClient("http://example.com");
var request = new RestRequest(Method.GET);
request.ResponseContentType = MediaType.Parse("application/octet-stream"); // parse from response header
var response = client.Execute(request);
var byteArray = response.Data; // a byte array containing the response data
- 异步操作： 如果你想要进行异步操作以提高性能，你可以使用 .NET 的异步方法，如 Task.Run，与 RestSharp 配合使用。
// 异步 GET 请求
var client = new RestClient("http://example.com");
var request = new RestRequest(Method.GET);
var asyncHandle = client.ExecuteAsync(request, response =>
{
if (response.IsSuccessful)
{
// 处理响应数据
}
else
{
// 处理错误
}
});
12.取消请求： 如果你在发送请求后想要取消它（例如，如果用户在长时间不响应的情况下取消了请求），你可以使用 CancellationToken。
var token = new CancellationTokenSource();
var client = new RestClient();
var request = new RestRequest(Method.GET);
token.Cancel(); // 取消请求
以上只是 RestSharp 支持功能的一部分。你可以根据实际需求进一步探索其更多的功能和用法。