C# Newtonsoft.Json的几种保存类型说明

在 C# 中，Newtonsoft.Json 提供了多种保存和处理数据类型的方法，具体包括将数据序列化为 JSON 字符串，并保存到文件、内存、或者其他数据存储方式。这些保存类型可以按照不同场景需求选择适当的方式进行保存。本文将介绍 Newtonsoft.Json 中几种常用的保存类型和方式。

目录

1. 字符串保存
2. 文件保存
3. 内存流保存
4. 文本写入保存
5. 数据库保存
6. HTTP 请求/响应数据保存
7. 总结

---

1. 字符串保存

将对象序列化为 JSON 字符串 是最常见的保存方式，适用于处理较小的数据量，并将 JSON 数据保存为字符串，以便存储到数据库、缓存或者进一步处理。

示例：

using Newtonsoft.Json;

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

var person = new Person { Name = "John", Age = 30 };
string json = JsonConvert.SerializeObject(person);
Console.WriteLine(json); // 输出: {"Name":"John","Age":30}

优点：

• 简单直接，适用于临时存储或者在代码中传递数据。

场景：

• 传递小型数据时。
• 临时存储对象。

2. 文件保存

将序列化后的 JSON 字符串保存到文件中是常用的存储方式之一，适用于需要将对象持久化到硬盘上，以便后续读取或者备份。

示例：

using System.IO;
using Newtonsoft.Json;

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

var person = new Person { Name = "John", Age = 30 };
string json = JsonConvert.SerializeObject(person);

// 将 JSON 字符串保存到文件
File.WriteAllText(@"person.json", json);

// 从文件中读取 JSON 字符串
string jsonFromFile = File.ReadAllText(@"person.json");
Person deserializedPerson = JsonConvert.DeserializeObject<Person>(jsonFromFile);
Console.WriteLine(deserializedPerson.Name); // 输出: John

优点：

• 文件保存持久化，数据不会因程序退出而丢失。

场景：

• 需要长期存储数据。
• 保存日志、配置文件等。

3. 内存流保存

内存流保存是一种高效的保存方式，适用于将 JSON 数据保存在内存中，而不是硬盘。这种方式适合处理需要频繁读写但不需要持久化的数据。

示例：

using System.IO;
using Newtonsoft.Json;

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

var person = new Person { Name = "John", Age = 30 };

// 创建一个内存流来保存 JSON 数据
using (var memoryStream = new MemoryStream())
using (var streamWriter = new StreamWriter(memoryStream))
using (var jsonWriter = new JsonTextWriter(streamWriter))
{
    var serializer = new JsonSerializer();
    serializer.Serialize(jsonWriter, person);

    // 读取流中的内容
    memoryStream.Position = 0;
    using (var streamReader = new StreamReader(memoryStream))
    {
        string json = streamReader.ReadToEnd();
        Console.WriteLine(json); // 输出: {"Name":"John","Age":30}
    }
}

优点：

• 适合快速访问数据，避免磁盘 I/O 操作。

场景：

• 临时存储和处理中间数据。
• 需要高性能但不需要持久化时。

4. 文本写入保存

通过 JsonTextWriter 和 StreamWriter，可以将 JSON 数据写入文本流中。这种方法比直接使用 File.WriteAllText 更加灵活，适合需要逐步写入大数据的场景。

示例：

using System.IO;
using Newtonsoft.Json;

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

var person = new Person { Name = "John", Age = 30 };

// 使用 JsonTextWriter 将 JSON 写入文件
using (StreamWriter file = File.CreateText(@"person.json"))
using (JsonTextWriter writer = new JsonTextWriter(file))
{
    JsonSerializer serializer = new JsonSerializer();
    serializer.Serialize(writer, person);
}

优点：

• 对大数据的处理更加灵活。
• 支持逐步写入，适合需要分批写入的场景。

场景：

• 写入大文件时。
• 逐步写入 JSON 数据时。

5. 数据库保存

虽然 JSON 数据本身是文本格式，但可以将其存储在数据库中，通常存储在 VARCHAR 或 TEXT 类型字段中。为了提高数据库存储和查询的效率，某些数据库如 PostgreSQL 支持原生 JSON 类型。

示例：

using System.Data.SqlClient;
using Newtonsoft.Json;

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

var person = new Person { Name = "John", Age = 30 };
string json = JsonConvert.SerializeObject(person);

// 假设我们有一个 SQL Server 数据库，表格有一个名为 'PersonData' 的列用于存储 JSON 数据
string connectionString = "your_connection_string_here";

using (SqlConnection connection = new SqlConnection(connectionString))
{
    connection.Open();
    string query = "INSERT INTO People (PersonData) VALUES (@json)";
    using (SqlCommand command = new SqlCommand(query, connection))
    {
        command.Parameters.AddWithValue("@json", json);
        command.ExecuteNonQuery();
    }
}

优点：

• 将 JSON 存储在数据库中便于查询和数据管理。

场景：

• 需要长期存储并方便检索的数据。
• 数据库可以处理 JSON 查询的场景。

6. HTTP 请求/响应数据保存

在 Web 应用中，JSON 数据通常通过 HTTP 请求或响应进行传输。你可以将 JSON 数据作为 HTTP 响应体保存，并通过 API 提供给前端或者客户端。

示例：

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

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

public async Task SavePersonToApiAsync()
{
    var person = new Person { Name = "John", Age = 30 };
    string json = JsonConvert.SerializeObject(person);

    using (var httpClient = new HttpClient())
    {
        var content = new StringContent(json, Encoding.UTF8, "application/json");
        var response = await httpClient.PostAsync("https://api.example.com/saveperson", content);
        
        if (response.IsSuccessStatusCode)
        {
            Console.WriteLine("Person data successfully saved.");
        }
    }
}

优点：

• JSON 是最常用的 Web 数据传输格式，适合通过 HTTP 传输和处理数据。

场景：

• Web API 请求和响应中。
• 数据在客户端和服务器之间传输时。

7. 总结

Newtonsoft.Json 提供了多种保存类型，适应了不同的场景需求。无论是简单的字符串保存，还是持久化到文件、数据库，或者在 Web 中传输 JSON 数据，它都能灵活处理。选择合适的保存方式取决于数据的大小、存储时间以及如何读取数据等具体需求。

• 字符串保存 适合临时存储。
• 文件保存 适合持久化。
• 内存流保存 提供高效的内存操作。
• 文本写入保存 对大数据的逐步处理更灵活。
• 数据库保存 适合长期存储和查询。
• HTTP 请求/响应数据保存 是 Web 应用中常见的应用场景。

根据实际需求选择合适的保存方式，可以提高系统的性能和数据管理效率。