Json序列化之.NET開源類庫Newtonsoft.Json的研究

 一、Json簡介

　　JSON(全稱為JavaScript Object Notation) 是一種輕量級的資料交換格式。它是基於JavaScript語法標準的一個子集。 JSON採用完全獨立於語言的文字格式，可以很容易在各種網路、平臺和程式之間傳輸。JSON的語法很簡單，易於人閱讀和編寫，同時也易於機器解析和生成。

JSON與XML的比較

◆ 可讀性

　　JSON和XML的可讀性相比較而言，由於XML提供輔助的標籤，更加適合人閱讀和理解。

◆ 檔案大小與傳輸

　　XML允許使用方便的標籤，所以檔案尺寸是要比JSON大的。而且JSON源於Javascript，所以天生的主戰場是Javascript與網路，在這裡，JSON有著XML無法趕超的優勢。

  

JSON語法

1、 JSON 語法是 JavaScript 物件表示法語法的子集。

　　• 資料在名稱/值對中：名稱是字串，使用雙引號表示。值可以是：數字（整數或浮點數），字串（在雙引號中）,陣列（在方括號中）,物件（在花括號中），true/false/null。

　　• 資料由逗號分隔：

　　• 花括號儲存物件：物件可以包含各種資料，包括陣列。

　　• 方括號儲存陣列：數字可以包含物件。

  

例如：

{

    "student": [

        {

            "firstName": "Bill",

            "lastName": "Gates"

        },

        {

            "grade": "3",

            "sex": "boy"

        }

    ]

}

 

 二、Json的序列化和反序列化

 

方式一：從頭開始，自己寫方法

　　Json的格式並不複雜，序列化和反序列化我們完全可以自己來寫一套方法來處理Json。但是如果沒有特殊業務需求，沒有人會這樣做，畢竟隨著專案的推進，這個方法可能會變得越來越複雜。

 

方法二：使用開源類庫

　　下面跟大家推薦一款.NET中開源的Json序列化和反序列化類庫，Newtonsoft.Json(下載地址http://json.codeplex.com/)。開啟網站如下：

 

點選Download，即可下載次類庫。下載完成後，解壓完成後可以看到如下目錄：

開啟Bin目錄，會看到不同版本的dll檔案，這裡我選擇Net40，複製Newtonsoft.Json.dll和Newtonsoft.Json.xml到專案下面。最常用的是JObject, JsonReader, JsonWriter來處理Json字串，這幾種方式比較靈活。下面我們來建一個專案來介紹一下Newtonsoft.Json的具體用法。

 

 

 三、實戰Json序列化和反序列化

 

1、解析Json(反序列化)

 

　　開啟VS，新建控制檯專案JsonWithNewtonsoft，這裡我用的是VS2013，然後建立資料夾library來放我們引用的dll，建好的專案結構如下圖：

 

然後我們新增引用 using Newtonsoft.Json;下面我們來看看怎麼使用吧！是不是此刻心情很激動啊~~呵呵，先來看看怎麼讀取Json吧，我們自己寫一個Json字串，來解析一下，這裡給出幾種用法，大家根據自己愛好選擇。

上程式碼，先來看第一種讀取Json的寫法，順序讀取：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
using System.IO;
using Newtonsoft.Json.Linq;

namespace JsonWithNewtonsoft
{
    class Program
    {
        static void Main(string[] args)
        {
            string jsonText = @"{""Name"" : ""Jack"", ""Age"" : ""22""}";
            JsonReader reader = new JsonTextReader(new StringReader(jsonText));

            while (reader.Read())
            {
                Console.WriteLine(reader.TokenType + "\t" + reader.ValueType + "\t" + reader.Value);
            }
            Console.Read();
        }
    }
}

 其輸出內容如下：

 

 

可以看到，他是順序解析Json，首先輸出Json開始標誌StartObject,然後依次輸出Json的內容。

 

 下面來看第二種解析Json的方法：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
using System.IO;
using Newtonsoft.Json.Linq;

namespace JsonWithNewtonsoft
{
    class Program
    {
        static void Main(string[] args)
        {
            string jsonText = @"{""Name"" : ""Jack"", ""Age"" : ""22""}";

            JObject jo = JObject.Parse(jsonText);
            string[] values = jo.Properties().Select(item => item.Name.ToString() + ":" + item.Value.ToString()).ToArray();
            foreach(string s in values)
            {
                Console.WriteLine(s);
            }
            Console.Read();
        }
    }
}

這裡使用JObject來解析Json資料，可以看到這裡使用linq取出了Json的Name和Value屬性，然後將結果賦給values陣列，輸出結果如下：

這就是解析Json的兩種方法，一種是使用StringReader,一種是使用JObject。

 

解析陣列型資料

到這裡Json解析就完了？當然沒完！這只是解析最基本的Json資料格式，下面來看下解析陣列格式的Json資料，程式碼如下：

            //陣列型資料
            string jsonArrayText1 = "[{'Name':'Tom','Age':'16'},{'Name':'Mary','Age':'15'}]";
            JArray ja = (JArray)JsonConvert.DeserializeObject(jsonArrayText1);

            string name1 = ja[1]["Name"].ToString();
            Console.WriteLine(name1);
            //或者
            JObject o = (JObject)ja[1];
            string name2 = o["Name"].ToString();
            Console.WriteLine(name2);

這裡我們定義了兩個學生，這裡使用JArray這個型別，可以看到，他和陣列的用法很像。當然還可以轉換成JObject型別，然後再進行取值操作。

 

解析巢狀性資料

還有一種Json格式，是巢狀格式，來看下如何解析吧。程式碼如下：

      　　   //巢狀格式
            jsonText = "{\"shanghai\":{\"zone\":\"浦東\",\"zone_en\":\"pudong\"}}";
            jo = (JObject)JsonConvert.DeserializeObject(jsonText);
            string zone = jo["shanghai"]["zone"].ToString();
            string zone_en = jo["shanghai"]["zone_en"].ToString();

程式碼很簡單，我就不過多的解釋了。

到這裡，讀取和解析Json的內容就講完了，下面我們來說一下序列化，就是生成Json的方法。

 

2、序列化Json

　　先來看一下通用的生成Json的方法吧！就來輸出{"Name":"Jack","Age":"26"}程式碼如下：

 　　　　　　//輸出{"Name":"Jack","Age":"26"}
            StringWriter sw = new StringWriter();
            JsonWriter writer = new JsonTextWriter(sw);
            writer.WriteStartObject();
            writer.WritePropertyName("Name");
            writer.WriteValue("Jack");
            writer.WritePropertyName("Age");
            writer.WriteValue("26");
            writer.WriteEndObject();
            writer.Flush();

            jsonText = sw.GetStringBuilder().ToString();
            Console.WriteLine(jsonText);

這段程式碼執行後就是輸出{"Name":"Jack","Age":"26"}，很簡單吧！

　　下面來新增一個Student類，程式碼如下，然後對其進行序列化，Student程式碼：

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

下面來new一個Student，並進行序列化和反序列化，程式碼如下：

            Student stu = new Student() { Name = "Jack", Age = 20 };
            JsonSerializer serializer = new JsonSerializer();
            sw = new StringWriter();
            serializer.Serialize(new JsonTextWriter(sw), stu);
            Console.WriteLine(sw.GetStringBuilder().ToString());

            StringReader sr = new StringReader(sw.GetStringBuilder().ToString());
            Student s = (Student)serializer.Deserialize(new JsonTextReader(sr), typeof(Student));
            Console.WriteLine(s.Name + "=>" + s.Age);

其輸出結果如下：

下面來序列化一個Student列表，看看得到什麼，程式碼如下：

　　　　　　  List<Student> students = new List<Student>();
            Student stu = new Student() { Name = "Jack", Age = 20 };
            Student stu1 = new Student() { Name = "Tom", Age = 21 };
            students.Add(stu);
            students.Add(stu1);
            JsonSerializer serializer = new JsonSerializer();
            sw = new StringWriter();
            serializer.Serialize(new JsonTextWriter(sw), students);
            Console.WriteLine(sw.GetStringBuilder().ToString());

執行結果如下：

看到這個，很熟悉吧，前面剛剛說過怎麼解析這種格式的Json！當然，你們還有一種巢狀形式怎麼生成呢？下面來修改Studnet類，新增電話號碼欄位,修改後的Student類如下：

    public class Student
    {
        public string Name { get; set; }
        public int Age { get; set; }
        public List<string> Phones { get; set; }

    }

序列化程式碼如下：

 　　　　　　 List<Student> students = new List<Student>();
            Student stu = new Student() { Name = "Jack", Age = 20, Phones = new List<string> {"1455655888","15236988985" }};
            Student stu1 = new Student() { Name = "Tom", Age = 21, Phones = new List<string> { "1325889684", "15236988985" }};
            students.Add(stu);
            students.Add(stu1);
            JsonSerializer serializer = new JsonSerializer();
            sw = new StringWriter();
            serializer.Serialize(new JsonTextWriter(sw), students);

            Console.WriteLine(sw.GetStringBuilder().ToString());

輸出Json如下：

看到了吧，是不是前面說到的巢狀型別。解析方法前面也說過了。到這裡，Newtonsoft.Json這個類庫的使用就講完了，當然他還有很多其他的功能等待著大家去發現。

 

如果大家趕緊這篇文章對你有用，請推薦一下或關注我，大家的支援是我最大的動力！

 

 作者：雲霏霏

 部落格地址：http://www.cnblogs.com/yunfeifei/

 宣告：本部落格原創文字只代表本人工作中在某一時間內總結的觀點或結論，與本人所在單位沒有直接利益關係。非商業，未授權，貼子請以現狀保留，轉載時必須保留此段宣告，且在文章頁面明顯位置給出原文連線。