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 fixture 转成 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 class 代码
3. 如果 JSON 格式错误，点击「修复 JSON」按钮自动修复常见语法问题后再转换
4. 点击「复制」按钮把单个类复制到剪贴板，粘贴到 Visual Studio / Rider / VS Code，或点击「下载」保存为 .cs 文件

功能特点

• 纯浏览器本地生成：JSON 解析与 C# 代码生成全部在浏览器内通过 JavaScript + quicktype-core 完成，输入数据不上传任何服务器
• POCO + record 双形态：默认生成可序列化的 POCO class，可一键切换为 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 对象」的简称，约束为：公有默认构造器 + 私有字段 + 公有 { 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 可直接作为 IOptions<T> 的实现，配合 IConfiguration.Bind 使用。

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 密钥、token、敏感业务数据的 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 类型