c#如何创建json文件

C#轻松创建JSON文件：实用方法与代码示例**

在现代软件开发中,JSON（JavaScript Object Notation）因其轻量级、易读易写以及与JavaScript的良好兼容性，已成为数据交换的主流格式之一，在C#应用程序中，无论是配置文件、数据存储还是API交互，创建JSON文件都是一项常见任务，本文将详细介绍如何使用C#创建JSON文件，涵盖从基础到推荐的多种方法。

准备工作：引入必要的命名空间

在开始之前,确保你的项目中已经引用了处理JSON所需的库，对于较新的.NET Core/.NET 5/6/7/8等项目，通常默认包含System.Text.Json，对于传统的.NET Framework项目，你可能需要通过NuGet包管理器安装Newtonsoft.Json（也称为Json.NET）。

本文将重点介绍System.Text.Json（推荐用于新项目）和Newtonsoft.Json（广泛使用，功能丰富）两种主流方式。

使用 System.Text.Json

using System.Text.Json;

使用 Newtonsoft.Json

首先通过NuGet安装Newtonsoft.Json包，然后引入命名空间：

using Newtonsoft.Json;

创建JSON文件的方法

我们将通过一个具体的例子来演示如何创建一个包含用户信息的JSON文件,假设我们有以下用户数据：

public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Email { get; set; }
    public List<string> Roles { get; set; }
}
// 示例数据
var user = new User
{
    Id = 1,
    Name = "张三",
    Email = "zhangsan@example.com",
    Roles = new List<string> { "Admin", "User" }
};

我们的目标是将这个user对象保存到一个名为user.json的文件中，内容如下：

{
  "Id": 1,
  "Name": "张三",
  "Email": "zhangsan@example.com",
  "Roles": [
    "Admin",
    "User"
  ]
}

使用 System.Text.Json (推荐)

System.Text.Json是.NET Core 3.0及更高版本内置的JSON库，性能优秀，且无需额外安装（对于新项目）。

步骤：

1. 序列化对象为JSON字符串：使用JsonSerializer.Serialize()方法。
2. 将JSON字符串写入文件：使用File.WriteAllText()或File.WriteAllTextAsync()方法。

代码示例：

using System;
using System.Collections.Generic;
using System.Text.Json;
using System.IO;
class Program
{
    static void Main(string[] args)
    {
        // 示例数据
        var user = new User
        {
            Id = 1,
            Name = "张三",
            Email = "zhangsan@example.com",
            Roles = new List<string> { "Admin", "User" }
        };
        // 1. 序列化对象为JSON字符串
        // 可选：使用JsonSerializerOptions进行配置，如缩进
        var options = new JsonSerializerOptions { WriteIndented = true }; // 格式化，使JSON更易读
        string jsonString = JsonSerializer.Serialize(user, options);
        // 2. 定义文件路径
        string filePath = "user.json";
        try
        {
            // 3. 将JSON字符串写入文件
            File.WriteAllText(filePath, jsonString);
            Console.WriteLine($"JSON文件 '{filePath}' 创建成功！");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"创建JSON文件时出错: {ex.Message}");
        }
    }
}
public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Email { get; set; }
    public List<string> Roles { get; set; }
}

说明：

• JsonSerializerOptions允许你自定义序列化行为，例如WriteIndented = true会使输出的JSON带有缩进，便于阅读；在生产环境中为了节省空间，可以设置为false。
• WriteAllText会覆盖已存在的文件，如果文件不存在，则会创建新文件。

使用 Newtonsoft.Json (Json.NET)

Newtonsoft.Json是一个非常成熟和功能强大的JSON库，在.NET生态系统中拥有广泛的应用。

步骤：

1. 序列化对象为JSON字符串：使用JsonConvert.SerializeObject()方法。
2. 将JSON字符串写入文件：同样可以使用File.WriteAllText()或File.WriteAllTextAsync()方法。

代码示例：

using System;
using System.Collections.Generic;
using Newtonsoft.Json;
using System.IO;
class Program
{
    static void Main(string[] args)
    {
        // 示例数据
        var user = new User
        {
            Id = 1,
            Name = "张三",
            Email = "zhangsan@example.com",
            Roles = new List<string> { "Admin", "User" }
        };
        // 1. 序列化对象为JSON字符串
        // 可选：使用Formatting.Indented进行格式化
        string jsonString = JsonConvert.SerializeObject(user, Formatting.Indented);
        // 2. 定义文件路径
        string filePath = "user_newtonsoft.json";
        try
        {
            // 3. 将JSON字符串写入文件
            File.WriteAllText(filePath, jsonString);
            Console.WriteLine($"JSON文件 '{filePath}' 创建成功！");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"创建JSON文件时出错: {ex.Message}");
        }
    }
}
public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Email { get; set; }
    public List<string> Roles { get; set; }
}

说明：

• JsonConvert.SerializeObject()是Newtonsoft.Json中最常用的序列化方法。
• Formatting.Indented参数用于格式化输出，使JSON更易读，默认为Formatting.None（无缩进，紧凑格式）。

更复杂的场景：创建嵌套JSON或JSON数组

上述方法同样适用于创建更复杂的JSON结构,如嵌套对象或JSON数组，只需将你的C#对象构造为相应的嵌套结构或集合即可。

示例：创建包含多个用户的JSON数组

// 假设使用 System.Text.Json
var users = new List<User>
{
    new User { Id = 1, Name = "张三", Email = "zhangsan@example.com", Roles = new List<string> { "Admin" } },
    new User { Id = 2, Name = "李四", Email = "lisi@example.com", Roles = new List<string> { "User" } }
};
string usersJsonString = JsonSerializer.Serialize(users, new JsonSerializerOptions { WriteIndented = true });
File.WriteAllText("users.json", usersJsonString);

生成的users.json

[
  {
    "Id": 1,
    "Name": "张三",
    "Email": "zhangsan@example.com",
    "Roles": [
      "Admin"
    ]
  },
  {
    "Id": 2,
    "Name": "李四",
    "Email": "lisi@example.com",
    "Roles": [
      "User"
    ]
  }
]

using System.Threading.Tasks;
// ...
await File.WriteAllTextAsync("user_async.json", jsonString);
Console.WriteLine("异步JSON文件创建成功！");

using System.Threading.Tasks;
// ...
await File.WriteAllTextAsync("user_newtonsoft_async.json", jsonString);
Console.WriteLine("异步JSON文件创建成功！");