I-convert ang JSON sa C# class!

Maglagay ng JSON para gumawa ng C# class code, kasama ang mga nested object! Sinusuportahan ang System.Text.Json [JsonPropertyName], .NET, ASP.NET Core.
JSON
Resulta
 

I-convert ang JSON sa C# class!

I-convert ang JSON sa mga C# class para sa System.Text.Json. Ginagawang PascalCase ang mga property name, at may [JsonPropertyName] attribute ang bawat property para mag-bind ito sa eksaktong orihinal na key.

Hindi mo na kailangang kumopya at mag-type nang mano-mano para sa mga ASP.NET Core request at response model, mga type para sa mga HttpClient.GetFromJsonAsync<T>() call sa external API, at mga data class sa Unity o MAUI app.

Paano gamitin

  1. I-paste ang isang JSON response o configuration file.
  2. Ilagay sa Pangalan ng type ang pangalan ng root class (halimbawa PaymentResult).
  3. Ilagay ang mga na-generate na class sa isang .cs file at idagdag ang namespace mo.
  4. Gamitin ito kasama ang JsonSerializer.Deserialize<PaymentResult>(json) o GetFromJsonAsync<PaymentResult>(url).

Halimbawa

Input (JSON)
{
  "paymentId": "pay_8f2k",
  "amount": 15000,
  "currency": "KRW",
  "approved": true,
  "approvedAt": "2024-05-01T12:30:00Z",
  "card": { "issuer": "VISA", "last4": "4242" },
  "metadata": null
}
Output (C# · System.Text.Json)
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;
}

May [JsonPropertyName] ang bawat property, kaya tugma ang paymentId ↔ PaymentId anuman ang casing rules. Laging null lang ang metadata, kaya hindi alam ang type nito at nagiging JsonElement?. May initializer na string.Empty / new() ang mga string at object property para mag-compile ang code nang walang nullable warning.

Mga sinusuportahang feature

  • [JsonPropertyName("originalKey")] sa bawat property, kasama ang using System.Text.Json.Serialization;.
  • Mga type: string, int, long para sa mga integer na lampas sa 32 bits, double para sa decimal, bool, at List<T> para sa mga array.
  • Nagiging JsonElement ang mga value na halo o hindi alam ang type, at idinadagdag ang using System.Text.Json;.
  • Nagiging nullable (int?, string?) ang mga property na wala sa ilang item o may laman na null.
  • May initializer na = string.Empty; o = new(); ang mga required na property para maiwasan ang nullable reference warning na CS8618.
  • Hindi pinapayagan sa C# ang property na kapangalan ng class nito, kaya nilalagyan ito ng suffix na Value (hal. RootValue).
  • Kapag array ang top level, may comment na // Root: List<RootItem> at ang class ng element.

Mga gamit

Pagtawag ng external API gamit ang HttpClient

I-convert ang isang sample response mula sa payment o shipment-tracking API at gamitin ito bilang type sa await http.GetFromJsonAsync<PaymentResult>(url), sa halip na isa-isang kunin ang mga field mula sa isang JsonDocument.

Mga webhook payload model sa ASP.NET Core

Gumawa ng mga class mula sa payload na ipinapadala sa iyo ng isang third-party service at tanggapin sila bilang [FromBody] parameter, para gumana gaya ng dati ang model binding at validation.

appsettings at mga game data file

Kapag naka-pin sa mga class ang istruktura ng JSON data file na binabasa ng isang Unity o console app, agad na lumalabas bilang deserialization error ang nagbagong data file.

Mga paalala at limitasyon

  • Hindi ginagawa ang output para sa Newtonsoft.Json ([JsonProperty]). Kung Json.NET ang gamit mo, palitan ang mga attribute ng [JsonProperty("key")].
  • Nananatiling string ang mga date string. Para sa mga ISO 8601 value, sapat nang palitan ang type ng DateTime o DateTimeOffset para ma-parse sila ng System.Text.Json.
  • Ipinapalagay ng target-typed na new() at string? ang C# 9+ na naka-enable ang nullable context (default mula .NET 6).
  • Walang output na record o required. Para sa mga immutable model, palitan ang { get; set; } ng { get; init; }.
  • Nasa iisang block ang lahat ng class; ikaw na ang maghati sa mga file at namespace.

Mga madalas itanong

Bakit naglalagay ng [JsonPropertyName] kahit tugma na ang key?

Case-sensitive ang System.Text.Json bilang default. Sa mga console o worker project na walang custom na JsonSerializerOptions, hindi magba-bind ang paymentId sa PaymentId, kaya laging isinusulat ang attribute para gumana anuman ang configuration.

Paano ko babasahin ang isang JsonElement? property?

I-check ang ValueKind, saka gamitin ang GetString(), GetInt32() o Deserialize<T>(). Kapag alam mo na ang totoong type, mas malinis na palitan ang JsonElement nito.

Puwede ko bang panatilihing camelCase ang mga property name?

Sinusunod ng output ang PascalCase convention ng C#. Nasa [JsonPropertyName] ang orihinal na key, kaya malaya mong mapapalitan ang pangalan ng mga property basta't nandoon pa rin ang attribute.

Gumagana ba ito sa JsonUtility ng Unity?

Mga public field lang ng mga [Serializable] class ang hinahawakan ng JsonUtility, hindi mga property, at hindi nito pinapansin ang [JsonPropertyName]. Sa Unity, ipares ang output sa Newtonsoft.Json package o sa System.Text.Json.