http://book.2cto.com/201301/15190.html
1. JSON.NET概述
当JSON逐渐成为Ajax的标准数据交互格式时,在.NET中处理JSON数据只能使用字符串拼接的方法,十分麻烦,因而催生了JSON.NET这个项目。
JSON.NET是一个免费的开源项目,大家可以登录http://json.codeplex.com/下载最新版本,本书使用的版本是4.0 release 1,本节的示例将使用该版本进行演示。
JSON.NET的功能有很多,本书主要讲述以下两个Ext JS项目常用的功能:
通过序列化方法将.NET对象转换为JSON对象。
使用LINQ to JSON读写JSON对象。
2. 配置JSON.NET
在JSON.NET压缩包的bin目录下有Net、Net20、Net35、Silverlight和WindowsPhone5个目录,目录里有对应不同.Net Framework版本的库文件,根据使用的.Net Framework版本使用对应的库文件就可以了。譬如本书的例子使用的是.Net Framework 4.0版本,因而将Net35目录下的Newtonsoft.Json.Net35.dll文件添加到项目的bin目录就可以了。
要使用序列化功能,需在代码中加入以下引用代码:
using Newtonsoft.Json;
如果要使用LINQ to JSON,需在代码中加入以下引用代码:
using Newtonsoft.Json.Linq;
3. 序列化
在开发Web应用时,一般都需要将数据库查询出的数据转换为JSON格式文本传送回客户端,这就需要进行序列化。在JSON.NET中,要进行序列化,常用的是JsonConvert对象的SerializeObject方法。其基本的语法格式如下:
JsonConvert.SerializeObject(object)
代码中“object”就是要序列化的.NET对象。序列化后的返回值是字符串。
下面我们通过一个例子来加深一下认识。例子主要实现的功能是将微软示例数据库“Northwnd”中客户表(Customers)的所有客户数据以JSON格式返回客户端,其代码如下:
public string Message { get; set; }
protected void Page_Load(object sender,EventArgs e)
{
NorthwindEntities ne = new NorthwindEntities();
var q = ne.Customers.OrderBy(m=>m.CompanyName)
.Select(m=>new {
m.CustomerID,
m.CompanyName,
m.Country,
m.City,
m.Address,
m.PostalCode,
m.Phone,
m.Region
});
Message = JsonConvert.SerializeObject(q);
}
代码中,首先从实体模型中查询出数据集合“q”,然后将数据集合“q”序列化成JSON格式字符串并赋值给变量“Message”,最后在页面中输出。在@L_301_2@中打开页面将看到以下的结果:
[{"CustomerID":"ALFKI","CompanyName":"Alfreds Futterkiste","Country":"Germany","City":"Berlin","Address":"Obere Str. 57","PostalCode":"12209","Phone":"030-0074321","Region":null},
…,
{"CustomerID":"WOLZA","CompanyName":"Wolski Zajazd","Country":"Poland","City":"Warszawa","Address":"ul. Filtrowa 68","PostalCode":"01-012","Phone":"(26) 642-7012","Region":null}]
从上面的例子可以看到,将查询数据序列化成JSON文本是一件非常简单的事。其实,对.NET对象的序列化还有很多方式,囿于篇幅,本书就不一一介绍了,有兴趣可以详细阅读JSON.NET的文档。
4. LINQ to JSON
事实上,Ext JS对数据返回的格式是有一定要求的,并不是简单地返回序列化后的数据就行,这时就需要用到LINQ to JSON。LINQ to JSON的作用就是根据需要的JSON格式组织文本数据。
LINQ to JSON需要使用到JObject、JArray、JPropery和JValue 4个对象,这4个对象的详细说明如表1-1所示。
表1-1 LINQ to JSON对象说明
对 象说 明
JObject 生成一个JSON对象,形象点来说就是生成“{}”
JArray 生成一个JSON数组,形象点来说就是生成“[]”
JProperty 生成一个JSON数据,格式如下:
JProperty(name,value)
name:类型为字符串,关键字
value:类型为对象,值
JValue 直接生成一个JSON值。在生成仅有值的数组时,就需要使用JValue进行转换。其格式如下:
JValue(value)
value:类型为对象,值
下面我们通过一个例子说明如何使用LINQ to JSON。Ext JS的所需JSON格式数据一般如下:
{
"total":5,//记录总数
"rows":[
//JSON对象格式的数据列表
]
}
示例将演示如何根据以上格式返回客户表数据,代码如下:
public string Message { get; set; }
protected void Page_Load(object sender,EventArgs e)
{
NorthwindEntities ne = new NorthwindEntities();
var q = ne.Customers.OrderBy(m => m.CompanyName)
.Select(m => new
{
m.CustomerID,
m.ContactName
}
).ToList();
Message = new JObject(
new JProperty("total",q.Count()),//创建记录总数
new JProperty("rows",
new JArray( //创建数据数组
from p in q
select new JObject(
new JProperty("id",p.CustomerID),
new JProperty("cpname",p.CompanyName),
new JProperty("contactName",p.ContactName)
)
)
)
).ToString();
}
从上面的代码可以看到,构建固定格式的JSON数据是相当直观的。将粗体代码与格式数据对比,可以看到,最外层的JObject创建了格式中最外层的“{}”,然后依次使用JProperty生成记录总数数据和数据列表。而代码中的JArray的作用就是生成“[]”,将使用LINQ to JSON方式生成的一个个数据对象组合成数组。本来是希望直接通过LINQ to JSON将实体模型转换成JSON的,但这样会产生“LINQ to Entities 仅支持无参数构造函数和初始值设定项”的错误,因而本示例先将查询的数据转换为列表(ToList()),再进行转换。使用LINQ to JSON可直接在select语句生成JSON数据对象,无须其他转换过程,相当方便。在使用select语句生成数据对象时,首先使用JObject生成“{}”,然后使用JProperty生成对象的数据。
在@L_301_2@中打开页面,将看到以下的结果:
{ "total": 91,"rows": [ { "id": "ALFKI","cpname": "Alfreds Futterkiste","contactName": "Maria Anders" },{ "id": "ANATR","cpname": "Ana Trujillo Emparedadosy helados","contactName": "Ana Trujillo" },
{ "id": "WOLZA","cpname": "Wolski Zajazd","contactName": "Zbyszek Piestrzeniewicz" } ] }
注意 千万不要使用序列化的方式生成“rows”的值,如下面的代码:
new JProperty("rows",JsonConvert.SerializeObject(q)) ;
因为这样生成的“rows”值是字符串,而不是数组。
5. 处理客户端提交的JSON数据
有时候,在客户端以JSON格式将数据提交到服务器比较方便。譬如,直接在Grid修改了不同行和列的数据,最后一次性将修改的数据提交到服务器端处理,这时候,使用JSON格式提交数据会很方便,例如以下提交的数据:
[
{id:"12345",title:"文章一",author:"李四"},
{id:"12367",author:"张三"},
{id:"17777",isShow:true}
]
数据表示在Grid中修改了3行数据,第1行修改了标题(title)和作者(author),第2行修改了作者,第3行修改了是否显示(isShow)。
在服务器端使用JObject或JArray的Parse方法就可轻松地将字符串转换为JSON对象,然后通过对象的方法提取数据,下面是服务器端的处理代码:
public string Message { get; set; }
protected void Page_Load(object sender,EventArgs e)
{
string jsonString = @"
[
{id:'12345',title:'文章一',author:'李四'},
{id:'12367',author:'张三'},
{id:'17777',isShow:true}
]
";
JArray json = JArray.Parse(jsonString);
Message = @"<table border='1'>
<tr><td width='80'>ID</td><td width='100'>字段</td><td width='100'> 值</td></tr>
";
string tpl = "<tr><td>{0}</td><td>{1}</td><td>{2}</td></tr>";
foreach (JObject jobject in json)
{
foreach (var a in jobject)
{
if(a.Value.ToString()!="id")
Message += String.Format(tpl,(string)jobject["id"],a.Key,a.Value);
}
}
Message += "</table>";
在代码中,因为已知数据是使用数组形式提交的,所以采用JArray的Parse方法。
什么?你不知道数据是以数组还是对象形式提交?
这……
数据的提交方式应该是一种双方的约定,不然要处理未知的数据会很麻烦,所以不用担心这个问题。
第1层foreach循环用来获取JObject对象。第2层foreach用来获取修改过的字段名称。在这里要注意,数据默认已约定存在id这个字段。
代码运行后将看到如图1-4所示结果。
从结果可以看到,数据已经被分拆出来,这样你就可以根据id和字段去更新数据库了。