Tukar JSON kepada class C#!

Masukkan JSON untuk menjana kod class C#, termasuk objek bersarang! Menyokong System.Text.Json [JsonPropertyName], .NET, ASP.NET Core.
JSON
Hasil
 

Tukar JSON kepada class C#!

Tukar JSON kepada kelas C# untuk System.Text.Json. Nama property ditukar kepada PascalCase, dan setiap property membawa attribute [JsonPropertyName] supaya ia bind tepat kepada kunci asal.

Ia menjimatkan kerja menyalin dan menaip untuk model request dan response ASP.NET Core, jenis bagi panggilan HttpClient.GetFromJsonAsync<T>() ke API luar, dan kelas data dalam aplikasi Unity atau MAUI.

Cara menggunakan

  1. Tampal response JSON atau fail konfigurasi.
  2. Masukkan nama kelas akar dalam Nama jenis (contohnya PaymentResult).
  3. Letakkan kelas yang dijana ke dalam fail .cs dan tambah namespace anda.
  4. Gunakannya dengan JsonSerializer.Deserialize<PaymentResult>(json) atau GetFromJsonAsync<PaymentResult>(url).

Contoh

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;
}

Setiap property mempunyai [JsonPropertyName], jadi paymentId ↔ PaymentId sepadan tanpa mengira peraturan huruf besar kecil. metadata hanya pernah bernilai null, jadi jenisnya tidak diketahui dan ia menjadi JsonElement?. Property string dan objek mendapat initializer string.Empty / new() supaya kod boleh di-compile tanpa amaran nullable.

Ciri yang disokong

  • [JsonPropertyName("originalKey")] pada setiap property, bersama using System.Text.Json.Serialization;.
  • Jenis: string, int, long untuk integer melebihi 32 bit, double untuk perpuluhan, bool, dan List<T> untuk array.
  • Nilai yang jenisnya bercampur atau tidak diketahui menjadi JsonElement, dengan tambahan using System.Text.Json;.
  • Property yang tiada dalam sesetengah item atau mengandungi null menjadi nullable (int?, string?).
  • Property wajib mendapat initializer = string.Empty; atau = new(); untuk mengelakkan amaran nullable reference CS8618.
  • Property yang sama nama dengan kelasnya tidak dibenarkan dalam C#, jadi ia diberi akhiran Value (cth. RootValue).
  • Array peringkat atas menghasilkan komen // Root: List<RootItem> dan kelas elemennya.

Kes penggunaan

Memanggil API luar dengan HttpClient

Tukar sampel response daripada API pembayaran atau penjejakan penghantaran dan gunakannya sebagai jenis dalam await http.GetFromJsonAsync<PaymentResult>(url), daripada menarik field satu demi satu keluar dari JsonDocument.

Model payload webhook dalam ASP.NET Core

Jana kelas daripada payload yang dihantar oleh perkhidmatan pihak ketiga kepada anda dan terimanya sebagai parameter [FromBody], supaya model binding dan validasi berfungsi seperti biasa.

appsettings dan fail data permainan

Mengikat struktur fail data JSON yang dibaca oleh aplikasi Unity atau console kepada kelas bermakna fail data yang berubah akan terus kelihatan sebagai ralat deserialization.

Nota dan had

  • Output Newtonsoft.Json ([JsonProperty]) tidak dijana. Jika anda menggunakan Json.NET, tukar attribute kepada [JsonProperty("key")].
  • String tarikh kekal sebagai string. Untuk nilai ISO 8601, menukar jenisnya kepada DateTime atau DateTimeOffset sudah memadai untuk System.Text.Json men-parse-nya.
  • new() target-typed dan string? mengandaikan C# 9+ dengan nullable context dihidupkan (lalai sejak .NET 6).
  • Tiada output record atau required. Untuk model immutable, tukar { get; set; } kepada { get; init; }.
  • Semua kelas dikeluarkan dalam satu blok; pecahkan fail dan namespace sendiri.

Soalan lazim

Kenapa tambah [JsonPropertyName] walaupun kunci sudah sepadan?

System.Text.Json peka huruf besar kecil secara lalai. Dalam projek console atau worker tanpa JsonSerializerOptions tersuai, paymentId tidak akan bind kepada PaymentId, jadi attribute ini sentiasa ditulis supaya ia berfungsi tanpa mengira konfigurasi.

Bagaimana saya membaca property JsonElement??

Semak ValueKind, kemudian gunakan GetString(), GetInt32() atau Deserialize<T>(). Apabila anda tahu jenis sebenarnya, menggantikan JsonElement dengan jenis itu ialah pilihan yang lebih kemas.

Bolehkah saya mengekalkan nama property dalam camelCase?

Output mengikut konvensyen PascalCase C#. Kunci asal disimpan dalam [JsonPropertyName], jadi anda bebas menamakan semula property selagi attribute itu kekal.

Adakah ia berfungsi dengan JsonUtility Unity?

JsonUtility hanya mengendalikan field public dalam kelas [Serializable], bukan property, dan mengabaikan [JsonPropertyName]. Dalam Unity, gunakan output ini bersama package Newtonsoft.Json atau System.Text.Json.