.NET 对象转Json的方式

.NET 对象转Json的方式

在.NET中将对象转换为JSON有多种方法,以下是常用的几种方式:

1. 使用 System.Text.Json (推荐,.NET Core 3.0+)

基本序列化

csharp 复制代码
using System.Text.Json;

public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
    public string Email { get; set; }
}

// 对象转JSON
var person = new Person { Name = "张三", Age = 25, Email = "zhangsan@example.com" };
string jsonString = JsonSerializer.Serialize(person);
Console.WriteLine(jsonString);
// 输出: {"Name":"张三","Age":25,"Email":"zhangsan@example.com"}

带选项的序列化

csharp 复制代码
var options = new JsonSerializerOptions
{
    WriteIndented = true, // 格式化输出
    PropertyNamingPolicy = JsonNamingPolicy.CamelCase // 驼峰命名
};

string jsonString = JsonSerializer.Serialize(person, options);
Console.WriteLine(jsonString);
// 输出:
// {
//   "name": "张三",
//   "age": 25,
//   "email": "zhangsan@example.com"
// }

2. 使用 Newtonsoft.Json (Json.NET)

首先安装 NuGet 包:

复制代码
Install-Package Newtonsoft.Json
csharp 复制代码
using Newtonsoft.Json;

public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
    public string Email { get; set; }
}

// 基本序列化
var person = new Person { Name = "李四", Age = 30, Email = "lisi@example.com" };
string jsonString = JsonConvert.SerializeObject(person);
Console.WriteLine(jsonString);

// 带格式的序列化
string formattedJson = JsonConvert.SerializeObject(person, Formatting.Indented);
Console.WriteLine(formattedJson);

Newtonsoft.Json 高级用法

csharp 复制代码
var settings = new JsonSerializerSettings
{
    Formatting = Formatting.Indented,
    NullValueHandling = NullValueHandling.Ignore,
    DateFormatString = "yyyy-MM-dd HH:mm:ss"
};

string jsonString = JsonConvert.SerializeObject(person, settings);

3. 处理复杂对象

包含集合的对象

csharp 复制代码
public class Department
{
    public string Name { get; set; }
    public List<Person> Employees { get; set; }
}

var department = new Department
{
    Name = "技术部",
    Employees = new List<Person>
    {
        new Person { Name = "王五", Age = 28, Email = "wangwu@example.com" },
        new Person { Name = "赵六", Age = 32, Email = "zhaoliu@example.com" }
    }
};

string jsonString = JsonSerializer.Serialize(department, new JsonSerializerOptions { WriteIndented = true });
Console.WriteLine(jsonString);

匿名对象序列化

csharp 复制代码
var anonymousObject = new
{
    Id = 1,
    Description = "测试对象",
    CreateTime = DateTime.Now
};

string jsonString = JsonSerializer.Serialize(anonymousObject);
Console.WriteLine(jsonString);

4. 自定义序列化选项

System.Text.Json 自定义

csharp 复制代码
var options = new JsonSerializerOptions
{
    WriteIndented = true,
    PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
    DefaultIgnoreCondition = System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull,
    Converters = { new JsonStringEnumConverter() } // 枚举转换为字符串
};

string jsonString = JsonSerializer.Serialize(person, options);

使用特性控制序列化

csharp 复制代码
public class Product
{
    [JsonPropertyName("productName")] // System.Text.Json
    public string Name { get; set; }
    
    [JsonIgnore] // 忽略该属性
    public string InternalCode { get; set; }
    
    [JsonPropertyOrder(1)] // 属性顺序
    public decimal Price { get; set; }
}

5. 性能优化

使用源生成器 (System.Text.Json)

csharp 复制代码
[JsonSerializable(typeof(Person))]
[JsonSerializable(typeof(List<Person>))]
public partial class MyJsonContext : JsonSerializerContext
{
}

// 使用源生成器进行序列化
var person = new Person { Name = "测试", Age = 25 };
string jsonString = JsonSerializer.Serialize(person, MyJsonContext.Default.Person);

选择建议

  • 新项目 :推荐使用 System.Text.Json,性能更好,无需额外依赖
  • 现有项目:如果已经在使用 Newtonsoft.Json,可以继续使用
  • 复杂场景:Newtonsoft.Json 功能更丰富,支持更多复杂场景

两种方法都很常用,根据项目需求和个人偏好选择即可。

相关推荐
rockey6277 小时前
AScript异步执行与await关键字
c#·.net·script·eval·expression·异步执行·动态脚本
叫我少年8 小时前
ASP.NET Core 最小 API 快速参考
.net·api
sa1002715 小时前
京东评论 API 实战:JSON 数据结构、字段含义与解析技巧
前端·数据结构·json
查拉图斯特拉面条16 小时前
JMeter 实战技巧:JSON 数组筛选指定对象并剔除首尾大括号
jmeter·json
霸道流氓气质16 小时前
Spring AI 结构化输出 Agent 实战:让大模型返回精准 JSON
人工智能·spring·json
步步为营DotNet18 小时前
深入.NET 11:C# 14 在边缘计算数据处理的优化与实践
c#·.net·边缘计算
查拉图斯特拉面条18 小时前
JMeter 实战:JSON 响应中文节点 + 数值精准断言(附真实接口案例)
jmeter·json
Rooting++2 天前
package.json三种依赖的区别
vue.js·json
步步为营DotNet2 天前
洞悉.NET 11:Blazor 与 Microsoft.Extensions.AI 的融合创新实践
人工智能·microsoft·.net
回忆2012初秋2 天前
.NET 8.0 实战:基于 MQTTnet 封装高可用的 MQTT 发布/订阅工具类
开发语言·mqtt·.net