C# 解析Json文件（使用NewtonJson库）

编写C#程序肯定是在visual studio中写（暂不考虑unity等其他地方），那么无论你是在windows下还是Mac OS X下，visual studio都自带nuget包管理工具。本文以Mac OS X平台为例，首先新建一个项目叫ParseJson，然后在项目的依赖项中弹出快捷菜单，如下：

技术图片

点击Nuget包管理，弹出一个窗口：

技术图片

可以看到第一个就是我们想要的包，选中然后添加包即可。添加完成后在你的程序中添加下面两行：

using Newtonsoft.Json;
using Newtonsoft.Json.Linq;

至此，基本配置就完成了。

2.解析Json文件

NewtonJson官网有详细的使用文档教程，有很多示例代码，这里就不过多介绍了，遇到不懂的问题可以去文档里面找资料。

2.1 最简单的序列化与反序列化

假设你在C#中有一个定义好的类，然后你生成了一个对象，想把这个对象保存为Json文件，你可以用SerializeObject()函数处理。看下面的代码：

using System;
using System.IO;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
namespace ParseJson
{
class Product
{
public string Name;
public DateTime ExpiryDate;
public Decimal Price;
public String[] Sizes;
}
class Program
{
static void Main(string[] args)
{
Product product = new Product()
{
Name = "Apple",
ExpiryDate=new DateTime(2020,12,30),
Price=2.99M,
Sizes=new string[] {"small","medium","large"}
};
string output = JsonConvert.SerializeObject(product);
//将Json文件以字符串的形式保存
StreamWriter sw = new StreamWriter(@"/Users/qinyuanlong/Projects/SimpleTest/ParseJson/product.dat");
sw.Write(output);
sw.Close();
Console.WriteLine(output);
}
}
}

这里我们创建了一个Product类，并且实例化了一个对象，利用JsonConvert.SerializeObject(product)将其转化为Json文件，并以字符串的形式存储在变量output，我们很容易将字符串保存到本地。可以查看保存到本地后的文件内容：

技术图片

既然我们可以将对象以json文件的形式保存，自然我们也应该可以从Json格式恢复成对象，做法很简单，假设我们已经读取了本地文件Product.dat，并保存到了字符串变量output中，我们要从中恢复成Product对象只需一句话：

//恢复对象
Product p = JsonConvert.DeserializeObject<Product>(output);

值得一提的的是，当你的对象里面有集合对象时：

public class Acount
{
public string Email {get;set;}
public Ilist<string> Roles {get;set}
}

也可以直接使用上面的方法，转化为Json文件后，集合对象会以数组的形式存储。

2.2 序列化集合和字典

除了序列化自定义的类，还可以将C#中的集合对象序列化，这里我就不跑代码了，直接搬运官网的例子。

序列化字典：

List<string> videogames = new List<string>
{
"Starcraft",
"Halo",
"Legend of Zelda"
};
string json = JsonConvert.SerializeObject(videogames);
Console.WriteLine(json);
// ["Starcraft","Halo","Legend of Zelda"]

List集合被转化为了数组，当然List里面可以是复杂的类型,如使用我们之前定义的Product：

Product product1 = new Product()
{
Name = "Apple",
ExpiryDate=new DateTime(2020,12,30),
Price=2.99M,
Sizes=new string[] {"small","medium","large"}
};
Product product2 = new Product()
{
Name = "cup",
ExpiryDate = new DateTime(2099, 1, 1),
Price = 9.99M,
Sizes = new string[] { "s", "L", "M", "xL" }
};
List<Product> list = new List<Product>() { product1, product2 };
string json = JsonConvert.SerializeObject(list);
Console.WriteLine(json);

输出为：

[{"Name":"Apple","ExpiryDate":"2020-12-30T00:00:00","Price":2.99,"Sizes":["small","medium","large"]},{"Name":"cup","ExpiryDate":"2099-01-01T00:00:00","Price":9.99,"Sizes":["s","L","M","xL"]}]

序列化字典例子如下：

Dictionary<string, int> points = new Dictionary<string, int>
{
{ "James", 9001 },
{ "Jo", 3474 },
{ "Jess", 11926 }
};
string json = JsonConvert.SerializeObject(points, Formatting.Indented);
Console.WriteLine(json);
// {
// "James": 9001,
// "Jo": 3474,
// "Jess": 11926
// }

这里SerializeObject多了一个参数，Indented表示转化为的Json文件带缩进，这样输出会更加直观清晰。

2.3 反序列化集合和字典

反序列化和之前讲的类似，反序列化需要给出转化为对象的类型，反序列化集合：

string json = @"[
{
‘Name‘: ‘Product 1‘,
‘ExpiryDate‘: ‘2000-12-29T00:00Z‘,
‘Price‘: 99.95,
‘Sizes‘: null
},
{
‘Name‘: ‘Product 2‘,
‘ExpiryDate‘: ‘2009-07-31T00:00Z‘,
‘Price‘: 12.50,
‘Sizes‘: null
}
]";
List<Product> products = JsonConvert.DeserializeObject<List<Product>>(json);
Console.WriteLine(products.Count);
// 2
Product p1 = products[0];
Console.WriteLine(p1.Name);
// Product 1

反序列化集合一般转为List类型，如果你需要转化为其它类型，你可以后续再处理。反序列化字典也是如此：

string json = @"{""key1"":""value1"",""key2"":""value2""}";
Dictionary<string, string> values = JsonConvert.DeserializeObject<Dictionary<string, string>>(json);
Console.WriteLine(values.Count);
// 2
Console.WriteLine(values["key1"]);
// value1

2.4 将对象保存为Json文件&从文件解析为json

在最开始的例子中，我们将对象先转为字符串，然后再写入一个dat文件中，事实上完全可以将文件保存为Json文件。有两种思路，一种还是先将json变为字符串，然后保存到自定义的json文件中。

Product product1 = new Product()
{
Name = "Apple",
ExpiryDate=new DateTime(2020,12,30),
Price=2.99M,
Sizes=new string[] {"small","medium","large"}
};
Product product2 = new Product()
{
Name = "cup",
ExpiryDate = new DateTime(2099, 1, 1),
Price = 9.99M,
Sizes = new string[] { "s", "L", "M", "xL" }
};
List<Product> list = new List<Product>() { product1, product2 };
File.WriteAllText(@"/Users/qinyuanlong/Projects/SimpleTest/ParseJson/product1.json",
JsonConvert.SerializeObject(list,Formatting.Indented));

我们用Vscode打开product1.json如下：

技术图片

另一种方法是直接将对象转化为json文件：

using(StreamWriterfile=File.CreateText(@"/Users/qinyuanlong/Projects/SimpleTest/ParseJson/product2.json"))
{
JsonSerializer serializer = new JsonSerializer() { Formatting=Formatting.Indented};
serializer.Serialize(file, list);
}

得到的product2.json和前面是一样的。

从json文件中解析对象的操作几乎是一模一样的：只需要将SerializeObject函数换成DeserializeObject，WriteAllText换成ReadAllText，CreatText换成OpenText。

// read file into a string and deserialize JSON to a type
Movie movie1 = JsonConvert.DeserializeObject<Movie>(File.ReadAllText(@"c:\movie.json"));
// deserialize JSON directly from a file
using (StreamReader file = File.OpenText(@"c:\movie.json"))
{
JsonSerializer serializer = new JsonSerializer();
Movie movie2 = (Movie)serializer.Deserialize(file, typeof(Movie));
}

注意：直接从json转为对象，除了提供对象类型参数，还需要强制转化操作。

2.5 有条件的序列化对象成员

NewTonJson还支持有条件序列化对象，即对某些属性进行判断，如果不满足要求，则忽略该属性。

要实现部分属性的条件序列化，需要添加一些函数，这个函数和属性一一对应，函数名为：ShouldSerialize+属性名，函数的返回值为bool类型，当返回为True时，该属性将被序列化，为False则被忽略。看一个官方例子：

首先你有这样一个简单类：

public class Employee
{
public string Name { get; set; }
public Employee Manager { get; set; }
public bool ShouldSerializeManager()
{
// don‘t serialize the Manager property if an employee is their own manager
return (Manager != this);
}
}

这里已经添加了Manager这个筛选函数，所以当Manage就是自己时，这个Manage会被忽略。

Employee joe = new Employee();
joe.Name = "Joe Employee";
Employee mike = new Employee();
mike.Name = "Mike Manager";
joe.Manager = mike;
// mike is his own manager
// ShouldSerialize will skip this property
mike.Manager = mike;
string json = JsonConvert.SerializeObject(new[] { joe, mike }, Formatting.Indented);
Console.WriteLine(json);
// [
// {
// "Name": "Joe Employee",
// "Manager": {
// "Name": "Mike Manager"
// }
// },
// {
// "Name": "Mike Manager"
// }
// ]

不过一般而言，当数据量不是很大时，你可以有条件的使用Json文件的数据，也就是我不用这个属性，我就可以假设它不存在。

上面的例子固然可行，但是有个很麻烦的问题：你必须在设计类的时候就确定好条件序列化属性。

那么有没有更好的控制办法呢？答案是肯定的。

通过派生接口：IContractResolver,生产一个筛选对象可以实现定制化筛选，你不用在你的类里面添加函数。一般我们不用直接派生自IContractResolver,而是派生自它的一个派生类：

DefaultContractResolver

看下面这个例子，我们假设有这样一个图书类：

public class Book
{
public string BookName { get; set; }
public decimal BookPrice { get; set; }
public string AuthorName { get; set; }
public int AuthorAge { get; set; }
public string AuthorCountry { get; set; }
}

我们想实现序列化以字母“A”开头或者“B”开头的属性，显然用之前的方法会很麻烦，我们用刚才的方法，派生一个筛选类：

public class DynamicContractResolver : DefaultContractResolver
{
private readonly char _startingWithChar;
public DynamicContractResolver(char startingWithChar)
{
_startingWithChar = startingWithChar;
}
protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization)
{
IList<JsonProperty> properties = base.CreateProperties(type, memberSerialization);
// only serializer properties that start with the specified character
//只需要在这里添加属性筛选
properties =
properties.Where(p => p.PropertyName.StartsWith(_startingWithChar.ToString())).ToList();
return properties;
}
}

这个类有一个成员变量：_startingWithChar,用来接受筛选参数；一个构造函数；一个筛选函数：CreateProperties，这个函数返回一个属性集合，函数首先获得类的所有属性，保存带properties中，然后你根据需求对properties进行处理。上面的函数实现了根据属性名的首字母进行筛选。所以我们就可以用这个类的对象作为参数去实现我们的需求：

Book book = new Book
{
BookName = "The Gathering Storm",
BookPrice = 16.19m,
AuthorName = "Brandon Sanderson",
AuthorAge = 34,
AuthorCountry = "United States of America"
};
string startingWithA = JsonConvert.SerializeObject(book, Formatting.Indented,
new JsonSerializerSettings { ContractResolver = new DynamicContractResolver(‘A‘) });
// {
// "AuthorName": "Brandon Sanderson",
// "AuthorAge": 34,
// "AuthorCountry": "United States of America"
// }
string startingWithB = JsonConvert.SerializeObject(book, Formatting.Indented,
new JsonSerializerSettings { ContractResolver = new DynamicContractResolver(‘B‘) });
// {
// "BookName": "The Gathering Storm",
// "BookPrice": 16.19
// }

DefaultContractResolver中的CreateProperties是对多个属性筛选而言的，回到本节最开始的问题，我只想对Manage成员进行筛选，那么可以用CreateProperty这个函数，具体用法如下：

public class ShouldSerializeContractResolver : DefaultContractResolver
{
public static readonly ShouldSerializeContractResolver Instance = new ShouldSerializeContractResolver();
protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
{
JsonProperty property = base.CreateProperty(member, memberSerialization);
if (property.DeclaringType == typeof(Employee) && property.PropertyName == "Manager")
{
property.ShouldSerialize =
instance =>
{
Employee e = (Employee)instance;
return e.Manager != e;
};
}
return property;
}
}

这个的用法和前面类似，不过这里直接声明了一个类的静态成员，所以不需要new一个对象：

string json = JsonConvert.SerializeObject(new[] { joe, mike }, Formatting.Indented,
new JsonSerializerSettings { ContractResolver=ShouldSerializeContractResolver.Instance});

顺便要说明的是，为了成功运行需要添加新的命名空间：

using Newtonsoft.Json.Linq;
using Newtonsoft.Json.Serialization;

这里给出官网关于DefaultContrctResolver的链接。

2.6 解析匿名类

对于匿名类，由于序列化不需要给出对象类型，所以可以依然使用前面序列化自定义类的方法，但是反序列是需要提供类型的，那对于匿名类怎么办？，这个NewtonJson也替我们考虑了，例子如下：

var definition = new { Name = "" };
string json1 = @"{‘Name‘:‘James‘}";
var customer1 = JsonConvert.DeserializeAnonymousType(json1, definition);
Console.WriteLine(customer1.Name);
// James
string json2 = @"{‘Name‘:‘Mike‘}";
var customer2 = JsonConvert.DeserializeAnonymousType(json2, definition);
Console.WriteLine(customer2.Name);
// Mike

办法很简单，直接给一个匿名类的定义对象，传入参数即可。

2.7 将派生类解析为基类

将派生类解析为基类，需要一个派生自CustomeCreationConverter的对象，操作起来其实很简单，看一下官方的例子：

首先你有一个Person基类，然后派生了Employee类，并写好了派生自CustomeCreationConverter类的类PersonConverter:

public class Person
{
public string FirstName { get; set; }
public string LastName { get; set; }
public DateTime BirthDate { get; set; }
}
public class Employee : Person
{
public string Department { get; set; }
public string JobTitle { get; set; }
}
public class PersonConverter : CustomCreationConverter<Person>
{
public override Person Create(Type objectType)
{
return new Employee();
}
}

然后你想将Employee对象解析为Person，只需要传入一个PersonConvrter对象：

string json = @"{
‘Department‘: ‘Furniture‘,
‘JobTitle‘: ‘Carpenter‘,
‘FirstName‘: ‘John‘,
‘LastName‘: ‘Joinery‘,
‘BirthDate‘: ‘1983-02-02T00:00:00‘
}";
Person person = JsonConvert.DeserializeObject<Person>(json, new PersonConverter());
Console.WriteLine(person.GetType().Name);
// Employee
Employee employee = (Employee)person;
Console.WriteLine(employee.JobTitle);
// Carpenter

从结果可以看出，虽然是以Person解析的，但是实际上仍然是Employee类型。

2.8 防止重复写值

如果一个类的构造函数本身就对成员进行了赋值，那么在反序列化时，可能会调用一次构造函数容易造成重复写入，看下面的例子：

public class UserViewModel
{
public string Name { get; set; }
public IList<string> Offices { get; private set; }
public UserViewModel()
{
Offices = new List<string>
{
"Auckland",
"Wellington",
"Christchurch"
};
}
}

构造函数对成员Offices进行了赋值：

string json = @"{
‘Name‘: ‘James‘,
‘Offices‘: [
‘Auckland‘,
‘Wellington‘,
‘Christchurch‘
]
}";
UserViewModel model1 = JsonConvert.DeserializeObject<UserViewModel>(json);
foreach (string office in model1.Offices)
{
Console.WriteLine(office);
}
// Auckland
// Wellington
// Christchurch
// Auckland
// Wellington
// Christchurch
UserViewModel model2 = JsonConvert.DeserializeObject<UserViewModel>(json, new JsonSerializerSettings
{
ObjectCreationHandling = ObjectCreationHandling.Replace
});
foreach (string office in model2.Offices)
{
Console.WriteLine(office);
}
// Auckland
// Wellington
// Christchurch

如果不添加设定，Offices就是存在2遍初始值，为例避免这种情况，在反序列化的时候传入了一个setting对象，其ObejctCreationHandling属性为Replcae。

2.9 取消C#默认参数赋值& 过滤值为null的属性

C#对于没有赋值的类型提供一个默认值，如Int类型默认值为0，string类型默认值为null，如果当一个对象的成员没有被赋值，我们希望得到的是一个空json，那么需要将setting的DefaultValueHandleling设置为Ignore。

public class Person
{
public string Name { get; set; }
public int Age { get; set; }
public Person Partner { get; set; }
public decimal? Salary { get; set; }
}
Person person = new Person();
string jsonIncludeDefaultValues = JsonConvert.SerializeObject(person, Formatting.Indented);
Console.WriteLine(jsonIncludeDefaultValues);
// {
// "Name": null,
// "Age": 0,
// "Partner": null,
// "Salary": null
// }
string jsonIgnoreDefaultValues = JsonConvert.SerializeObject(person, Formatting.Indented, new JsonSerializerSettings
{
DefaultValueHandling = DefaultValueHandling.Ignore
});
Console.WriteLine(jsonIgnoreDefaultValues);
// {}

过滤值为null的成员只需要将NullValueHandling属性设置为Ignore。

public class Person
{
public string Name { get; set; }
public int Age { get; set; }
public Person Partner { get; set; }
public decimal? Salary { get; set; }
}
Person person = new Person
{
Name = "Nigal Newborn",
Age = 1
};
string jsonIncludeNullValues = JsonConvert.SerializeObject(person, Formatting.Indented);
Console.WriteLine(jsonIncludeNullValues);
// {
// "Name": "Nigal Newborn",
// "Age": 1,
// "Partner": null,
// "Salary": null
// }
string jsonIgnoreNullValues = JsonConvert.SerializeObject(person, Formatting.Indented, new JsonSerializerSettings
{
NullValueHandling = NullValueHandling.Ignore
});
Console.WriteLine(jsonIgnoreNullValues);
// {
// "Name": "Nigal Newborn",
// "Age": 1
// }

2.10 类型缺少成员报错

当我们将下面的json文件：

string json = @"{
‘FullName‘: ‘Dan Deleted‘,
‘Deleted‘: true,
‘DeletedDate‘: ‘2013-01-20T00:00:00‘
}";

解析为Account类型时：

public class Account
{
public string FullName { get; set; }
public bool Deleted { get; set; }
}

是可以成功的，因为json中包含Accout类中所有成员属性。但是如果我们要严格转化（特别是在Accout漏掉属性时），需要报错，那么就需要设置setting的MissingMemberHandling属性。

try
{
JsonConvert.DeserializeObject<Account>(json, new JsonSerializerSettings
{
MissingMemberHandling = MissingMemberHandling.Error
});
}
catch (JsonSerializationException ex)
{
Console.WriteLine(ex.Message);
// Could not find member ‘DeletedDate‘ on object of type ‘Account‘. Path ‘DeletedDate‘, line 4, position 23.
}

此外还有很多设置用来解决各种问题，上面只是列出了一些常见的，有需要的还是要去官网查看。

3. 使用Linq处理json

使用ling处理json最大的好处是摆脱了对象的束缚，使用NewtonJson自带的一套体系。我们都知道JavaScript原生支持Json，直接可以将Json文件转化为一个对象，JObject的创建也是为了实现这样一个类似的功能。

3.1 解析Json的基本操作

解析文本为Json对象
直接使用JObject.Parse(obj)即可
1. string json = @"{
2. CPU: ‘Intel‘,
3. Drives: [
4. ‘DVD read/writer‘,
5. ‘500 gigabyte hard drive‘
6. ]
7. }";
9. JObject o = JObject.Parse(json);
10. Console.WriteLine(o.ToString());
11. // {
12. // "CPU": "Intel",
13. // "Drives": [
14. // "DVD read/writer",
15. // "500 gigabyte hard drive"
16. // ]
17. // }
将数组解析为Json
直接使用JArray类
1. string json = @"[
2. ‘Small‘,
3. ‘Medium‘,
4. ‘Large‘
5. ]";
7. JArray a = JArray.Parse(json);
9. Console.WriteLine(a.Tostring());
10. // [
11. // "Small",
12. // "Medium",
13. // "Large"
14. // ]
从本地Json文件中解析
读操作
1. using (StreamReader reader = File.OpenText(@"c:\person.json"))
2. {
3. JObject o = (JObject)JToken.ReadFrom(new JsonTextReader(reader));
4. // do stuff
5. }
写操作
1. JObject videogameRatings = new JObject(
2. new JProperty("Halo", 9),
3. new JProperty("Starcraft", 9),
4. new JProperty("Call of Duty", 7.5));
6. File.WriteAllText(@"c:\videogames.json", videogameRatings.ToString());
8. // write JSON directly to a file
9. using (StreamWriter file = File.CreateText(@"c:\videogames.json"))
10. using (JsonTextWriter writer = new JsonTextWriter(file))
11. {
12. videogameRatings.WriteTo(writer);
13. }
创建JObject对象，JArray对象
1. JArray array = new JArray();
2. array.Add("Manual text");
3. array.Add(new DateTime(2000, 5, 23));
5. JObject o = new JObject();
6. o["MyArray"] = array;
8. string json = o.ToString();
9. // {
10. // "MyArray": [
11. // "Manual text",
12. // "2000-05-23T00:00:00"
13. // ]
14. // }
使用C#中的集合初始化语法创建复杂对象
可以直接使用C#的初始化语法创建嵌套类型
1. JObject o = new JObject
2. {
3. { "Cpu", "Intel" },
4. { "Memory", 32 },
5. {
6. "Drives", new JArray
7. {
8. "DVD",
9. "SSD"
10. }
11. }
12. };
14. Console.WriteLine(o.ToString());
15. // {
16. // "Cpu": "Intel",
17. // "Memory": 32,
18. // "Drives": [
19. // "DVD",
20. // "SSD"
21. // ]
22. // }
当然也可以用传统的对象创建方法，但是会觉得繁琐，看下面的例子：
1. public class Post
2. {
3. public string Title { get; set; }
4. public string Description { get; set; }
5. public string Link { get; set; }
6. public IList<string> Categories { get; set; }
7. }
8. List<Post> posts = GetPosts();
10. JObject rss =
11. new JObject(
12. new JProperty("channel",
13. new JObject(
14. new JProperty("title", "James Newton-King"),
15. new JProperty("link", "http://james.newtonking.com"),
16. new JProperty("description", "James Newton-King‘s blog."),
17. new JProperty("item",
18. new JArray(
19. from p in posts
20. orderby p.Title
21. select new JObject(
22. new JProperty("title", p.Title),
23. new JProperty("description", p.Description),
24. new JProperty("link", p.Link),
25. new JProperty("category",
26. new JArray(
27. from c in p.Categories
28. select new JValue(c)))))))));
30. Console.WriteLine(rss.ToString());
32. // {
33. // "channel": {
34. // "title": "James Newton-King",
35. // "link": "http://james.newtonking.com",
36. // "description": "James Newton-King‘s blog.",
37. // "item": [
38. // {
39. // "title": "Json.NET 1.3 + New license + Now on CodePlex",
40. // "description": "Announcing the release of Json.NET 1.3, the MIT license and being available on CodePlex",
41. // "link": "http://james.newtonking.com/projects/json-net.aspx",
42. // "category": [
43. // "Json.NET",
44. // "CodePlex"
45. // ]
46. // },
47. // {
48. // "title": "LINQ to JSON beta",
49. // "description": "Announcing LINQ to JSON",
50. // "link": "http://james.newtonking.com/projects/json-net.aspx",
51. // "category": [
52. // "Json.NET",
53. // "LINQ"
54. // ]
55. // }
56. // ]
57. // }
58. // }
动态创建JObject和JArray对象
使用C#的动态类型，可以动态的创建JObject和JArray对象
1. dynamic product = new JObject();
2. product.ProductName = "Elbow Grease";
3. product.Enabled = true;
4. product.Price = 4.90m;
5. product.StockCount = 9000;
6. product.StockValue = 44100;
7. product.Tags = new JArray("Real", "OnSale");
9. Console.WriteLine(product.ToString());
10. // {
11. // "ProductName": "Elbow Grease",
12. // "Enabled": true,
13. // "Price": 4.90,
14. // "StockCount": 9000,
15. // "StockValue": 44100,
16. // "Tags": [
17. // "Real",
18. // "OnSale"
19. // ]
20. // }
使用JTokenWriter动态创建JObject对象
JTokenWriter类有一套完整的节点写入方法，详细文档在此，在写入的过程，有点像在JS中添加Dom元素。
1. JTokenWriter writer = new JTokenWriter();
2. writer.WriteStartObject();
3. writer.WritePropertyName("name1");
4. writer.WriteValue("value1");
5. writer.WritePropertyName("name2");
6. writer.WriteStartArray();
7. writer.WriteValue(1);
8. writer.WriteValue(2);
9. writer.WriteEndArray();
10. writer.WriteEndObject();
12. JObject o = (JObject)writer.Token;
14. Console.WriteLine(o.ToString());
15. // {
16. // "name1": "value1",
17. // "name2": [
18. // 1,
19. // 2
20. // ]
21. // }
从自定义对象生成JObject对象
使用FromObject函数可以从自定义的类中生产JObject对象，用法如下：
1. public class Computer
2. {
3. public string Cpu { get; set; }
4. public int Memory { get; set; }
5. public IList<string> Drives { get; set; }
6. }
8. JValue i = (JValue)JToken.FromObject(12345);
10. Console.WriteLine(i.Type);
11. // Integer
12. Console.WriteLine(i.ToString());
13. // 12345
15. JValue s = (JValue)JToken.FromObject("A string");
17. Console.WriteLine(s.Type);
18. // String
19. Console.WriteLine(s.ToString());
20. // A string
22. Computer computer = new Computer
23. {
24. Cpu = "Intel",
25. Memory = 32,
26. Drives = new List<string>
27. {
28. "DVD",
29. "SSD"
30. }
31. };
33. JObject o = (JObject)JToken.FromObject(computer);
35. Console.WriteLine(o.ToString());
36. // {
37. // "Cpu": "Intel",
38. // "Memory": 32,
39. // "Drives": [
40. // "DVD",
41. // "SSD"
42. // ]
43. // }
45. JArray a = (JArray)JToken.FromObject(computer.Drives);
47. Console.WriteLine(a.ToString());
48. // [
49. // "DVD",
50. // "SSD"
51. // ]
这个函数还可以直接从匿名对象创建：
1. List<Post> posts = new List<Post>
2. {
3. new Post
4. {
5. Title = "Episode VII",
6. Description = "Episode VII production",
7. Categories = new List<string>
8. {
9. "episode-vii",
10. "movie"
11. },
12. Link = "episode-vii-production.aspx"
13. }
14. };
16. JObject o = JObject.FromObject(new
17. {
18. channel = new
19. {
20. title = "Star Wars",
21. link = "http://www.starwars.com",
22. description = "Star Wars blog.",
23. item =
24. from p in posts
25. orderby p.Title
26. select new
27. {
28. title = p.Title,
29. description = p.Description,
30. link = p.Link,
31. category = p.Categories
32. }
33. }
34. });
36. Console.WriteLine(o.ToString());
37. // {
38. // "channel": {
39. // "title": "Star Wars",
40. // "link": "http://www.starwars.com",
41. // "description": "Star Wars blog.",
42. // "item": [
43. // {
44. // "title": "Episode VII",
45. // "description": "Episode VII production",
46. // "link": "episode-vii-production.aspx",
47. // "category": [
48. // "episode-vii",
49. // "movie"
50. // ]
51. // }
52. // ]
53. // }
54. // }

从JObject恢复出类对象
这个实际上没有什么技巧，只是写一个动态创建函数：

public class BlogPost
{
public string Title { get; set; }
public string AuthorName { get; set; }
public string AuthorTwitter { get; set; }
public string Body { get; set; }
public DateTime PostedDate { get; set; }
}
string json = @"[
{
‘Title‘: ‘Json.NET is awesome!‘,
‘Author‘: {
‘Name‘: ‘James Newton-King‘,
‘Twitter‘: ‘@JamesNK‘,
‘Picture‘: ‘/jamesnk.png‘
},
‘Date‘: ‘2013-01-23T19:30:00‘,
‘BodyHtml‘: ‘<h3>Title!</h3>\r\n<p>Content!</p>‘
}
]";
JArray blogPostArray = JArray.Parse(json);
IList<BlogPost> blogPosts = blogPostArray.Select(p => new BlogPost
{
Title = (string)p["Title"],
AuthorName = (string)p["Author"]["Name"],
AuthorTwitter = (string)p["Author"]["Twitter"],
PostedDate = (DateTime)p["Date"],
Body = HttpUtility.HtmlDecode((string)p["BodyHtml"])
}).ToList();
Console.WriteLine(blogPosts[0].Body);
// <h3>Title!</h3>
// <p>Content!</p>

那么反过来，也可以用这个方法将对象变为Jobject对象：

IList<BlogPost> blogPosts = new List<BlogPost>
{
new BlogPost
{
Title = "Json.NET is awesome!",
AuthorName = "James Newton-King",
AuthorTwitter = "JamesNK",
PostedDate = new DateTime(2013, 1, 23, 19, 30, 0),
Body = @"<h3>Title!</h3><p>Content!</p>"
}
};
JArray blogPostsArray = new JArray(
blogPosts.Select(p => new JObject
{
{ "Title", p.Title },
{
"Author", new JObject
{
{ "Name", p.AuthorName },
{ "Twitter", p.AuthorTwitter }
}
},
{ "Date", p.PostedDate },
{ "BodyHtml", HttpUtility.HtmlEncode(p.Body) },
})
);
Console.WriteLine(blogPostsArray.ToString());
// [
// {
// "Title": "Json.NET is awesome!",
// "Author": {
// "Name": "James Newton-King",
// "Twitter": "JamesNK"
// },
// "Date": "2013-01-23T19:30:00",
// "BodyHtml": "<h3>Title!</h3><p>Content!</p>"
// }
// ]

3.2 修改Json（使用JObject）

JObject对象很容易修改Json文件，修改包括增，删，重写，等操作。

string json = @"{
‘channel‘: {
‘title‘: ‘Star Wars‘,
‘link‘: ‘http://www.starwars.com‘,
‘description‘: ‘Star Wars blog.‘,
‘obsolete‘: ‘Obsolete value‘,
‘item‘: []
}
}";
JObject rss = JObject.Parse(json);
JObject channel = (JObject)rss["channel"];
channel["title"] = ((string)channel["title"]).ToUpper();
channel["description"] = ((string)channel["description"]).ToUpper();
channel.Property("obsolete").Remove();
channel.Property("description").AddAfterSelf(new JProperty("new", "New value"));
JArray item = (JArray)channel["item"];
item.Add("Item 1");
item.Add("Item 2");
Console.WriteLine(rss.ToString());
// {
// "channel": {
// "title": "STAR WARS",
// "link": "http://www.starwars.com",
// "description": "STAR WARS BLOG.",
// "new": "New value",
// "item": [
// "Item 1",
// "Item 2"
// ]
// }
// }

在上面的例子，依次进行了：使用函数修改值，删除属性，在某属性后面添加属性，在数组内部添加成员。

3.3 合并Json文件

合并Json文件也很简单，类似于两个集合的操作，看下面的例子：

JObject o1 = JObject.Parse(@"{
‘FirstName‘: ‘John‘,
‘LastName‘: ‘Smith‘,
‘Enabled‘: false,
‘Roles‘: [ ‘User‘ ]
}");
JObject o2 = JObject.Parse(@"{
‘Enabled‘: true,
‘Roles‘: [ ‘User‘, ‘Admin‘ ]
}");
o1.Merge(o2, new JsonMergeSettings
{
// union array values together to avoid duplicates
MergeArrayHandling = MergeArrayHandling.Union
});
string json = o1.ToString();
// {
// "FirstName": "John",
// "LastName": "Smith",
// "Enabled": true,
// "Roles": [
// "User",
// "Admin"
// ]
// }

这里要说的是，可以使用MergeArrayHandling对象来设置合并方式，上面使用的是合并模式：Union，即当前Json有时，只会出现一次，此外还有：

技术图片

类似与数学中的并集，补集，叠加。

此外，MergeNullValueHandling属性可以控制在合并是值为Null的要不要被忽略；

3.4 将Json类型转为普通类型

JObject对象中的成员类型并不是C#中类型，要变成普通类型，你需要使用：ToObject<T>() 做最后一步转换，其中T为你想转换为的类型，不进行转换直接打印可能会报错。

JValue v1 = new JValue(true);
bool b = v1.ToObject<bool>();
Console.WriteLine(b);
// true
int i = v1.ToObject<int>();
Console.WriteLine(i);
// 1
string s = v1.ToObject<string>();
Console.WriteLine(s);
// "True"

虽然很简单，但是刚接触NewtonJson可能会遇到这个问题。

3.5 判断Json文件是否相等 &深度复制Json文件

使用JToken.DeepEquals函数判断两个JObject对象是否相等，这个相等必须要所有属性值一模一样：

JValue s1 = new JValue("A string");
JValue s2 = new JValue("A string");
JValue s3 = new JValue("A STRING");
Console.WriteLine(JToken.DeepEquals(s1, s2));
// true
Console.WriteLine(JToken.DeepEquals(s2, s3));
// false
JObject o1 = new JObject
{
{ "Integer", 12345 },
{ "String", "A string" },
{ "Items", new JArray(1, 2) }
};
JObject o2 = new JObject
{
{ "Integer", 12345 },
{ "String", "A string" },
{ "Items", new JArray(1, 2) }
};
Console.WriteLine(JToken.DeepEquals(o1, o2));
// true
Console.WriteLine(JToken.DeepEquals(s1, o1["String"]));
// true

注意：虽然两个json问价的内容一样，但是它们毕竟是2个不同的对象，使用JToken.RefernceEquals判断会返回false。

对于拷贝，主要是对内容进行拷贝，但是创建的是新对象：

JValue s1 = new JValue("A string");
JValue s2 = new JValue("A string");
JValue s3 = new JValue("A STRING");
Console.WriteLine(JToken.DeepEquals(s1, s2));
// true
Console.WriteLine(JToken.DeepEquals(s2, s3));
// false
JObject o1 = new JObject
{
{ "Integer", 12345 },
{ "String", "A string" },
{ "Items", new JArray(1, 2) }
};
JObject o2 = new JObject
{
{ "Integer", 12345 },
{ "String", "A string" },
{ "Items", new JArray(1, 2) }
};
Console.WriteLine(JToken.DeepEquals(o1, o2));
// true
Console.WriteLine(JToken.DeepEquals(s1, o1["String"]));
// true

4. 总结

以上就是对NewtonJson的一点总结，很多是参考官方文档，我只选了一些常见的知识点进行介绍，建议大家遇到不能解决的问题时还是看官方文档。

一般而言，我更倾向与使用JObject对象处理Json，因为你可以获得JavaScript处理Json的90%的体验，使用起来很灵活，而且结合Linq语法，可以很方便的处理它。

转载地址：

https://blog.csdn.net/q__y__l/article/details/103566693#2.%E8%A7%A3%E6%9E%90Json%E6%96%87%E4%BB%B6

C# 解析Json文件（使用NewtonJson库）

标签：sharp typeof product object country carp def 取消 ret

原文地址：https://www.cnblogs.com/BluceLee/p/13813796.html

踩

(0)

评论一句话评论（0）

分享档案

更多>

2021年07月29日 (22)
2021年07月28日 (40)
2021年07月27日 (32)
2021年07月26日 (79)
2021年07月23日 (29)
2021年07月22日 (30)
2021年07月21日 (42)
2021年07月20日 (16)
2021年07月19日 (90)
2021年07月16日 (35)

周排行