C#格式化json字符串的方法分析

下面就是详细的讲解：

C# 格式化 JSON 字符串的方法分析

JSON 是一种轻量级的数据交换格式，常用于前后端数据传输。在开发中，我们通常需要将对象转换为 JSON 格式的字符串，或者将 JSON 格式的字符串转换为对象。本文会着重讲解 C# 中如何格式化 JSON 字符串。

使用JsonConvert.SerializeObject()

在 C# 中使用 Json.NET 库提供的 JsonConvert.SerializeObject() 方法可以将对象转换为 JSON 格式的字符串。该方法传入的第一个参数是需要转换的对象，第二个参数是 Formatting 枚举类型，用于指定输出的格式。

以下是一个简单的示例代码：

using Newtonsoft.Json;

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

public static void Main(string[] args)
{
    Person person = new Person { Id = 1, Name = "Tom", Age = 18 };
    string json = JsonConvert.SerializeObject(person, Formatting.Indented);
    Console.WriteLine(json);
}

在上面的示例代码中，我们定义了一个 Person 类，该类包含了 Id、Name 和 Age 三个属性。在 Main() 方法中，我们实例化了一个 Person 对象，并使用 JsonConvert.SerializeObject() 方法将其转换为 JSON 格式的字符串。第二个参数指定输出的格式为带缩进格式，也就是 Formatting.Indented。

输出结果为：

{
  "Id": 1,
  "Name": "Tom",
  "Age": 18
}

可以看到，输出的字符串是带缩进的格式，易于阅读。但是需要注意的是，这种格式化会增加字符串的长度，可能会对网络传输或者存储造成影响。

使用JsonTextWriter

除了使用 Json.NET 库提供的 JsonConvert.SerializeObject() 方法外，我们还可以使用 JsonTextWriter 类来手动格式化 JSON 字符串。

以下是一个示例代码：

using Newtonsoft.Json;

public static void Main(string[] args)
{
    StringWriter sw = new StringWriter();
    using (JsonTextWriter writer = new JsonTextWriter(sw))
    {
        writer.Formatting = Formatting.Indented;

        writer.WriteStartObject();
        writer.WritePropertyName("Id");
        writer.WriteValue(1);
        writer.WritePropertyName("Name");
        writer.WriteValue("Tom");
        writer.WritePropertyName("Age");
        writer.WriteValue(18);
        writer.WriteEndObject();
    }
    Console.WriteLine(sw.ToString());
}

在上面的示例代码中，我们使用了 StringWriter 类来将输出的 JSON 格式的字符串保存在内存中。然后使用 JsonTextWriter 类进行手动格式化。调用 Formatting.Indented 属性设置输出格式，然后手动写入 JSON 属性和值。

输出结果为：

{
  "Id": 1,
  "Name": "Tom",
  "Age": 18
}

可以看到，输出结果同样是带缩进格式的 JSON 字符串。

总结

以上就是 C# 中格式化 JSON 字符串的方法分析。在实际开发中，可以根据具体情况选择使用第一种或第二种方法进行格式化。如果数据量较大，需要进行网络传输或数据存储时，可以考虑不使用缩进格式。