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

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 使用c#解析json庫使用newtonjson解決Json日期格式問題 C#解析json文件的方法 c# 解析讀取JSON文件 C#解析json文件的方法 C#解析json文件的方法 C# 使用解析json 嵌套方法 C#使用litJson解析Json(一) C#使用LitJson解析JSON C# 使用 JObject 解析 json