您现在的位置是:门户> 编程语言> ASP.NET

在.NET使用JSON作为数据交换格式实例演示
2021-02-23 7人围观 0条评论
简介JSON(JavaScript Object Notation)是一种轻量级轻量级的数据交换格式,并且它独立于编程语言,接下来为大家介绍下使用JSON作为数据交换格式在.net中的应用
    我们知道在NET中我们有多种对象序列化的方式,如XML方式序列化、Binary序列化,其中XML序列化是一种比较通用的在各语言之间传递数据的方式。除了这两种序列化方式之外,在NET中还可以使用JSON序列化。

    JSON(JavaScript Object Notation)是一种轻量级轻量级的数据交换格式,并且它独立于编程语言,与XML序列化相比,JSON序列化后产生的数据一般要比XML序列化后数据体积小,所以在Facebook等知名网站中都采用了JSON作为数据交换方式。在NET中有三种常用的JSON序列化的类,分别是  SystemWebScriptSerializationJavaScriptSerializer类、SystemRuntimeSerializationJsonDataContractJsonSerializer类和NewtonsoftJsonJsonConvert类。

    为了便于下面的演示,下面提供一个类的代码

    复制代码 代码如下:

    [DataContract]
    publicclass User
    {
    ///
    /// 编号
    ///
    [DataMember]
    publicint UserId { get; set; }
    ///
    /// 用户名
    ///
    [DataMember]
    publicstring UserName { get; set; }
    ///
    /// 创建时间
    ///
    [DataMember]
    [JsonConverter(typeof(IsoDateTimeConverter))]
    public DateTime CreateDate { get; set; }
    ///
    /// 生日
    ///
    [DataMember]
    [JsonConverter(typeof(JavaScriptDateTimeConverter))]
    public DateTime Birthday { get; set; }
    ///
    /// 相关URL
    ///
    [DataMember]
    public List Urls { get; set; }
    ///
    /// 薪水
    ///
    //[ScriptIgnore]//使用JavaScriptSerializer序列化时不序列化此字段
    //[IgnoreDataMember]//使用DataContractJsonSerializer序列化时不序列化此字段
    //[JsonIgnore]//使用JsonConvert序列化时不序列化此字段
    publicint Salary { get; set; }
    ///
    /// 权利级别
    ///
    [DataMember]
    public Priority Priority { get; set; }
    public User()
    {
    Urls =new List();
    }
    }
    ///
    /// 权利级别
    ///
    publicenum Priority:byte
    {
    Lowest=0x1,
    BelowNormal=0x2,
    Normal=0x4,
    AboveNormal=0x8,
    Highest=0x16
    }

    使用SystemWebScriptSerializationJavaScriptSerializer类
      SystemWebScriptSerializationJavaScriptSerializer类是NET类库中自带的一种JSON序列化实现,在NET Framework5及以后版本中可以使用这个类,这个类位于SystemWebExtensionsdll中,使用这个类是必须添加对这个dll的引用。
      下面的代码是使用JavaScriptSerializer进行序列化和反序列化的例子:
    复制代码 代码如下:

    publicstaticvoid JavaScriptSerializerDemo()
    {
    User user =new User { UserId =1, UserName ="李刚", CreateDate = DateTimeNowAddYears(-30),Birthday=DateTimeNowAddYears(-50), Priority = PriorityHighest, Salary =500000 };
    //JavaScriptSerializer类在SystemWebExtensionsdll中,注意添加这个引用
    JavaScriptSerializer serializer =new JavaScriptSerializer();
    //JSON序列化
    string result=serializerSerialize(user);
    ConsoleWriteLine("使用JavaScriptSerializer序列化后的结果:{0},长度:{1}", result, resultLength);
    //JSON反序列化
    user = serializerDeserialize(result);
    ConsoleWriteLine("使用JavaScriptSerializer反序列化后的结果:UserId:{0},UserName: {1},CreateDate:{2},Priority:{3}", userUserId, userUserName, userCreateDate, userPriority);
    }

    说明:如果不想序列化某个字段,可以在字段前面加[JsonIgnore]标记。
      使用SystemRuntimeSerializationJsonDataContractJsonSerializer类
      SystemRuntimeSerializationJsonDataContractJsonSerializer类位于SystemServiceModelWebdll中,使用这个类时除了需要添加对SystemServiceModelWebdll的引用之外,还需要添加SystemRuntimeSerializationdll的引用,注意这个类也是在NET Framework5及以后版本中可以使用。
      下面是使用DataContractJsonSerializer类的例子:
    复制代码 代码如下:

    publicstaticvoid DataContractJsonSerializerDemo()
    {
    User user =new User { UserId =1, UserName ="李刚", CreateDate = DateTimeNowAddYears(-30), Birthday = DateTimeNowAddYears(-50), Priority = PriorityAboveNormal, Salary =50000 };
    string result =stringEmpty;
    //DataContractJsonSerializer类在SystemServiceModelWebdll中,注意添加这个引用
    DataContractJsonSerializer serializer =new DataContractJsonSerializer(typeof(User));
    using (MemoryStream stream =new MemoryStream())
    {
    //JSON序列化
    serializerWriteObject(stream, user);
    result = EncodingUTFGetString(streamToArray());
    ConsoleWriteLine("使用DataContractJsonSerializer序列化后的结果:{0},长度:{1}", result, resultLength);
    }
    //JSON反序列化
    byte[] buffer = EncodingUTFGetBytes(result);
    using (MemoryStream stream =new MemoryStream(buffer))
    {
    user = serializerReadObject(stream) as User;
    ConsoleWriteLine("使用DataContractJsonSerializer反序列化后的结果:UserId: {0},UserName:{1},CreateDate:{2},Priority:{3}", userUserId, userUserName, userCreateDate, userPriority);
    }
    }

    注意:要使用DataContractJsonSerializer类进行序列化和反序列化,必须给类加上[DataContract]属性,对要序列化的字段加上[DataMember]属性,如果不想序列化某个字段或者属性,可以加上[IgnoreDataMember]属性。
      使用NewtonsoftJsonJsonConvert类
      NewtonsoftJsonJsonConvert类是非微软提供的一个JSON序列化和反序列的开源免费的类库(下载网址是:http://wwwcodeplexcom/json/),它提供了更灵活的序列化和反序列化控制,并且如果你的开发环境使用的是NET Framework5及以后版本的话,你就可以使用Linq to JSON,这样一来面对一大段的数据不必一一解析,你可以使用Linq to JSON解析出你关心的那部分即可,非常方便。
      下面是使用NewtonsoftJsonJsonConvert类的例子:
    复制代码 代码如下:

    publicstaticvoid JsonConvertDemo()
    {
    User user =new User { UserId =1, UserName ="李刚", CreateDate = DateTimeNowAddYears(-30), Birthday = DateTimeNowAddYears(-50), Priority = PriorityBelowNormal, Salary =5000 };
    //JsonConvert类在NewtonsoftJsonNetdll中,注意到http://wwwcodeplexcom/json/下载这个dll并添加这个引用
    //JSON序列化
    string result = JsonConvertSerializeObject(user);
    ConsoleWriteLine("使用JsonConvert序列化后的结果:{0},长度:{1}", result, resultLength);
    //JSON反序列化
    user = JsonConvertDeserializeObject(result);
    ConsoleWriteLine("使用JsonConvert反序列化后的结果:UserId:{0},UserName: {1},CreateDate:{2},Priority:{3}", userUserId, userUserName, userCreateDate, userPriority);
    }
    publicstaticvoid JsonConvertLinqDemo()
    {
    User user =new User { UserId =1, UserName ="周公", CreateDate = DateTimeNowAddYears(-8), Birthday = DateTimeNowAddYears(-32), Priority = PriorityLowest, Salary =500, Urls =new List { "http://zhoufoxcnblog51ctocom", "//www.jb51.net" } };
    //JsonConvert类在NewtonsoftJsonNetdll中,注意到http://wwwcodeplexcom/json/下载这个dll并添加这个引用
    //JSON序列化
    string result = JsonConvertSerializeObject(user);
    ConsoleWriteLine("使用JsonConvert序列化后的结果:{0},长度:{1}", result, resultLength);
    //使用Linq to JSON
    JObject jobject = JObjectParse(result);
    JToken token = jobject["Urls"];
    List urlList =new List();
    foreach (JToken t in token)
    {
    urlListAdd(tToString());
    }
    ConsoleWrite("使用Linq to JSON反序列化后的结果:[");
    for (int i =0; i < urlListCount -1;i++ )
    {
    ConsoleWrite(urlList[i] +",");
    }
    ConsoleWriteLine(urlList[urlListCount -1] +"]");
    }

    注意:如果有不需要序列化的字段,可以给该字段添加[JsonIgnore]标记。在Newtonsoft这个类库中对于日期的序列化有多种方式,可以类的DataTime成员添加上对应的标记,这样在进行序列化和反序列化时就会按照指定的方式进行,在本例中User类的CreateDate属性添加的属性是[JsonConverter(typeof(IsoDateTimeConverter))],而Birthday属性添加的属性是[JsonConverter(typeof(JavaScriptDateTimeConverter))],从序列化的结果可以看出来它们最终的表现形式并不一样。
      本文中所有的示例代码如下:
    复制代码 代码如下:

    using System;
    using SystemCollectionsGeneric;
    using SystemLinq;
    using SystemText;
    using SystemWebScriptSerialization;
    using SystemRuntimeSerializationJson;
    using SystemIO;
    using SystemRuntimeSerialization;
    using NewtonsoftJson;
    using NewtonsoftJsonLinq;
    using NewtonsoftJsonConverters;
    namespace JSONDemo
    {
    class Program
    {
    staticvoid Main(string[] args)
    {
    JavaScriptSerializerDemo();
    DataContractJsonSerializerDemo();
    JsonConvertDemo();
    JsonConvertLinqDemo();
    ConsoleReadLine();
    }
    publicstaticvoid JavaScriptSerializerDemo()
    {
    User user =new User { UserId =1, UserName ="李刚", CreateDate = DateTimeNowAddYears(-30),Birthday=DateTimeNowAddYears(-50), Priority = PriorityHighest, Salary =500000 };
    //JavaScriptSerializer类在SystemWebExtensionsdll中,注意添加这个引用
    JavaScriptSerializer serializer =new JavaScriptSerializer();
    //JSON序列化
    string result=serializerSerialize(user);
    ConsoleWriteLine("使用JavaScriptSerializer序列化后的结果:{0},长度:{1}", result, resultLength);
    //JSON反序列化
    user = serializerDeserialize(result);
    ConsoleWriteLine("使用JavaScriptSerializer反序列化后的结果:UserId:{0},UserName:{1},CreateDate:{2},Priority:{3}", userUserId, userUserName, userCreateDate, userPriority);
    }
    publicstaticvoid DataContractJsonSerializerDemo()
    {
    User user =new User { UserId =1, UserName ="李刚", CreateDate = DateTimeNowAddYears(-30), Birthday = DateTimeNowAddYears(-50), Priority = PriorityAboveNormal, Salary =50000 };
    string result =stringEmpty;
    //DataContractJsonSerializer类在SystemServiceModelWebdll中,注意添加这个引用
    DataContractJsonSerializer serializer =new DataContractJsonSerializer(typeof(User));
    using (MemoryStream stream =new MemoryStream())
    {
    //JSON序列化
    serializerWriteObject(stream, user);
    result = EncodingUTFGetString(streamToArray());
    ConsoleWriteLine("使用DataContractJsonSerializer序列化后的结果:{0},长度:{1}", result, resultLength);
    }
    //JSON反序列化
    byte[] buffer = EncodingUTFGetBytes(result);
    using (MemoryStream stream =new MemoryStream(buffer))
    {
    user = serializerReadObject(stream) as User;
    ConsoleWriteLine("使用DataContractJsonSerializer反序列化后的结果:UserId:{0},UserName:{1},CreateDate:{2},Priority:{3}", userUserId, userUserName, userCreateDate, userPriority);
    }
    }
    publicstaticvoid JsonConvertDemo()
    {
    User user =new User { UserId =1, UserName ="李刚", CreateDate = DateTimeNowAddYears(-30), Birthday = DateTimeNowAddYears(-50), Priority = PriorityBelowNormal, Salary =5000 };
    //JsonConvert类在NewtonsoftJsonNetdll中,注意到http://wwwcodeplexcom/json/下载这个dll并添加这个引用
    //JSON序列化
    string result = JsonConvertSerializeObject(user);
    ConsoleWriteLine("使用JsonConvert序列化后的结果:{0},长度:{1}", result, resultLength);
    //JSON反序列化
    user = JsonConvertDeserializeObject(result);
    ConsoleWriteLine("使用JsonConvert反序列化后的结果:UserId:{0},UserName:{1},CreateDate:{2},Priority:{3}", userUserId, userUserName, userCreateDate, userPriority);
    }
    publicstaticvoid JsonConvertLinqDemo()
    {
    User user =new User { UserId =1, UserName ="周公", CreateDate = DateTimeNowAddYears(-8), Birthday = DateTimeNowAddYears(-32), Priority = PriorityLowest, Salary =500, Urls =new List { "http://zhoufoxcnblog51ctocom", "//www.jb51.net" } };
    //JsonConvert类在NewtonsoftJsonNetdll中,注意到http://wwwcodeplexcom/json/下载这个dll并添加这个引用
    //JSON序列化
    string result = JsonConvertSerializeObject(user);
    ConsoleWriteLine("使用JsonConvert序列化后的结果:{0},长度:{1}", result, resultLength);
    //使用Linq to JSON
    JObject jobject = JObjectParse(result);
    JToken token = jobject["Urls"];
    List urlList =new List();
    foreach (JToken t in token)
    {
    urlListAdd(tToString());
    }
    ConsoleWrite("使用Linq to JSON反序列化后的结果:[");
    for (int i =0; i < urlListCount -1;i++ )
    {
    ConsoleWrite(urlList[i] +",");
    }
    ConsoleWriteLine(urlList[urlListCount -1] +"]");
    }
    }
    [DataContract]
    publicclass User
    {
    ///
    /// 编号
    ///
    [DataMember]
    publicint UserId { get; set; }
    ///
    /// 用户名
    ///
    [DataMember]
    publicstring UserName { get; set; }
    ///
    /// 创建时间
    ///
    [DataMember]
    [JsonConverter(typeof(IsoDateTimeConverter))]
    public DateTime CreateDate { get; set; }
    ///
    /// 生日
    ///
    [DataMember]
    [JsonConverter(typeof(JavaScriptDateTimeConverter))]
    public DateTime Birthday { get; set; }
    ///
    /// 相关URL
    ///
    [DataMember]
    public List Urls { get; set; }
    ///
    /// 薪水
    ///
    [ScriptIgnore]//使用JavaScriptSerializer序列化时不序列化此字段
    [IgnoreDataMember]//使用DataContractJsonSerializer序列化时不序列化此字段
    [JsonIgnore]//使用JsonConvert序列化时不序列化此字段
    publicint Salary { get; set; }
    ///
    /// 权利级别
    ///
    [DataMember]
    public Priority Priority { get; set; }
    public User()
    {
    Urls =new List();
    }
    }
    ///
    /// 权利级别
    ///
    publicenum Priority:byte
    {
    Lowest=0x1,
    BelowNormal=0x2,
    Normal=0x4,
    AboveNormal=0x8,
    Highest=0x16
    }
    }

    程序的运行结果如下
    1.使用JavaScriptSerializer序列化后的结果:{"UserId":1,"UserName":"李刚","CreateDate":"\/Date(353521211984)\/","Birthday":"\/Date(-277630788015)\/","Urls":[],"Priority":22},长度:127
    2.使用JavaScriptSerializer反序列化后的结果:UserId:1,UserName:李刚,CreateDate:1981-3-15 16:20:11,Priority:Highest
    3.使用DataContractJsonSerializer序列化后的结果:{"Birthday":"\/Date(-277630787953+0800)\/","CreateDate":"\/Date(353521212046+0800)\/","Priority":8,"Urls":[],"UserId":1,"UserName":"李刚"},长度:136
    4.使用DataContractJsonSerializer反序列化后的结果:UserId:1,UserName:李刚,CreateDate:1981-3-16 0:20:12,Priority:AboveNormal
    5.使用JsonConvert序列化后的结果:{"UserId":1,"UserName":"李刚","CreateDate":"1981-03-16T00:20:12.1875+08:00","Birthday":new Date(-277630787812),"Urls":[],"Priority":2},长度:132
    6.使用JsonConvert反序列化后的结果:UserId:1,UserName:李刚,CreateDate:1981-3-16 0:20:12,Priority:BelowNormal
    7.使用JsonConvert序列化后的结果:{"UserId":1,"UserName":"周公","CreateDate":"2003-03-16T00:20:12.40625+08:00","Birthday":new Date(290362812406),"Urls":["http://office.jb51.net","//www.jb51.net/web"],"Priority":1},长度:198
    8.使用Linq to JSON反序列化后的结果:["http://office.jb51.net",//www.jb51.net/web]

    总结:通过上面的例子大家可以看出Newtonsoft类库提供的JSON序列化和反序列的方式更加灵活,在实际开发中周公也一直使用Newtonsoft作为JSON序列化和反序列化的不二选择。
分享:

文章评论

    • wxpython 学习笔记 第一天
    • python文本数据处理学习笔记详解