ASP.NET Core 3.1 Web API JSON 响应骆驼化超过第一个字符

Question

在我们的 Web API 中，我们有具有缩写名称的旧实体。我们还通过 T4 模板使用代码生成，我们希望让事情保持简单和可预测：

• 模板创建 C# 类并将属性的第一个字符大写
• 模板创建 Angular 代码并将属性的第一个字符小写

然而，来自 Web API 的 JSON 响应在决定将哪些字母转换为小写而不是仅预期的第一个字符方面发挥了一些作用。

例如，在 Visual Studio 中启动新的默认 Web API 并向WeatherForecast.cs 添加两个属性时：

public string TSTValue { get; set; }
public string TSTVL1 { get; set; }

结果是：

[
  {
    ...
    "tstValue":null,
    "tstvL1":null
  },
  {
    ...
    "tstValue":null,
    "tstvL1":null
  }
]

预期/期望的输出将是带有驼峰属性名称的结果：

[
  {
    ...
    "tSTValue":null,
    "tSTVL1":null
  },
  {
    ...
    "tSTValue":null,
    "tSTVL1":null
  }
]

如何覆盖魔术行为？

Answer 1

首先，您描述的行为是有意的。您可以在 Github https://github.com/dotnet/runtime/blob/master/src/libraries/System.Text.Json/src/System/Text/Json/Serialization/JsonCamelCaseNamingPolicy.cs 上查看源代码，幸好名称序列化可以相对轻松地进行自定义。

由于您指定不想使用属性，因此您可以创建自己的 JsonNamingPolicy，它可用于以您认为合适的方式序列化字段名称。

下面我创建了一个基本类，它确保第一个字符是小写的，并且不理会字段字符串的其余部分。 ConvertName(string name) 将为序列化类中的每个字段调用。在您的示例中，TSTValue 和 TSTVL1

public class JsonFirstCharToLowerNamingPolicy : JsonNamingPolicy
{
    public override string ConvertName(string name)
    {
        // if the string is empty or the first character is already lowercase just return as is
        if (string.IsNullOrEmpty(name) || char.IsLower(name[0]))
            return name;

        char[] chars = name.ToCharArray(); // get a list of chars
        chars[0] = char.ToLowerInvariant(chars[0]); // make the first character lower case 

        // leave the rest of the characters alone or do more processing on it?

        return new string(chars); // return the altered string
    }
}

要使用该类，您只需将JsonSerializerOptions 设置为JsonSerializerOptions，如下所示。

var serializeOptions = new JsonSerializerOptions
{
    PropertyNamingPolicy = new JsonFirstCharToLowerNamingPolicy(),
    WriteIndented = true
};
var jsonString = JsonSerializer.Serialize(weatherForecast, serializeOptions);