C#如何处理JSON

当使用C#开发Web应用或其他需要使用API的系统时，通常需要处理JSON来交换数据。JSON是一种轻量级的数据格式，易于读写和解析。下面是一些使用C#处理JSON的方法。

第一步：导入Newtonsoft.Json库

使用C#处理JSON的其中一种方法是使用Newtonsoft.Json库，它是一个开源的JSON框架，可以方便地将JSON字符串解析为C#对象或将C#对象序列化为JSON字符串。安装Newtonsoft.Json库，可以直接在NuGet包管理器中搜索 Newtonsoft.Json 进行安装，或手动下载并添加引用。

第二步：解析JSON字符串

使用Newtonsoft.Json库中的JsonConvert类，可以将JSON字符串解析为C#对象。以下是一个示例代码，解析包含三个学生信息的JSON字符串，将每个学生信息分别存储到一个Student对象中，并添加到List集合中：

using Newtonsoft.Json;
using System.Collections.Generic;

public class Student
{
   public string Name { get; set; }
   public int Age { get; set; }
   public int Grade { get; set; }
}

string jsonString = @"[
    { 'Name': 'Tom', 'Age': 18, 'Grade': 90 },
    { 'Name': 'Jerry', 'Age': 17, 'Grade': 85 },
    { 'Name': 'Lucy', 'Age': 16, 'Grade': 92 }
]";

List<Student> students = JsonConvert.DeserializeObject<List<Student>>(jsonString);

foreach (Student s in students)
{
    Console.WriteLine(s.Name + ", " + s.Age + ", " + s.Grade);
}

在这个例子中，JsonConvert.DeserializeObject() 方法将JSON字符串转化为List对象。然后循环遍历List并输出每个学生的基本信息。

第三步：将C#对象序列化为JSON字符串

将C#对象序列化为JSON字符串同样可以使用Newtonsoft.Json库。以下是一个示例代码，将一个Student对象序列化为JSON字符串：

using Newtonsoft.Json;

public class Student
{
   public string Name { get; set; }
   public int Age { get; set; }
   public int Grade { get; set; }
}

Student student = new Student()
{
    Name = "Tom",
    Age = 18,
    Grade = 90
};

string jsonString = JsonConvert.SerializeObject(student, Formatting.Indented);

Console.WriteLine(jsonString);

在这个例子中，JsonConvert.SerializeObject() 方法将Student对象序列化为JSON字符串，并使用Formatting.Indented设置缩进格式。最后将JSON字符串输出到控制台。

示例一

一个示例场景是从API获取到JSON数据（例如，获取天气信息），然后在C#应用程序中解析该数据并使用它来显示相关信息。假设我们要获取以华氏度为单位的纽约今天的最高和最低气温。以下是示例代码：

using Newtonsoft.Json;
using System;
using System.Net;

public class WeatherReport
{
    public double High { get; set; }
    public double Low { get; set; }
}

string jsonUrl = "http://api.openweathermap.org/data/2.5/weather?q=New%20York&units=imperial&appid=[YOUR-API-KEY]";
string json;

using (var webClient = new WebClient())
{
    json = webClient.DownloadString(jsonUrl);
}

dynamic jsonObj = JsonConvert.DeserializeObject(json);
double tempHigh = jsonObj.main.temp_max;
double tempLow = jsonObj.main.temp_min;

WeatherReport nyWeatherReport = new WeatherReport
{
    High = tempHigh,
    Low = tempLow
};

Console.WriteLine("New York City Weather Report Today:\nHigh: {0} F\nLow: {1} F", nyWeatherReport.High, nyWeatherReport.Low);

在这个例子中，使用WebClient对象向OpenWeather API发送HTTP GET请求。这个API返回JSON数据包含纽约的天气信息。接下来，JsonConvert.DeserializeObject() 方法解析JSON字符串，并将High和Low属性用于WeatherReport对象。最后，将WeatherReport对象的属性输出到控制台。

示例二

另一个示例场景是我们需要将数据以JSON的形式发送到API，以保存/更新数据。以下是示例代码：

using Newtonsoft.Json;
using System.Collections.Generic;
using System.Net.Http;
using System.Text;

public class Employee
{
    public int Id { get; set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public string Department { get; set; }
}

List<Employee> employees = new List<Employee>
{
    new Employee { Id = 1, FirstName = "John", LastName = "Doe", Department = "Marketing" },
    new Employee { Id = 2, FirstName = "Jane", LastName = "Smith", Department = "IT" },
    new Employee { Id = 3, FirstName = "Mike", LastName = "Wilson", Department = "Sales" }
};

string apiEndpoint = "http://localhost:5000/api/employees"; //API endpoint
string jsonData = JsonConvert.SerializeObject(employees); // Convert list of employee objects to JSON string

var httpClient = new HttpClient();
HttpContent content = new StringContent(jsonData, Encoding.UTF8, "application/json"); //Sending JSON data

var responseMessage = httpClient.PutAsync(apiEndpoint, content).Result;
responseMessage.EnsureSuccessStatusCode();

string result = responseMessage.Content.ReadAsStringAsync().Result;

在这个例子中，首先创建包括三个Employee对象的List。然后使用JsonConvert.SerializeObject()方法将这个List序列化为JSON字符串，并设置HTTP请求的Content-Type为application/json。最后，使用HttpClient类发送PUT请求，并将JSON字符串作为请求的内容发送到API，将API的返回结果读取为字符串并输出到控制台。

以上是关于如何使用C#处理JSON的一个简单入门指南，主要引用的是Newtonsoft.Json库。希望本文对你学习和开发C#应用程序时处理JSON数据有所帮助。