如何正确使用JsonConvert.SerializeObject进行数据序列化

SLXG • 2024-11-05 16:52 • 编程

一、简介

数据序列化是将数据从一种格式转化为另一种格式的过程。在.NET开发中，常见的数据序列化方式有XML序列化和JSON序列化。本文着重讲解第二种方式，即如何正确使用JsonConvert.SerializeObject进行数据序列化。

二、JsonConvert.SerializeObject基本概念

JsonConvert.SerializeObject是Json.NET库中提供的一个方法，可以将.NET对象序列化为JSON字符串。这个方法的定义为：public static string SerializeObject(object value, Formatting formatting = Formatting.None, JsonSerializerSettings settings = null)，其中value表示被序列化的对象，formatting表示JSON字符串格式化选项，settings表示序列化时用到的设置。

使用JsonConvert.SerializeObject需要引用相应的命名空间using Newtonsoft.Json;。

三、基本用法

下面我们通过一个简单的例子来演示如何使用JsonConvert.SerializeObject进行数据序列化。

using System;
using Newtonsoft.Json;

class Program
{
    static void Main(string[] args)
    {
        Person person = new Person() { Name = "张三", Age = 20 };
        string jsonStr = JsonConvert.SerializeObject(person);
        Console.WriteLine(jsonStr);
    }
}

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

上面的代码中，我们定义了一个Person类，里面包含了姓名和年龄两个属性。在Main函数中，我们创建了一个Person对象，并将其序列化为了JSON字符串。输出的结果为：{“Name”:”张三”,”Age”:20}。

可以看到，JsonConvert.SerializeObject将Person对象序列化为了符合JSON格式的字符串。其中，属性名和属性值之间用冒号隔开，属性之间用逗号隔开，整个JSON字符串用花括号包含。

四、JsonConvert.SerializeObject进阶用法

1、格式化选项

JsonConvert.SerializeObject的第二个参数Formatting是用来设置JSON字符串的格式化选项的。默认情况下，JSON字符串是不进行格式化的。如果想在输出时进行格式化，可以将Formatting设置为Formatting.Indented。

string jsonStr = JsonConvert.SerializeObject(person, Formatting.Indented);

上面的代码中，我们将Formatting设置为Formatting.Indented，使JSON字符串输出时进行了格式化。输出结果为：

{
  "Name": "张三",
  "Age": 20
}

2、修改属性名

在某些情况下，我们需要将对象的属性名序列化为不同的名称。可以使用JsonPropertyAttribute来指定序列化时的属性名。例如：

class Person
{
    [JsonProperty(PropertyName = "personName")]
    public string Name { get; set; }
    [JsonProperty(PropertyName = "personAge")]
    public int Age { get; set; }
}

在上面的代码中，我们使用JsonPropertyAttribute来指定Name属性序列化时的属性名为personName，Age属性的属性名序列化时为personAge。

3、日期格式化

默认情况下，JsonConvert.SerializeObject在将日期类型对象序列化为JSON字符串时，只会将日期的UTC时间序列化。如果我们想更改日期序列化的格式，可以使用JsonSerializerSettings来进行设置。例如：

JsonSerializerSettings settings = new JsonSerializerSettings
{
    DateFormatString = "yyyy-MM-dd HH:mm:ss" //设置日期格式化字符串
};
string jsonStr = JsonConvert.SerializeObject(person, Formatting.Indented, settings);

在上面的代码中，我们创建了JsonSerializerSettings对象，并将DateFormatString属性设置为”yyyy-MM-dd HH:mm:ss”，表示日期以这个格式输出。然后将settings作为参数传递给SerialzieObject方法即可。

四、小结

本文从JsonConvert.SerializeObject基本概念、基本用法、进阶用法三个方面对如何正确使用JsonConvert.SerializeObject进行数据序列化做了详细的阐述。了解和掌握这个方法的用法，对于.NET开发工程师而言是非常重要的。

原创文章，作者：SLXG，如若转载，请注明出处：https://www.506064.com/n/149552.html