把 JSON 转换成用于 System.Text.Json 的 C# 类。属性名会转成 PascalCase,每个属性都带有 [JsonPropertyName] 特性,从而精确绑定到原始 key。
编写 ASP.NET Core 的请求和响应模型、为调用外部 API 的 HttpClient.GetFromJsonAsync<T>() 准备类型,或者在 Unity、MAUI 应用中定义数据类时,都能省去逐个复制敲字的功夫。
类型名 中输入根类的名称(例如 PaymentResult)。.cs 文件,并加上你的 namespace。JsonSerializer.Deserialize<PaymentResult>(json) 或 GetFromJsonAsync<PaymentResult>(url) 使用。{
"paymentId": "pay_8f2k",
"amount": 15000,
"currency": "KRW",
"approved": true,
"approvedAt": "2024-05-01T12:30:00Z",
"card": { "issuer": "VISA", "last4": "4242" },
"metadata": null
}using System.Collections.Generic;
using System.Text.Json;
using System.Text.Json.Serialization;
public class PaymentResult
{
[JsonPropertyName("paymentId")]
public string PaymentId { get; set; } = string.Empty;
[JsonPropertyName("amount")]
public int Amount { get; set; }
[JsonPropertyName("currency")]
public string Currency { get; set; } = string.Empty;
[JsonPropertyName("approved")]
public bool Approved { get; set; }
[JsonPropertyName("approvedAt")]
public string ApprovedAt { get; set; } = string.Empty;
[JsonPropertyName("card")]
public Card Card { get; set; } = new();
[JsonPropertyName("metadata")]
public JsonElement? Metadata { get; set; }
}
public class Card
{
[JsonPropertyName("issuer")]
public string Issuer { get; set; } = string.Empty;
[JsonPropertyName("last4")]
public string Last4 { get; set; } = string.Empty;
}
每个属性都有 [JsonPropertyName],所以无论大小写规则如何,paymentId ↔ PaymentId 都能匹配。metadata 始终为 null,类型未知,因此变成 JsonElement?。字符串和对象属性带有 string.Empty / new() 初始化器,代码编译时不会出现可空性警告。
[JsonPropertyName("originalKey")],并包含 using System.Text.Json.Serialization;。string、int,超过 32 位的整数为 long,小数为 double,bool,数组为 List<T>。JsonElement,并添加 using System.Text.Json;。null 的属性变成可空类型(int?、string?)。= string.Empty; 或 = new(); 初始化器,以避免可空引用警告 CS8618。Value 后缀(例如 RootValue)。// Root: List<RootItem> 注释和元素类。转换支付或物流追踪 API 的示例响应,把它用作 await http.GetFromJsonAsync<PaymentResult>(url) 中的类型,而不是从 JsonDocument 里一个个取字段。
根据第三方服务推送过来的 payload 生成类,并作为 [FromBody] 参数接收,模型绑定和校验就能照常工作。
用类固定 Unity 或控制台应用读取的 JSON 数据文件的结构,数据文件一旦改动,就会立即以反序列化错误的形式暴露出来。
[JsonProperty])的输出。如果使用 Json.NET,请把特性改成 [JsonProperty("key")]。string。对于 ISO 8601 值,把类型改成 DateTime 或 DateTimeOffset,System.Text.Json 就能解析。new() 和 string? 要求 C# 9+ 并开启可空上下文(自 .NET 6 起为默认)。record 或 required。需要不可变模型时,请把 { get; set; } 改成 { get; init; }。[JsonPropertyName]?System.Text.Json 默认区分大小写。在没有自定义 JsonSerializerOptions 的控制台或 worker 项目中,paymentId 无法绑定到 PaymentId,所以总是写上这个特性,以便不依赖配置也能工作。
JsonElement? 属性?先检查 ValueKind,再使用 GetString()、GetInt32() 或 Deserialize<T>()。一旦知道了真实类型,用它替换 JsonElement 会更清晰。
输出遵循 C# 的 PascalCase 约定。原始 key 保存在 [JsonPropertyName] 中,所以只要保留该特性,属性名可以随意修改。
JsonUtility 只处理 [Serializable] 类的 public 字段而不处理属性,并且会忽略 [JsonPropertyName]。在 Unity 中,请改为搭配 Newtonsoft.Json 包或 System.Text.Json 使用输出。