C#-JSON詳解

2019-11-14 14:14:59

字體：大中小

來源：轉載

供稿：網友

最近在做微信開發時用到了一些json的問題，就是把微信返回回來的一些json數據做一些處理，但是之前json掌握的不好，浪費了好多時間在查找一些json有關的轉換問題，我所知道的方法只有把json序列化和反序列化一下，但是太麻煩了我覺得，所以就在找一些更簡單又方便使用的方法。也許這個會有用吧，所以先放到這以后能用到的。

原文出處：http://www.companysz.com/mcgrady/archive/2013/06/08/3127781.html

JSON的全稱是”javaScript Object Notation”，意思是Javascript對象表示法，它是一種基于文本，獨立于語言的輕量級數據交換格式。xml也是一種數據交換格式，為什么沒有選擇XML呢？因為XML雖然可以作為跨平臺的數據交換格式，但是在JS(JavaScript的簡寫)中處理XML非常不方便，同時XML標記比數據多，增加了交換產生的流量，而JSON沒有附加的任何標記，在JS中可作為對象處理，所以我們更傾向于選擇JSON來交換數據。這篇文章主要從以下幾個方面來說明JSON。

1，JSON的兩種結構
2，認識JSON字符串
3，在JS中如何使用JSON
4，在.NET中如何使用JSON
5，總結

JSON的兩種結構

JSON有兩種表示結構，對象和數組。
對象結構以”{”大括號開始，以”}”大括號結束。中間部分由0或多個以”，”分隔的”key(關鍵字)/value(值)”對構成，關鍵字和值之間以”：”分隔，語法結構如代碼。

{    key1:value1,    key2:value2,    ...}

其中關鍵字是字符串，而值可以是字符串，數值，true,false,null,對象或數組

數組結構以”[”開始，”]”結束。中間由0或多個以”，”分隔的值列表組成，語法結構如代碼。

[ 
    { 
        key1:value1, 
        key2:value2  
    }, 
    { 
         key3:value3, 
         key4:value4    
    } 
]

認識JSON字符串

之前我一直有個困惑，分不清普通字符串，json字符串和json對象的區別。經過一番研究終于給弄明白了。比如在js中。

字符串：這個很好解釋，指使用“”雙引號或’’單引號包括的字符。例如：var comStr = 'this is string';
json字符串：指的是符合json格式要求的js字符串。例如：var jsonStr = "{StudentID:'100',Name:'tmac',Hometown:'usa'}";
json對象：指符合json格式要求的js對象。例如：var jsonObj = { StudentID: "100", Name: "tmac", Hometown: "usa" };

在JS中如何使用JSON

JSON是JS的一個子集，所以可以在JS中輕松地讀，寫JSON。讀和寫JSON都有兩種方法，分別是利用”.”操作符和“[key]”的方式。
我們首先定義一個JSON對象，代碼如下。

var obj = {            "1": "value1",            "2": "value2",            count: 3,            person: [ //數組結構JSON對象，可以嵌套使用                        {                            id: 1,                            name: "張倩"                        },                        {                            id: 2,                            name: "張帥"                        }                   ],            object: { //對象結構JSON對象                id: 1,                msg: "對象里的對象"                }        };

1，從JSON中讀數據

function ReadJSON() {            alert(obj.1); //會報語法錯誤，可以用alert(obj["1"]);說明數字最好不要做關鍵字            alert(obj.2); //同上            alert(obj.person[0].name); //或者alert(obj.person[0]["name"])            alert(obj.object.msg); //或者alert(obj.object["msg"])        }

2，向JSON中寫數據

比如要往JSON中增加一條數據，代碼如下：

function Add() {             //往JSON對象中增加了一條記錄            obj.sex= "男" //或者obj["sex"]="男"        }

增加數據后的JSON對象如圖：

json01

3，修改JSON中的數據

我們現在要修改JSON中count的值，代碼如下：

function Update() {            obj.count = 10; //或obj["count"]=10        }

修改后的JSON如圖。

json02

4，刪除JSON中的數據

我們現在實現從JSON中刪除count這條數據，代碼如下：

function Delete() {            delete obj.count;        }

刪除后的JSON如圖

json03

可以看到count已經從JSON對象中被刪除了。

5，遍歷JSON對象

可以使用for…in…循環來遍歷JSON對象中的數據，比如我們要遍歷輸出obj對象的值，代碼如下：

function Traversal() {            for (var c in obj) {                console.log(c + ":", obj[c]);            }        }

程序輸出結果為：

json04

在.NET中如何使用JSON

說到在.net中使用JSON，就不得不提到JSON.NET，它是一個非常著名的在.net中處理JSON的工具，我們最常用的是下面兩個功能。

1，通過序列化將.net對象轉換為JSON字符串

在web開發過程中，我們經常需要將從數據庫中查詢到的數據(一般為一個集合，列表或數組等)轉換為JSON格式字符串傳回客戶端，這就需要進行序列化，這里用到的是JsonConvert對象的SerializeObject方法。其語法格式為：JsonConvert.SerializeObject(object)，代碼中的”object”就是要序列化的.net對象，序列化后返回的是 json字符串。

比如，現在我們有一個TStudent的學生表，表中的字段和已有數據如圖所示

json05 json06

從表中我們可以看到一共有五條數據，現在我們要從數據庫中取出這些數據，然后利用JSON.NET的JsonConvert對象序列化它們為json字符串，并顯示在頁面上。C#代碼如下

 1 PRotected void Page_Load(object sender, EventArgs e) 2         { 3             using (L2SDBDataContext db = new L2SDBDataContext()) 4             { 5                 List<Student> studentList = new List<Student>(); 6                 var query = from s in db.TStudents 7                             select new {  8                                 StudentID=s.StudentID, 9                                 Name=s.Name,10                                 Hometown=s.Hometown,11                                 Gender=s.Gender,12                                 Brithday=s.Birthday,13                                 ClassID=s.ClassID,14                                 Weight=s.Weight,15                                 Height=s.Height,16                                 Desc=s.Desc17                             };18                 foreach (var item in query)  //循環遍歷數組，轉換對象19                 {20                     Student student = new Student { StudentID=item.StudentID,Name=item.Name,Hometown=item.Hometown,Gender=item.Gender,Brithday=item.Brithday,ClassID=item.ClassID,Weight=item.Weight,Height=item.Height,Desc=item.Desc};21                     studentList.Add(student);22                 }23                 lbMsg.InnerText = JsonConvert.SerializeObject(studentList);24             }25         }

View Code

輸出結果

json07

從圖中我們可以看到，數據庫中的5條記錄全部取出來并轉化為json字符串了。

2，使用LINQ to JSON定制JSON數據

使用JsonConvert對象的SerializeObject只是簡單地將一個list或集合轉換為json字符串。但是，有的時候我們的前端框架比如ExtJs對服務端返回的數據格式是有一定要求的，比如下面的數據格式，這時就需要用到JSON.NET的LINQ to JSON，LINQ to JSON的作用就是根據需要的格式來定制json數據。

比如經常用在分頁的json格式如代碼：

{     "total": 5, //記錄總數    "rows":[        //json格式的數據列表    ]}

使用LINQ to JSON前，需要引用Newtonsoft.Json的dll和using Newtonsoft.Json.Linq的命名空間。LINQ to JSON主要使用到JObject, JArray, JProperty和JValue這四個對象，JObject用來生成一個JSON對象，簡單來說就是生成”{}”，JArray用來生成一個JSON數組，也就是”[]”，JProperty用來生成一個JSON數據，格式為key/value的值，而JValue則直接生成一個JSON值。下面我們就用LINQ to JSON返回上面分頁格式的數據。代碼如下：

 1 protected void Page_Load(object sender, EventArgs e) 2         { 3             using (L2SDBDataContext db = new L2SDBDataContext()) 4             { 5                 //從數據庫中取出數據并放到列表list中 6                 List<Student> studentList = new List<Student>(); 7                 var query = from s in db.TStudents 8                             select new 9                             {10                                 StudentID = s.StudentID,11                                 Name = s.Name,12                                 Hometown = s.Hometown,13                                 Gender = s.Gender,14                                 Brithday = s.Birthday,15                                 ClassID = s.ClassID,16                                 Weight = s.Weight,17                                 Height = s.Height,18                                 Desc = s.Desc19                             };20                 foreach (var item in query)21                 {22                     Student student = new Student { StudentID = item.StudentID, Name = item.Name, Hometown = item.Hometown, Gender = item.Gender, Brithday = item.Brithday, ClassID = item.ClassID, Weight = item.Weight, Height = item.Height, Desc = item.Desc };23                     studentList.Add(student);24                 }25 26                 //基于創建的list使用LINQ to JSON創建期望格式的JSON數據27                 lbMsg.InnerText = new JObject(28                         new JProperty("total",studentList.Count),29                         new JProperty("rows",30                                 new JArray(31                                         //使用LINQ to JSON可直接在select語句中生成JSON數據對象，無須其它轉換過程32                                         from p in studentList33                                         select new JObject(34                                                 new JProperty("studentID",p.StudentID),35                                                 new JProperty("name",p.Name),36                                                 new JProperty("homeTown",p.Hometown)37                                             )38                                     )39                             )40                     ).ToString();41             }42         }

View Code

輸出結果為：

json08

3，處理客戶端提交的JSON數據

客戶端提交過來的數據一般都是json字符串，有了更好地進行操作（面向對象的方式），所以我們一般都會想辦法將json字符串轉換為json對象。例如客戶端提交了以下數組格式json字符串。

[    {StudentID:"100",Name:"aaa",Hometown:"china"},    {StudentID:"101",Name:"bbb",Hometown:"us"},    {StudentID:"102",Name:"ccc",Hometown:"england"}]

在服務端就可以使用JObject或JArray的Parse方法輕松地將json字符串轉換為json對象，然后通過對象的方式提取數據。下面是服務端代碼。

 1 protected void Page_Load(object sender, EventArgs e) 2         { 3             string inputJsonString = @" 4                 [ 5                     {StudentID:'100',Name:'aaa',Hometown:'china'}, 6                     {StudentID:'101',Name:'bbb',Hometown:'us'}, 7                     {StudentID:'102',Name:'ccc',Hometown:'england'} 8                 ]"; 9             JArray jsonObj = JArray.Parse(inputJsonString);10             string message = @"<table border='1'>11                     <tr><td width='80'>StudentID</td><td width='100'>Name</td><td width='100'>Hometown</td></tr>";12             string tpl = "<tr><td>{0}</td><td>{1}</td><td>{2}</td></tr>";13             foreach (JObject jObject in jsonObj)14             {15                 message += String.Format(tpl, jObject["StudentID"], jObject["Name"],jObject["Hometown"]);16             }17             message += "</table>";18             lbMsg.InnerHtml = message;19         }

View Code

輸出結果：

json09

當然，服務端除了使用LINQ to JSON來轉換json字符串外，也可以使用JsonConvert的DeserializeObject方法。如下面代碼實現上面同樣的功能。

List<Student> studentList = JsonConvert.DeserializeObject<List<Student>>(inputJsonString);//注意這里必須為List<Student>類型,因為客戶端提交的是一個數組json            foreach (Student student in studentList)            {                message += String.Format(tpl, student.StudentID, student.Name,student.Hometown);            }

總結

在客戶端，讀寫json對象可以使用”.”操作符或”["key”]”，json字符串轉換為json對象使用eval()函數。
在服務端，由.net對象轉換json字符串優先使用JsonConvert對象的SerializeObject方法，定制輸出json字符串使用LINQ to JSON。由json字符串轉換為.net對象優先使用JsonConvert對象的DeserializeObject方法，然后也可以使用LINQ to JSON。

根據所需調用方法就行。不過也可以用Newtonsoft.Json這個dll文件，如果轉換數組的話就用

1 JObject json = (JObject)JsonConvert.DeserializeObject(str);2         JArray array = (JArray)json["article"];3  foreach (var jObject in array)4         {5           //賦值屬性6 }