JSON轉C#

相關推薦

JSON轉C#簡介：將JSON資料轉成可編譯的C# POCO類別

適用場景

• ASP.NET Core Web API：將OpenAPI/Swagger文件中的範例JSON轉成DTO類別，搭配[FromBody]模型繫結接收前端請求
• ASP.NET Core MVC：將表單/JSON請求本體轉成強型別Model，搭配ModelState自動驗證使用
• Newtonsoft.Json反序列化：將第三方介面回應JSON轉成帶[JsonProperty]的POCO類別，無需手動對應欄位
• System.Text.Json高效能場景：將JSON轉成record型別或init-only屬性，搭配JsonSerializer.Deserialize<T>提升啟動速度
• Unity遊戲指令碼：將網路API回傳的JSON（玩家資料、關卡設定、商店物品、排行榜）轉成可序列化的ScriptableObject資料模型
• .NET MAUI跨平台應用：將後端API JSON轉成Model類別，在XAML資料繫結中使用，iOS/Android/Windows共用業務模型
• Blazor Server / WebAssembly：將API JSON轉成強型別元件參數/伺服器模型，搭配@inject HttpClient在前端/後端共享型別消費
• Entity Framework Core：將從資料庫匯出的JSON文件轉成實體類別，作為EF Core模型移轉的參考基礎類別，搭配[Key]/[Required]等資料註解使用
• Azure Functions / AWS Lambda：將Event Grid/SNS/API Gateway/Cosmos DB觸發事件的JSON轉成強型別事件參數，簡化無伺服器函式簽章
• SignalR即時通訊：將伺服器推送的JSON訊息（聊天、通知、行情、IoT資料）轉成C#型別，在Hub方法中以強型別消費
• 微服務介面契約：將服務間RPC（gRPC-Web/HTTP/WCF）的JSON請求/回應範例轉成C#類別，作為多團隊共享契約定義
• 組態檔載入：將appsettings.json子結構轉成Options模式類別（例如MyOptions : IOptions<MyOptions>搭配IConfiguration.Bind使用）
• 測試資料準備：將JSON測試夾具轉成C#類別，再以Newtonsoft/System.Text.Json反序列化作為單元測試驅動，搭配xUnit/NUnit/MSTest使用
• 爬蟲資料解析：將HtmlAgilityPack/AngleSharp/PuppeteerSharp抓取的JSON資料轉成C#類別，避免JObject動態存取漏欄位
• API文件編寫：在Swagger/OpenAPI文件、ReDoc、Knife4j、Swagger UI中將C#類別範例納入schema定義，提升文件可讀性
• 程式碼審查協作：將API回應JSON直接轉成易讀的POCO，方便Code Review時討論欄位命名、型別選擇、註解使用
• 舊專案重構：將基於JObject/Dictionary<string, object>的動態存取重構為基於POCO的強型別存取，提升編譯期型別檢查與可維護性
• 教學培訓：在C#課程、.NET入門教學中將範例JSON轉成POCO，示範物件導向建模、屬性存取子、序列化原理

使用方法

1. 在左側編輯器貼上JSON內容，或點上傳按鈕選擇.json/.txt檔，或點範例按鈕載入內建資料
2. 等待400ms後自動轉換，右側會顯示生成的C# POCO類別程式碼
3. 若有JSON格式錯誤，可點「修復JSON」按鈕自動修復常見語法問題後再轉換
4. 點「複製」按鈕複製單個類別到剪貼簿貼到Visual Studio/Rider/VS Code，或點「下載」儲存為.cs檔

功能特點

• 純瀏覽器本機生成：JSON解析與C#程式碼生成全部透過JavaScript + quicktype-core在瀏覽器內完成，輸入資料不會上傳至任何伺服器
• POCO + record兩種形式：預設生成可序列化POCO類別，一鍵切換為C# 9+ record型別，符合現代.NET編碼風格
• Newtonsoft [JsonProperty]註解：自動為每個欄位加上[JsonProperty("原始key")]，相容Newtonsoft.Json預設行為，PascalCase欄位名稱不影響反序列化
• 巢狀物件自動拆解：JSON巢狀物件會遞迴生成獨立的C#類別，欄位名首字母大寫命名（例如address → Address），避免型別衝突
• List泛型自動展開：JSON陣列自動轉為List<T>，T自動從陣列第一個元素推導（["a","b"] → List<string>，[{...}] → List<Item>）
• Nullable<T>自動推導：JSON null值欄位自動標記為Nullable<T>（例如long? / string? / bool?），避免編譯期空參考例外
• PascalCase欄位命名：snake_case輸入自動轉為PascalCase（例如user_name → UserName），同時[JsonProperty]註解保留原始key，反序列化相容
• 豐富值型別對應：string→string、integer→long、float→double、bool→bool、array→List<T>、null→Nullable<T>
• 完整.cs樣板：自動生成含using System.Collections.Generic; + namespace + public class + 欄位 + 屬性的標準C#檔案，可直接編譯
• 複製與下載：一鍵複製單個類別到剪貼簿或下載為.cs檔，直接拖進Visual Studio / Rider / VS Code使用
• JSON錯誤一鍵修復：自動修復尾逗號、單引號、遺漏引號等常見格式錯誤，修復成功後繼續生成C#程式碼
• 本機歷史記錄：基於localStorage自動儲存最近輸入，重新整理或誤關頁面後可快速還原繼續編輯

程式碼範例

using Newtonsoft.Json;
using System;
using System.Net.Http;
using System.Threading.Tasks;

public class ApiClient
{
    private static readonly HttpClient _http = new HttpClient();

    // 本工具生成的POCO：
    public class User
    {
        [JsonProperty("id")]
        public long Id { get; set; }

        [JsonProperty("name")]
        public string Name { get; set; }

        [JsonProperty("email")]
        public string Email { get; set; }

        [JsonProperty("is_active")]
        public bool? IsActive { get; set; }
    }

    public static async Task<User> GetUserAsync(int userId)
    {
        // 1) 呼叫API取得JSON字串
        var json = await _http.GetStringAsync($"https://api.example.com/users/{userId}");

        // 2) 反序列化為本工具生成的POCO
        //    內部根據[JsonProperty("id")]等註解自動對應snake_case JSON
        var user = JsonConvert.DeserializeObject<User>(json);

        Console.WriteLine($"User: {user.Name} ({user.Email})");
        return user;
    }
}

using Microsoft.AspNetCore.Mvc;
using System.Collections.Generic;
using System.Linq;

// 本工具生成的POCO（預設使用Newtonsoft [JsonProperty]）：
public class CreateOrderRequest
{
    [Newtonsoft.Json.JsonProperty("user_id")]
    public long UserId { get; set; }

    [Newtonsoft.Json.JsonProperty("items")]
    public List<OrderItem> Items { get; set; }
}

public class OrderItem
{
    [Newtonsoft.Json.JsonProperty("product_id")]
    public long ProductId { get; set; }

    [Newtonsoft.Json.JsonProperty("quantity")]
    public long Quantity { get; set; }
}

[ApiController]
[Route("api/[controller]")]
public class OrdersController : ControllerBase
{
    [HttpPost]
    public IActionResult Create([FromBody] CreateOrderRequest request)
    {
        if (request == null || request.Items == null || !request.Items.Any())
        {
            return BadRequest("Items cannot be empty");
        }

        // 業務邏輯：儲存訂單
        // var order = OrderService.Create(request);

        return Ok(new { order_id = 12345, status = "created" });
    }
}

/*
 * 對應.csproj依賴：
 * <PackageReference Include="Microsoft.AspNetCore.Mvc.NewtonsoftJson" Version="7.0.0" />
 * <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
 */

using System.Net.Http.Json;
using System.Text.Json.Serialization;
using System.Threading.Tasks;

// 本工具預設生成POCO class；可手動改為record型別（不可變資料傳遞物件）如下：
public record User
{
    [JsonPropertyName("id")]
    public long Id { get; init; }

    [JsonPropertyName("name")]
    public string Name { get; init; }

    [JsonPropertyName("email")]
    public string Email { get; init; }

    [JsonPropertyName("is_active")]
    public bool? IsActive { get; init; }
}

public class ApiClient
{
    private static readonly HttpClient _http = new HttpClient();

    public static async Task<User> GetUserAsync(int userId)
    {
        // System.Text.Json：GetFromJsonAsync一行完成HTTP + 反序列化
        var user = await _http.GetFromJsonAsync<User>(
            $"https://api.example.com/users/{userId}");

        System.Console.WriteLine($"User: {user.Name} ({user.Email})");
        return user;
    }
}

/*
 * 對應.csproj依賴（System.Text.Json內建，無需額外安裝）：
 * <TargetFramework>net7.0</TargetFramework>
 *
 * 若專案是.NET 7+且想相容[JsonProperty] Newtonsoft語法，
 * 可在Program.cs加入：
 *   builder.Services.AddControllers()
 *       .AddNewtonsoftJson(options =>
 *       {
 *           options.SerializerSettings.ContractResolver =
 *               new Newtonsoft.Json.Serialization.DefaultContractResolver();
 *       });
 */

最佳实践

常見問題

故障排查

術語表

POCO (Plain Old CLR Object)

C#/.NET中「普通CLR物件」的縮寫，約束為：公開預設建構函式 + private欄位 + 公開{ get; set; }屬性 + 無框架依賴。本工具生成的即為標準POCO。

record

C# 9+引入的不可變資料傳遞物件型別，使用值相等性而非參考相等性。在本工具生成後可手動改為record，適合DTO、API回應模型、不可變組態等場景。

[JsonProperty]

Newtonsoft.Json的欄位對應特性。本工具預設為每個欄位加上[JsonProperty("原始key")]，確保PascalCase欄位名稱能正確反序列化snake_case的JSON。

Newtonsoft.Json

又稱Json.NET，是.NET生態最流行的JSON程式庫。生態最豐富、相容性最好，幾乎所有.NET專案都支援。ASP.NET Core 3.0前預設使用，3.0後改為System.Text.Json，但仍可透過NuGet套件繼續相容。

System.Text.Json

.NET Core 3.0+內建的高效能JSON程式庫。啟動快、記憶體佔用低、AOT友好，包含[JsonPropertyName]（對應Newtonsoft的[JsonProperty]）與JsonNamingPolicy自訂命名政策。

Nullable<T>

C#中表示實值型別可為空的型別（例如long? / bool?）。本工具自動將JSON null欄位推導為Nullable<T>，避免編譯期空參考例外。

List<T>

.NET集合框架中的泛型清單型別。本工具將JSON陣列自動轉為List<T>，T從陣列第一個元素自動推導（例如["a"] → List<string>）。

namespace

C#中用於組織類別的命名空間關鍵字，類似Java的package。本工具生成的程式碼預設無namespace，可手動加入（例如namespace MyApp.Models）。

ASP.NET Core

微軟開源跨平台Web框架。本工具生成的POCO類別可直接用於ASP.NET Core Controller [FromBody]模型繫結、Minimal API、Blazor元件參數等場景。

Unity

全球最受歡迎的遊戲引擎，指令碼語言為C#。本工具生成的POCO類別可用於Unity網路API回應解析、ScriptableObject組態資料建模。

Snake_case → PascalCase

欄位命名規則轉換。將snake_case命名（例如user_name、created_at）轉為PascalCase命名（例如UserName、CreatedAt），符合.NET官方命名規範。

quicktype-core

本工具基礎依賴的開源多語言JSON型別生成庫（quicktype專案），支援C#、Java、TypeScript、Rust、Go、Swift等十餘種語言，基於TypeScript + WebAssembly在瀏覽器執行。

.NET MAUI

微軟跨平台UI框架（.NET Multi-platform App UI），C#程式碼可在iOS/Android/Windows/macOS共用。本工具生成的POCO適合作為MAUI XAML資料繫結的Model。

Blazor

微軟基於WebAssembly的SPA框架，分Server與WebAssembly兩種模式。本工具生成的C#類別可用於Blazor元件參數、強型別API回應模型，提升單一語言全棧開發效率。

HttpClient.GetFromJsonAsync

.NET 5+/System.Net.Http.Json擴充方法，HTTP GET + JSON反序列化一行完成。搭配本工具生成的POCO可大幅簡化HTTP API用戶端程式碼。

JsonNamingPolicy

System.Text.Json中控制JSON欄位名與C#屬性名對應規則的類別（例如CamelCase、SnakeCaseLower）。Newtonsoft.Json透過[JsonProperty]註解或ContractResolver實現。

IOptions<T>

.NET Options模式核心介面，將appsettings.json子結構繫結到強型別類別。本工具生成的POCO可搭配IConfiguration.Bind直接作為IOptions<T>實作。

JSON型別到C#型別對照速查表

工具根據JSON值的型別自動推導對應的C#/.NET型別：

Newtonsoft.Json與System.Text.Json註解對照表

.NET生態兩大主流JSON程式庫欄位對應特性對照。本工具預設生成Newtonsoft相容[JsonProperty]：

Privacy & Security

本JSON轉C#工具的所有作業完全在您的瀏覽器本機完成：JSON解析、C#程式碼生成、檔案下載全部透過瀏覽器JavaScript + WebAssembly（quicktype-core）於客戶端執行，不會透過網路向任何伺服器傳送JSON內容、上傳的檔案或生成的程式碼。檔案上傳使用瀏覽器原生FileReader API直接讀取至記憶體，不經過任何中繼服務。不使用Cookie追蹤，不收集使用者輸入資料或使用行為資料。關閉或重新整理頁面後，所有輸入與輸出內容將自動從記憶體清除。適合處理包含API金鑰、權杖、敏感業務資料的JSON。

Authoritative References

• MicrosoftMicrosoft Learn - C# 程式設計手冊
• MicrosoftMicrosoft Learn - System.Text.Json 概觀
• NewtonsoftNewtonsoft.Json 官方文件
• MicrosoftMicrosoft Learn - ASP.NET Core Web API 模型繫結
• MicrosoftMicrosoft Learn - C# 9 record 型別