使用System.Net.Http.Json简化HttpClient的使用

Intro

从 .NET Core 3.1 开始，微软添加了一个 System.Net.Http.Json 的扩展，可以用来简化 HttpClient 的使用，看到在很多项目里还并未开始使用，所以想向大家介绍一下.

Sample

PostAsJson/PutAsJson

PostAsJson sample：

const string url = "http://localhost:5000/api/values";
using var httpClient = new HttpClient();

using var response = await httpClient.PostAsJsonAsync(url, new Category()
{
    Id = 1,
    Name = "Test"
});
response.EnsureSuccessStatusCode();

PutAsJson:

using var response = await httpClient.PutAsJsonAsync(url, new Category()
{
    Id = 1,
    Name = "Test"
});
response.EnsureSuccessStatusCode();

简单来说就是会把一个对象变成 JSON request body

目前支持 Post 和 Put 方法默认的序列化方式和 ASP.NET Core 是一致的，会变成 camalCase, 例如

使用System.Net.Http.Json简化HttpClient的使用

如果要自定义序列化，可以传入一个 JsonSerializerOptions，如：

using var response = await httpClient.PostAsJsonAsync(url, new Category()
{
    Id = 1,
    Name = "Test"
}, new JsonSerializerOptions());
response.EnsureSuccessStatusCode();

使用System.Net.Http.Json简化HttpClient的使用

可以看到这个例子中的 body 和之前有所不同了，这正是因为我们使用了自定义的 JsonSerializerOptions

GetFromJsonAsync

var result = await httpClient.GetFromJsonAsync<ResultModel>(url);
ArgumentNullException.ThrowIfNull(result);
Console.WriteLine($"{result.Status}: {result.ErrorMsg}");

和上面的 AsJson 相对应，这个是从 Response body 到一个对象，同样地也支持自定义 JsonSerializerOptions，可以自己尝试一下

ReadFromJsonAsync

using var response = await httpClient.PutAsJsonAsync(url, new Category()
{
    Id = 1,
    Name = "Test"
});
response.EnsureSuccessStatusCode();
var result = await response.Content.ReadFromJsonAsync<ResultModel>();
ArgumentNullException.ThrowIfNull(result);
Console.WriteLine($"{result.Status}: {result.ErrorMsg}");

直接从 HttpContent 中读取 json 对象

JsonContent.Create

using var content = JsonContent.Create(new Category() { Id = 1, Name = "Test" });
using var response = await httpClient.PostAsync(url, content);
response.EnsureSuccessStatusCode();

从一个对象构建 HttpContent ，同样支持自定义序列化