使用 Newtonsoft.Json（Json.NET）库将对象导出为格式化的 JSON 文件
使用 Newtonsoft.Json（Json.NET）库将对象导出为格式化的 JSON 文件是 C# 中常见的操作，以下是详细的实现步骤、常用属性和方法说明：
一、基础实现：对象 → 格式化 JSON 文件
步骤 1：安装 Newtonsoft.Json
通过 NuGet 安装：
- 右键 项目 → 管理 NuGet 包 → 搜索
Newtonsoft.Json→ 安装。
步骤 2：核心代码（对象转格式化 JSON 并保存为文件）
using Newtonsoft.Json;
using System;
using System.IO;// 1. 定义示例对象
public class Product
{public int Id { get; set; }public string Name { get; set; }public decimal Price { get; set; }public bool IsInStock { get; set; }
}class Program
{static void Main(){// 2. 创建对象实例var product = new Product{Id = 1001,Name = "笔记本电脑",Price = 5999.99m,IsInStock = true};// 3. 序列化对象为格式化的 JSON 字符串string json = JsonConvert.SerializeObject(value: product,formatting: Formatting.Indented, // 关键：启用格式化（缩进+换行）settings: new JsonSerializerSettings{// 可选配置：处理日期、空值、循环引用等DateFormatString = "yyyy-MM-dd HH:mm:ss", // 日期格式NullValueHandling = NullValueHandling.Ignore, // 忽略 null 值属性ReferenceLoopHandling = ReferenceLoopHandling.Ignore // 忽略循环引用});// 4. 保存到文件string filePath = @"C:\data\product.json";// 确保目录存在（不存在则创建）Directory.CreateDirectory(Path.GetDirectoryName(filePath));// 写入文件File.WriteAllText(filePath, json);Console.WriteLine($"JSON 文件已保存至：{filePath}");}
}生成的 JSON 文件内容（格式化后）
{"Id": 1001,"Name": "笔记本电脑","Price": 5999.99,"IsInStock": true
}二、常用核心方法
1. JsonConvert.SerializeObject（对象 → JSON 字符串）
最核心的序列化方法，签名：
public static string SerializeObject(object value, // 要序列化的对象Formatting formatting, // 格式化选项（None：紧凑格式；Indented：缩进格式）JsonSerializerSettings settings // 序列化配置（可选）
)示例：
// 紧凑格式（无缩进）
string compactJson = JsonConvert.SerializeObject(product, Formatting.None);// 缩进格式（格式化）
string indentedJson = JsonConvert.SerializeObject(product, Formatting.Indented);2. JsonSerializerSettings（序列化配置类）
用于自定义序列化行为，常用属性：
| 属性名 | 说明 |
|---|---|
DateFormatString | 日期时间格式化字符串（如 "yyyy-MM-dd"），默认是 ISO 格式。 |
NullValueHandling | 控制 null 值的处理：- NullValueHandling.Include（默认）：保留 null 值- NullValueHandling.Ignore：忽略 null 值属性 |
ReferenceLoopHandling | 处理对象循环引用（如 A 包含 B，B 包含 A）：- ReferenceLoopHandling.Error（默认）：抛异常- ReferenceLoopHandling.Ignore：忽略循环引用- ReferenceLoopHandling.Serialize：序列化循环引用（生成 $ref 标记） |
ContractResolver | 自定义序列化规则（如属性排序、动态排除属性等），需配合 DefaultContractResolver 子类使用。 |
TypeNameHandling | 控制是否序列化类型信息（如基类对象序列化时保留具体子类类型），默认不序列化。 |
Converters | 自定义转换器集合（如处理枚举、特殊类型的序列化）。 |
3. 特性（Attribute）控制单个属性
通过在类的属性上添加特性，精细控制序列化行为：
| 特性名 | 说明 |
|---|---|
[JsonProperty] | 自定义 JSON 中的属性名、排序、是否序列化等：- PropertyName：指定 JSON 中的键名（如 [JsonProperty("product_id")]）- Order：控制属性排序（值越小越靠前）- NullValueHandling：单独控制该属性的 null 值处理 |
[JsonIgnore] | 序列化时排除当前属性（如敏感信息：密码、Token 等）。 |
[JsonRequired] | 标记属性为必需，若为 null 则序列化时抛异常。 |
[JsonConverter] | 为当前属性指定自定义转换器（如枚举转字符串、日期转特定格式）。 |
示例：
public class User
{[JsonProperty("user_id", Order = 1)] // JSON 键名为 "user_id"，排序优先级 1public int Id { get; set; }[JsonProperty(Order = 2)]public string Name { get; set; }[JsonIgnore] // 排除密码public string Password { get; set; }[JsonProperty(NullValueHandling = NullValueHandling.Ignore)] // 单独忽略该属性的 null 值public string Email { get; set; }
}三、高级场景：动态控制序列化
1. 动态排除属性
通过自定义 ContractResolver 排除特定属性（如根据条件排除）：
public class ExcludePropertiesResolver : DefaultContractResolver
{private readonly HashSet<string> _excludedProps;public ExcludePropertiesResolver(IEnumerable<string> excludedProps){_excludedProps = new HashSet<string>(excludedProps);}protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization){JsonProperty property = base.CreateProperty(member, memberSerialization);// 若属性在排除列表中，则不序列化if (_excludedProps.Contains(property.PropertyName)){property.ShouldSerialize = _ => false;}return property;}
}// 使用：排除 "Price" 属性
var settings = new JsonSerializerSettings
{ContractResolver = new ExcludePropertiesResolver(new[] { "Price" }),Formatting = Formatting.Indented
};
string json = JsonConvert.SerializeObject(product, settings);2. 自定义类型转换
通过 JsonConverter 处理特殊类型（如枚举转中文描述）：
// 枚举定义
public enum Status { Active, Inactive }// 自定义转换器
public class StatusConverter : JsonConverter<Status>
{public override void WriteJson(JsonWriter writer, Status value, JsonSerializer serializer){// 序列化时将枚举转为中文string desc = value == Status.Active ? "激活" : "未激活";writer.WriteValue(desc);}public override Status ReadJson(JsonReader reader, Type objectType, Status existingValue, bool hasExistingValue, JsonSerializer serializer){// 反序列化逻辑（按需实现）string value = reader.Value.ToString();return value == "激活" ? Status.Active : Status.Inactive;}
}// 使用：在属性上标记转换器
public class Order
{public int Id { get; set; }[JsonConverter(typeof(StatusConverter))]public Status Status { get; set; }
}四、总结
- 核心流程：对象 →
JsonConvert.SerializeObject（带Formatting.Indented）→ 生成格式化 JSON →File.WriteAllText保存为文件。 - 常用配置：通过
JsonSerializerSettings控制全局行为（日期、null 值、循环引用），通过特性（[JsonProperty]、[JsonIgnore]）控制单个属性。 - 高级用法：自定义
ContractResolver动态排除属性，自定义JsonConverter处理特殊类型转换。
掌握这些方法可以灵活处理绝大多数对象到 JSON 文件的导出需求，满足格式化、自定义字段、特殊类型转换等场景。