System.Text.Json.Deserialize<TValue> 轉回的物件值都是 null

前言

透過 HttpClient 取得別的 API 結果 Json 字串後，要透過 JsonSerializer.Deserialize 轉回時，
發生該物件的屬性值都為 null 。這是為什麼呢?

研究

這是因為 System.Text.Json 預設的 formatters 是使用 Microsoft.AspNetCore.Mvc.JsonOptions.JsonSerializerOptions ，
而它的預設 format 是使用 camelCase 。 例如，

public class Forecast
{
    public DateTime Date { get; set; }
    public int TemperatureC { get; set; }
    public string Summary { get; set; }
}

預設 Json 的輸出為

{
  "date": "2020-10-21T15:40:06.9040831-07:00",
  "temperatureC": 40,
  "summary": "Hot"
}

這時透過 JsonSerializer.Deserialize 時，因為 JsonSerializerOptions 的 PropertyNameCaseInsensitive 屬性預設是 false ，所以轉回的屬性都會為 null 。

解法

因為 PropertyNameCaseInsensitive 屬性預設是 false ，所以可以將 Class 屬性加上 JsonPropertyName ，或是將 PropertyNamingPolicy 設定為 JsonNamingPolicy.CamelCase 。如果是別人的 Web API ，不確定用什麼格式的話，可以將 PropertyNameCaseInsensitive 設定成 true 。

1.JsonPropertyName

public class Forecast
{
    [JsonPropertyName("date")]
    public DateTime Date { get; set; }

    [JsonPropertyName("temperatureC")]
    public int TemperatureC { get; set; }

    [JsonPropertyName("summary")]
    public string Summary { get; set; }
}

2.PropertyNamingPolicy = JsonNamingPolicy.CamelCase

var response = await httpClient
    .GetAsync(forecastUrl);
if (response.IsSuccessStatusCode)
{
    var responseBody = await response.Content.ReadAsStringAsync();
    var jsonSerializerOptions = new JsonSerializerOptions
    {
        PropertyNamingPolicy = JsonNamingPolicy.CamelCase
    };
    //這裡加入設定 PropertyNamingPolicy = JsonNamingPolicy.CamelCase 的 JsonSerializerOptions
    var weatherForecast = JsonSerializer.Deserialize<Forecast>(
        responseBody, jsonSerializerOptions);
}

3.PropertyNameCaseInsensitive = true

var response = await httpClient
    .GetAsync(forecastUrl);
if (response.IsSuccessStatusCode)
{
    var responseBody = await response.Content.ReadAsStringAsync();
    var jsonSerializerOptions = new JsonSerializerOptions
    {
        PropertyNameCaseInsensitive = true
    };
    //這裡加入設定 PropertyNameCaseInsensitive = true 的 JsonSerializerOptions
    var weatherForecast = JsonSerializer.Deserialize<Forecast>(
        responseBody, jsonSerializerOptions);
}

• 註: 截至目前為止並無設定整個 JsonSerializerOptions 預設值的方式，而暫時解的方式可參考 How to globally set default options for System.Text.Json.JsonSerializer?

參考資料

JsonSerializer.Deserialize fails
JSON Serialization
Format response data in ASP.NET Core Web API
JsonSerializerOptions Class
Api proposal: Change JsonSerializerOptions default settings