如何为WinForms中的HttpClient设置默认JSON序列化配置？

我之前也碰到过一模一样的情况——明明全局配置了JsonSerializerSettings，显式用JsonConvert的时候好好的，但HttpClient的GetAsync/PostAsJsonAsync这类调用就是不生效，还抛出类型转换异常。核心原因其实很简单：HttpClient的原生扩展方法有自己独立的序列化体系，不会自动继承你给JsonConvert设置的全局配置。

下面分两种常见场景给你具体的解决方案：

场景1：使用Microsoft.AspNet.WebApi.Client包的扩展方法 #

如果你项目里用的是这个老版本的Web API客户端扩展（比如经典的PostAsJsonAsync），那需要给HttpClient的媒体格式化器指定自定义的JsonSerializerSettings：

1. 单HttpClient实例配置 #

// 先定义你的自定义序列化配置，比如加上NodaTime的转换器
var customJsonSettings = new JsonSerializerSettings
{
    Converters = { new NodaTime.Serialization.JsonNet.LocalDateTimeConverter() },
    DateFormatHandling = DateFormatHandling.IsoDateFormat,
    // 其他你需要的配置项
};

// 创建HttpClient并替换默认的Json格式化器
var httpClient = new HttpClient();
var jsonFormatter = new JsonMediaTypeFormatter
{
    SerializerSettings = customJsonSettings
};

// 调用的时候使用带格式化器参数的重载
var response = await httpClient.PostAsync("api/your-endpoint", yourRequestModel, jsonFormatter);
// 反序列化时也要指定这个格式化器
var responseModel = await response.Content.ReadAsAsync<YourResponseModel>(new[] { jsonFormatter });

2. 全局配置（所有HttpClient实例生效） #

如果想让整个应用的HttpClient都用这套配置，可以在应用启动时（比如Program.cs或者主窗体的构造函数里）设置：

GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings = customJsonSettings;

场景2：使用System.Net.Http.Json包的现代扩展方法 #

如果你的项目用的是.NET Core/.NET 5+自带的System.Net.Http.Json扩展（比如GetFromJsonAsync、PostAsJsonAsync），那它默认用的是System.Text.Json，和Newtonsoft.Json是两套体系，得单独配置：

方式一：给每个请求指定JsonSerializerOptions #

如果你想继续用System.Text.Json，可以配置对应的选项并传入：

var jsonOptions = new JsonSerializerOptions
{
    Converters = { new NodaTime.Serialization.SystemTextJson.LocalDateTimeConverter() },
    PropertyNameCaseInsensitive = true,
    // 其他配置
};

// 调用时传入选项
var responseModel = await httpClient.GetFromJsonAsync<YourResponseModel>("api/your-endpoint", jsonOptions);
var postResponse = await httpClient.PostAsJsonAsync("api/your-endpoint", yourRequestModel, jsonOptions);

方式二：封装自定义扩展，用Newtonsoft.Json序列化 #

如果你更习惯Newtonsoft.Json的配置，可以自己写一套扩展方法，让它复用你已经设置好的JsonConvert全局配置：

// 自定义Post扩展
public static async Task<HttpResponseMessage> PostAsNewtonsoftJsonAsync<T>(this HttpClient client, string requestUri, T value, JsonSerializerSettings settings = null)
{
    // 优先用传入的配置，没有就用全局默认
    var json = JsonConvert.SerializeObject(value, settings ?? JsonConvert.DefaultSettings?.Invoke());
    var content = new StringContent(json, Encoding.UTF8, "application/json");
    return await client.PostAsync(requestUri, content);
}

// 自定义反序列化扩展
public static async Task<T> ReadAsNewtonsoftJsonAsync<T>(this HttpContent content, JsonSerializerSettings settings = null)
{
    var json = await content.ReadAsStringAsync();
    return JsonConvert.DeserializeObject<T>(json, settings ?? JsonConvert.DefaultSettings?.Invoke());
}

之后调用的时候就和原生扩展一样方便，而且会自动用你全局配置的JsonSerializerSettings：

// 先设置全局默认（你之前已经做过的步骤）
JsonConvert.DefaultSettings = () => new JsonSerializerSettings
{
    Converters = { new NodaTime.Serialization.JsonNet.LocalDateTimeConverter() },
    // 其他配置
};

// 调用自定义扩展
var postResponse = await httpClient.PostAsNewtonsoftJsonAsync("api/your-endpoint", yourRequestModel);
var responseModel = await postResponse.Content.ReadAsNewtonsoftJsonAsync<YourResponseModel>();

最后再总结下原因 #

你之前显式用JsonConvert有效，是因为JsonConvert.SerializeObject/DeserializeObject会直接读取JsonConvert.DefaultSettings；但HttpClient的扩展方法不管是老版本还是新版本，都有自己的序列化配置逻辑，不会自动关联JsonConvert的全局设置，这就是导致NodaTime类型转换失败的根本原因。

内容的提问来源于stack exchange，提问作者Lars335