使用 ServiceStack.Text 序列化 json的实现代码

相信做 .net 开发的朋友经常会遇到 json 序列化这样的需要，今天发篇文章总结下自己使用ServiceStack.Text 来序列化 json。它的速度比 Newtonsoft.Json 快很多，在测试时发现比 fastJson 还快些。

首先，我们有下边两个类，一个是职员(Staff)类，一个是联系方式(Contact)类：

代码如下:

public class Staff
{
    public long ID { get; set; }
    public string Name { get; set; }
    public int Age { get; set; }
}

public class Contact
{
    public long StaffID { get; set; }
    public string Email { get; set; }
}

首先，我们添加两个职员:

代码如下:

List<Staff> listStaff = new List<Staff>();
listStaff.Add(new Staff() { ID = 2, Name = "小李" });
listStaff.Add(new Staff() { ID = 3, Name = "小王" });

按以前很多人序列化 json 的方式：

代码如下:

var result = "[";
foreach (var staff in listStaff)
{
    result += "{\"ID\":\"" + staff.ID + "\",\"Name\":\"" + staff.Name + "\"},";
}
result = result.Substring(0, result.Length - 1);
result += "]";

最终 json 如下：


代码如下:

[
    {
        "ID": "2",
        "Name": "小李"
    },
    {
        "ID": "3",
        "Name": "小王"
    }
]

使用这种方式是可以的，但有几个缺点：1.代码显得杂乱，易出错。2.需要自己对特殊字符进行转义，如双引号等，否则 json 序列化将失败。下边看看使用 ServiceStack.Text 来序列化 json。

我们需要下载 ServiceStack.Text.dll，将它引用到我们的项目中，并引用 ServiceStack.Text 命名空间。下边先看看单个类对象的序列化：

代码如下:

Staff staff = new Staff() { ID = 1, Name = "xiaozhao" };
var result = staff.ToJson();

这样得到的 json 如下：

代码如下:

{
    "ID": 1,
    "Name": "xiaozhao",
    "Age": 0
}

细心的朋友会发现，我们在输出中并不打算使用 Age 属性，但这里却输出了 Age，为解决这个问题，我们有下边方法。

1.使用 JsonObject 类，它继承自Dictionary<string, string>，使得我们可以如下来输出我们想要的属性。

代码如下:

Staff staff = new Staff() { ID = 1, Name = "xiaozhao" };

JsonObject json = new JsonObject();
json.Add("ID", staff.ID.ToString());
json.Add("Name", staff.Name);

var result = json.ToJson();

这样得到下边的结果[结果一]，达到了我们的目的。


代码如下:

{
    "ID": 1,
    "Name": "xiaozhao"
}

2.在项目中添加 System.Runtime.Serialization ，并引用命名空间 System.Runtime.Serialization。

我们可以在属性上边指明要序列化的属性，如下：

代码如下:

[DataContract]
public class Staff
{
    [DataMember]
    public long ID { get; set; }
    [DataMember]
    public string Name { get; set; }
    public int Age { get; set; }
}

或者：

代码如下:

public class Staff
{
    public long ID { get; set; }
    public string Name { get; set; }
    [IgnoreDataMember]
    public int Age { get; set; }
}

这样下边的代码输出的结果就变得和[结果一]相同了。

代码如下:

Staff staff = new Staff() { ID = 1, Name = "xiaozhao" };
var result = staff.ToJson();

最后，我们看下类对象集合的序列化，我们添加职员的联系方式如下：

代码如下:

List<Contact> listContact = new List<Contact>();
listContact.Add(new Contact() { StaffID = 3, Email = "xiaowang@163.com" });
listContact.Add(new Contact() { StaffID = 4, Email = "xiaoli@163.com" });

每个职员可能对应一个联系方式，这里要考虑有的职员没有联系方式的情况，直接给出代码：

代码如下:

List<string> list = new List<string>();
foreach (var staff in listStaff)
{
    JsonObject json = new JsonObject();
    json.Add("ID", staff.ID.ToString());
    json.Add("Name", staff.Name);

//联系方式
    var contact = listContact.FirstOrDefault(m => m.StaffID == staff.ID);
    if (contact != null)
    {
        JsonObject jsonContact = new JsonObject();
        jsonContact.Add("Email", contact.Email);
        //这里注意，将 Contact 对象序列化后的json串添加到了json对象
        json.Add("Contact", contact.ToJson());
    }
    //将json对象序列化再添加到list
    list.Add(json.ToJson());
}
//得到最终json串
var result = string.Format("[{0}]", string.Join(",", list));

得到的 json：


代码如下:

[
    {
        "ID": 2,
        "Name": "小李"
    },
    {
        "ID": 3,
        "Name": "小王",
        "Contact": {
            "StaffID": 3,
            "Email": "xiaowang@163.com"
        }
    }
]

而反序列化时，使用 FromJson() 即可：

var staff = result.FromJson<List<Staff>>();
本文简单介绍了下使用 ServiceStack.Text 来序列化 json，希望对没有使用过的朋友有些帮助。

作者：东奎