跳到主要内容

C# HttpClient类

介绍​

在现代应用程序开发中，与网络服务进行交互是一个常见的需求。无论是从 API 获取数据，还是向服务器发送数据，都需要使用 HTTP 协议进行通信。C# 提供了 HttpClient 类，它是一个强大的工具，用于发送 HTTP 请求并接收 HTTP 响应。

HttpClient 类是 .NET 中用于处理 HTTP 请求的主要类之一。它支持异步操作，能够高效地处理多个请求，并且可以配置各种 HTTP 选项，如超时、头部信息等。

创建 HttpClient 实例​

在使用 HttpClient 之前，首先需要创建一个实例。通常，建议将 HttpClient 实例作为单例使用，以避免频繁创建和销毁实例带来的性能开销。

csharp
using System.Net.Http;

HttpClient client = new HttpClient();
备注

注意：在实际应用中，建议将 HttpClient 实例注入到依赖注入容器中，以便在整个应用程序中共享同一个实例。

发送 GET 请求​

HttpClient 提供了 GetAsync 方法，用于发送 HTTP GET 请求。以下是一个简单的示例，展示如何从 API 获取数据：

csharp
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        HttpClient client = new HttpClient();
        string url = "https://jsonplaceholder.typicode.com/posts/1";

        HttpResponseMessage response = await client.GetAsync(url);
        if (response.IsSuccessStatusCode)
        {
            string responseData = await response.Content.ReadAsStringAsync();
            Console.WriteLine(responseData);
        }
        else
        {
            Console.WriteLine($"Error: {response.StatusCode}");
        }
    }
}

输出示例​

json
{
  "userId": 1,
  "id": 1,
  "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
  "body": "quia et suscipit\nsuscipit..."
}

发送 POST 请求​

除了 GET 请求，HttpClient 还可以用于发送 POST 请求。以下示例展示了如何向服务器发送 JSON 数据：

csharp
using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        HttpClient client = new HttpClient();
        string url = "https://jsonplaceholder.typicode.com/posts";
        string jsonData = "{\"title\": \"foo\", \"body\": \"bar\", \"userId\": 1}";

        HttpContent content = new StringContent(jsonData, Encoding.UTF8, "application/json");
        HttpResponseMessage response = await client.PostAsync(url, content);

        if (response.IsSuccessStatusCode)
        {
            string responseData = await response.Content.ReadAsStringAsync();
            Console.WriteLine(responseData);
        }
        else
        {
            Console.WriteLine($"Error: {response.StatusCode}");
        }
    }
}

输出示例​

json
{
  "id": 101,
  "title": "foo",
  "body": "bar",
  "userId": 1
}

处理响应​

HttpClient 的响应通常是一个 HttpResponseMessage 对象。你可以通过 IsSuccessStatusCode 属性检查请求是否成功，并通过 Content 属性获取响应内容。

csharp
HttpResponseMessage response = await client.GetAsync(url);
if (response.IsSuccessStatusCode)
{
    string responseData = await response.Content.ReadAsStringAsync();
    Console.WriteLine(responseData);
}
else
{
    Console.WriteLine($"Error: {response.StatusCode}");
}

实际应用场景​

1. 从 API 获取数据​

假设你正在开发一个天气应用程序，需要从天气 API 获取当前天气信息。你可以使用 HttpClient 发送 GET 请求来获取数据。

csharp
string apiUrl = "https://api.weatherapi.com/v1/current.json?key=YOUR_API_KEY&q=London";
HttpResponseMessage response = await client.GetAsync(apiUrl);

2. 提交表单数据​

如果你正在开发一个 Web 应用程序，用户需要提交表单数据。你可以使用 HttpClient 发送 POST 请求将数据提交到服务器。

csharp
string formData = "username=test&password=123456";
HttpContent content = new StringContent(formData, Encoding.UTF8, "application/x-www-form-urlencoded");
HttpResponseMessage response = await client.PostAsync("https://example.com/login", content);

总结​

HttpClient 是 C# 中用于处理 HTTP 请求的强大工具。通过它，你可以轻松地发送 GET 和 POST 请求，并处理服务器的响应。在实际应用中，HttpClient 可以用于与各种 Web 服务进行交互，如获取数据、提交表单等。

提示

提示：在使用 HttpClient 时，务必注意资源的释放。虽然 HttpClient 实现了 IDisposable 接口，但在大多数情况下，建议将其作为单例使用，以避免频繁创建和销毁实例。

附加资源​

练习​

  1. 使用 HttpClient 从 JSONPlaceholder 获取所有用户的帖子，并打印出每个帖子的标题。
  2. 修改上述代码，使其能够处理分页数据（假设 API 支持分页）。
  3. 创建一个简单的控制台应用程序，允许用户输入用户名和密码，并将其提交到模拟的登录 API。

通过完成这些练习，你将更深入地理解 HttpClient 的使用方法，并能够在实际项目中应用这些知识。