C#解析json文件的方法

╄→гoц情女王★ 提交于 2020-08-16 06:01:54

 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。
  • 数据由逗号分隔:
  • 花括号保存对象:对象可以包含各种数据,包括数组。
  • 方括号保存数组:数字可以包含对象。

例如:

复制代码

{
    "employees": [
        {
            "firstName": "Bill",
            "lastName": "Gates"
        },
        {
            "firstName": "George",
            "lastName": "Bush"
        }
    ]
}










复制代码

2. 如果JSON中含有转义字符,则需要转义。例如文件路径中需要使用"\\"而不是"\"。例如:{ "file":"C:\\a.txt"}。

 

.NET操作JSON
  JSON文件读入到内存中就是字符串,.NET操作JSON就是生成与解析JSON字符串。操作JSON通常有以下几种方式:
1. 原始方式:自己按照JSON的语法格式,写代码直接操作JSON字符串。如非必要,应该很少人会走这条路,从头再来的。

2. 通用方式【★★★★★】

这种方式是使用开源的类库Newtonsoft.Json(下载地址http://json.codeplex.com/)。下载后加入工程就能用。通常可以使用JObject, JsonReader, JsonWriter处理。这种方式最通用,也最灵活,可以随时修改不爽的地方。
(1)使用JsonReader读Json字符串:

复制代码

string jsonText = @"{""input"" : ""value"", ""output"" : ""result""}";
JsonReader reader = new JsonTextReader(new StringReader(jsonText));

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





复制代码

(2)使用JsonWriter写字符串:

复制代码

StringWriter sw = new StringWriter();
JsonWriter writer = new JsonTextWriter(sw);

writer.WriteStartObject();
writer.WritePropertyName("input");
writer.WriteValue("value");
writer.WritePropertyName("output");
writer.WriteValue("result");
writer.WriteEndObject();
writer.Flush();

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











复制代码

 (3)使用JObject读写字符串:

JObject jo = JObject.Parse(jsonText);
string[] values = jo.Properties().Select(item => item.Value.ToString()).ToArray();

 (4)使用JsonSerializer读写对象(基于JsonWriter与JsonReader): 

数组型数据

复制代码

string jsonArrayText1 = "[{'a':'a1','b':'b1'},{'a':'a2','b':'b2'}]";
JArray ja = (JArray)JsonConvert.DeserializeObject(jsonArrayText1);
string ja1a = ja[1]["a"].ToString();
//或者
JObject o = (JObject)ja[1];
string oa = o["a"].ToString();

复制代码

嵌套格式

string jsonText = "{\"beijing\":{\"zone\":\"海淀\",\"zone_en\":\"haidian\"}}";
JObject jo = (JObject)JsonConvert.DeserializeObject(jsonText);
string zone = jo["beijing"]["zone"].ToString();
string zone_en = jo["beijing"]["zone_en"].ToString();

自定义类Project

复制代码

Project p = new Project() { Input = "stone", Output = "gold" };
JsonSerializer serializer = new JsonSerializer();
StringWriter sw = new StringWriter();
serializer.Serialize(new JsonTextWriter(sw), p);
Console.WriteLine(sw.GetStringBuilder().ToString());

StringReader sr = new StringReader(@"{""Input"":""stone"", ""Output"":""gold""}");
Project p1 = (Project)serializer.Deserialize(new JsonTextReader(sr), typeof(Project));
Console.WriteLine(p1.Input + "=>" + p1.Output);







复制代码

  上面的代码都是基于下面这个Project类定义:

class Project
{
    public string Input { get; set; }
    public string Output { get; set; }
}



  此外,如果上面的JsonTextReader等类编译不过的话,说明是我们自己修改过的类,换成你们自己的相关类就可以了,不影响使用。

3. 内置方式:使用.NET Framework 3.5/4.0中提供的System.Web.Script.Serialization命名空间下的JavaScriptSerializer类进行对象的序列化与反序列化,很直接。

复制代码

 Project p = new Project() { Input = "stone", Output = "gold" };
 JavaScriptSerializer serializer = new JavaScriptSerializer();
 var json = serializer.Serialize(p);
 Console.WriteLine(json);

 var p1 = serializer.Deserialize<Project>(json);
 Console.WriteLine(p1.Input + "=>" + p1.Output);
 Console.WriteLine(ReferenceEquals(p,p1));






复制代码

  注意:如果使用的是VS2010,则要求当前的工程的Target Framework要改成.Net Framework 4,不能使用Client Profile。当然这个System.Web.Extensions.dll主要是Web使用的,直接在Console工程中用感觉有点浪费资源。
  此外,从最后一句也可以看到,序列化与反序列化是深拷贝的一种典型的实现方式

4. 契约方式:使用System.Runtime.Serialization.dll提供的DataContractJsonSerializer或者 JsonReaderWriterFactory实现。

复制代码

Project p = new Project() { Input = "stone", Output = "gold" };
DataContractJsonSerializer serializer = new DataContractJsonSerializer(p.GetType());
string jsonText;

using (MemoryStream stream = new MemoryStream())
{
    serializer.WriteObject(stream, p);
    jsonText = Encoding.UTF8.GetString(stream.ToArray());
    Console.WriteLine(jsonText);
}

using (MemoryStream ms = new MemoryStream(Encoding.UTF8.GetBytes(jsonText)))
{
    DataContractJsonSerializer serializer1 = new DataContractJsonSerializer(typeof(Project));
    Project p1 = (Project)serializer1.ReadObject(ms);
    Console.WriteLine(p1.Input + "=>" + p1.Output);
}















复制代码

  这里要注意,这里的Project类和成员要加相关的Attribute:

复制代码

[DataContract]
class Project
{
    [DataMember]
    public string Input { get; set; }
    [DataMember]
    public string Output { get; set; }
}






复制代码

 

 

C#使用Newtonsoft.Json(Json.NET)的创建Json文件和解析

一、添加引用

using Newtonsoft.Json;

二、调用代码

 
  1. //获取图书列表

  2. List<BookInfo> bookList = GetBookList();

  3.  
  4. //将图书列表转换成Json

  5. string bookListJson = JsonConvert.SerializeObject(bookList);

  6.  
  7. //将Json转换回图书列表

  8. List<BookInfo> books = JsonConvert.DeserializeObject<List<BookInfo>>(bookListJson);

  9.  

三、将对象保存为.json文件到本地、解析本地.json文件为对象

 
  1. //获取图书列表

  2. List<BookInfo> bookList = GetBookList();

  3.  
  4. //将图书列表转换成Json

  5. string bookListJson = JsonConvert.SerializeObject(bookList);

  6.  
  7. Console.WriteLine(bookListJson);

  8.  
  9. writeJsonFile(@"e:\booklist.json", bookListJson);

  10.  
  11. //将序列化的json字符串内容写入Json文件,并且保存

  12. void writeJsonFile(string path, string jsonConents)

  13. {

  14. using (FileStream fs = new FileStream(path, FileMode.OpenOrCreate, System.IO.FileAccess.ReadWrite, FileShare.ReadWrite))

  15. {

  16. using (StreamWriter sw = new StreamWriter(fs, Encoding.UTF8))

  17. {

  18. sw.WriteLine(jsonConents);

  19. }

  20. }

  21. }

  22.  
  23.  
  24.  
  25. //将Json转换回图书列表

  26. string jsonData = GetJsonFile(@"e:\booklist.json");

  27. Console.WriteLine(jsonData);

  28.  
  29. //获取到本地的Json文件并且解析返回对应的json字符串

  30. string GetJsonFile(string filepath)

  31. {

  32. string json = string.Empty;

  33. using (FileStream fs = new FileStream(filepath, FileMode.OpenOrCreate, System.IO.FileAccess.ReadWrite, FileShare.ReadWrite))

  34. {

  35. using (StreamReader sr = new StreamReader(fs, Encoding.UTF8))

  36. {

  37. json = sr.ReadToEnd().ToString();

  38. }

  39. }

  40. return json;

  41.  
  42. }

  43. //反序列化Json字符串内容为图书对象

  44. List<BookInfo> books = JsonConvert.DeserializeObject<List<BookInfo>>(jsonData);

  45.  
  46. foreach (var item in books)

  47. {

  48. Console.WriteLine("图书ID="+item.BookId);

  49. Console.WriteLine("图书标题=" + item.Title);

  50. Console.WriteLine("图书类别=" + item.Category);

  51. Console.WriteLine("图书作者" + item.Author);

  52. Console.WriteLine("出版日期=" + item.PublishDate);

  53. Console.WriteLine("销售价格=" + item.Price);

  54. }

效果图:

四、其他代码:

 
  1.  
  2. /// <summary>

  3. /// 图书信息实体类

  4. /// </summary>

  5. public class BookInfo

  6. {

  7.  
  8. public int BookId { set; get; } //图书ID

  9.  
  10. public string Title { set; get; } //图书名称

  11.  
  12. public string Category { set; get; } //图书分类

  13.  
  14. public string Author { set; get; } //图书作者

  15.  
  16. public DateTime PublishDate { set; get; } //出版时间

  17.  
  18. public Double Price { set; get; } //销售价格

  19.  
  20. }

 
  1.  
  2. /// <summary>

  3. /// 获取图书列表

  4. /// </summary>

  5. /// <returns></returns>

  6. public List<BookInfo> GetBookList()

  7. {

  8. List<BookInfo> bookList = new List<BookInfo>();

  9.  
  10. BookInfo book1 = new BookInfo()

  11. {

  12. BookId = 1,

  13. Category = "CHILDREN",

  14. Title = "Harry Potter",

  15. Author = "J K. Rowling",

  16. PublishDate = new DateTime(2005, 08, 15),

  17. Price = 29.99

  18. };

  19. bookList.Add(book1);

  20.  
  21. BookInfo book2 = new BookInfo()

  22. {

  23. BookId = 2,

  24. Category = "WEB",

  25. Title = "Learning XML",

  26. Author = "Erik T. Ray",

  27. PublishDate = new DateTime(2003, 10, 18),

  28. Price = 39.95

  29. };

  30. bookList.Add(book2);

  31.  
  32. return bookList;

  33. }

 

补充:如果某个字段不想被Json序列化,则可以在该字段上加上[Newtonsoft.Json.JsonIgnore]特性。

例如上述实例中的价格不想被Json序列化:

 
  1.  
  2. [Newtonsoft.Json.JsonIgnore]

  3.  
  4. public Double Price { set; get; } //销售价格

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!