.NET 帮助

Newtonsoft Jsonpath(开发人员如何使用)

发布 2023年十月29日
分享:

如果您在 .NET 中处理过 JSON 数据,您可能会遇到 Newtonsoft.Json 库,这是一个流行的高性能 .NET JSON 框架。本教程旨在帮助初学者和中级用户有效了解和使用这个功能强大的库,重点介绍其系统参考、文档和任何相关的版本更新。

开始

要开始使用 Newtonsoft.Json,首先需要将其安装到 .NET 项目中。这可以通过 .NET 软件包管理器 NuGet 来完成。在 NuGet 软件包管理器控制台中,键入

Install-Package Newtonsoft.Json

安装成功后,通过添加以下 using 语句将库添加到 .NET 项目中:

using Newtonsoft.Json;
using Newtonsoft.Json;
Imports Newtonsoft.Json
VB   C#

使用 Newtonsoft.JSON 解析 JSON

解析 JSON 本质上是在 .NET 应用程序中将 JSON 格式的字符串转换为可用数据结构的过程。使用 Newtonsoft.Json,这一过程非常简单。

让我们来看看一个人的 JSON 对象示例:

{
    "Name": "Iron Developer",
    "Age": 30,
    "Email": "irondeveloper@ironsoftware.com"
}

我们可以使用 JsonConvert.DeserializeObjectJsonConvert.DeserializeObject 将此 JSON 字符串解析为 C# 对象。()方法,其中 T 是我们要创建对象的类型。在本例中,我们将创建一个 Person 类,并将 JSON 解析到该类中。

public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
    public string Email { get; set; }
}

string jsonString = "JSON string here";
Person person = JsonConvert.DeserializeObject<Person>(jsonString);
public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
    public string Email { get; set; }
}

string jsonString = "JSON string here";
Person person = JsonConvert.DeserializeObject<Person>(jsonString);
Public Class Person
	Public Property Name() As String
	Public Property Age() As Integer
	Public Property Email() As String
End Class

Private jsonString As String = "JSON string here"
Private person As Person = JsonConvert.DeserializeObject(Of Person)(jsonString)
VB   C#

现在,person 对象将包含 JSON 字符串中的值。

使用 JSON 文件

您经常需要从文件读取或向文件写入 JSON 数据。让我们看看如何使用 Newtonsoft.Json 来实现这一功能。在这种情况下,我们将使用 "System.IO "命名空间中的 "File "类。

读取 JSON 文件并将其解析为对象:

string path = "path to your json file";
string jsonString = File.ReadAllText(path);
Person person = JsonConvert.DeserializeObject<Person>(jsonString);
string path = "path to your json file";
string jsonString = File.ReadAllText(path);
Person person = JsonConvert.DeserializeObject<Person>(jsonString);
Dim path As String = "path to your json file"
Dim jsonString As String = File.ReadAllText(path)
Dim person As Person = JsonConvert.DeserializeObject(Of Person)(jsonString)
VB   C#

将对象写入 JSON 文件:

Person person = new Person() 
{
    Name = "John Doe",
    Age = 30,
    Email = "johndoe@example.com"
};

string path = "path to your json file";
string jsonString = JsonConvert.SerializeObject(person);
File.WriteAllText(path, jsonString);
Person person = new Person() 
{
    Name = "John Doe",
    Age = 30,
    Email = "johndoe@example.com"
};

string path = "path to your json file";
string jsonString = JsonConvert.SerializeObject(person);
File.WriteAllText(path, jsonString);
Dim person As New Person() With {
	.Name = "John Doe",
	.Age = 30,
	.Email = "johndoe@example.com"
}

Dim path As String = "path to your json file"
Dim jsonString As String = JsonConvert.SerializeObject(person)
File.WriteAllText(path, jsonString)
VB   C#

使用数组

在某些情况下,您的 JSON 会包含数组。例如,"Person "对象可能包含一个 "Friends "数组:

{
    "Name": "John Doe",
    "Friends": [
        {
            "Name": "Jane Doe",
            "Age": 28
        },
        {
            "Name": "Billy",
            "Age": 25
        }
    ]
}

您可以使用 foreach 循环遍历 JSON 数组:

JArray friends = (JArray)jsonObject ["Friends"];
foreach (JObject friend in friends)
{
    string friendName = (string)friend ["Name"];
    Console.WriteLine(friendName);
}
JArray friends = (JArray)jsonObject ["Friends"];
foreach (JObject friend in friends)
{
    string friendName = (string)friend ["Name"];
    Console.WriteLine(friendName);
}
Dim friends As JArray = CType(jsonObject ("Friends"), JArray)
For Each [friend] As JObject In friends
	Dim friendName As String = CStr([friend] ("Name"))
	Console.WriteLine(friendName)
Next [friend]
VB   C#

修改和编写 JSON

Newtonsoft.Json 可以轻松修改和编写 JSON。比方说,您需要更新我们的 Person 对象的 Age 值。

jsonObject ["Age"] = 31; // update the age
jsonObject ["Age"] = 31; // update the age
jsonObject ("Age") = 31 ' update the age
VB   C#

然后将其写回字符串:

string updatedJson = jsonObject.ToString();
File.WriteAllText(path, updatedJson); // write back to the file
string updatedJson = jsonObject.ToString();
File.WriteAllText(path, updatedJson); // write back to the file
Dim updatedJson As String = jsonObject.ToString()
File.WriteAllText(path, updatedJson) ' write back to the file
VB   C#

LINQ to JSON

Newtonsoft.Json 还提供了使用 LINQ 查询和操作 JSON 对象的功能 (语言综合查询).这一点非常强大,因为它允许您使用所有标准 LINQ 操作符来查询 JSON 对象,就像查询 XML 或对象集合一样。

下面的示例展示了如何获取所有小于 30 岁的朋友的姓名:

var youngFriends = jsonObject ["Friends"].Where(f => (int)f ["Age"] < 30)
                                        .Select(f => (string)f ["Name"]);
foreach (string name in youngFriends)
{
    Console.WriteLine(name);
} 
var youngFriends = jsonObject ["Friends"].Where(f => (int)f ["Age"] < 30)
                                        .Select(f => (string)f ["Name"]);
foreach (string name in youngFriends)
{
    Console.WriteLine(name);
} 
Imports System

Dim youngFriends = jsonObject ("Friends").Where(Function(f) CInt(Math.Truncate(f ("Age"))) < 30).Select(Function(f) CStr(f ("Name")))
For Each name As String In youngFriends
	Console.WriteLine(name)
Next name
VB   C#

IronPDF 简介

IronPDF 是 .NET 生态系统中一个流行的库,它允许开发人员 创建从 PDF 文件中编辑和提取数据。它的用途非常广泛,可与包括 Newtonsoft.Json 在内的其他库配合使用。

假设我们需要使用 JSON 数据,并根据这些数据创建 PDF 报告。我们可以使用 Newtonsoft.Json 解析 JSON 数据,使用 IronPDF 创建 PDF。让我们看看如何做到这一点。

安装 IronPDF

与 Newtonsoft.Json 一样,IronPDF 也可通过 NuGet 安装。您可以使用以下命令安装它:

Install-Package IronPdf

然后,您可以在项目中添加

using IronPdf;
using IronPdf;
Imports IronPdf
VB   C#

使用案例 1 根据 JSON 数据创建 PDF

在本使用案例中,我们将演示如何使用 Newtonsoft.Json 和 IronPDF 从 JSON 数据生成 PDF 报告。这对于根据以 JSON 格式存储的数据创建动态报告的应用程序尤其有用。

下面是我们要使用的 JSON 文件示例:

{
    "Title": "Sales Report",
    "Month": "August",
    "Year": "2023",
    "TotalSales": "10000",
    "ItemsSold": "500"
}

该 JSON 数据代表一份简单的销售报告。

第一步是读取 JSON 文件(此处命名为 "data.json"),并使用 Newtonsoft.Json 将其解析为字典:

string jsonString = File.ReadAllText("data.json");
var reportData = JsonConvert.DeserializeObject<Dictionary<string, string>>(jsonString);
string jsonString = File.ReadAllText("data.json");
var reportData = JsonConvert.DeserializeObject<Dictionary<string, string>>(jsonString);
Dim jsonString As String = File.ReadAllText("data.json")
Dim reportData = JsonConvert.DeserializeObject(Of Dictionary(Of String, String))(jsonString)
VB   C#

执行此代码后,我们预计您将得到一个名为 reportData 的字典,其中包含表示 JSON 文件中的属性及其值的键值对。

接下来,我们将使用 reportData 中的数据生成一个 HTML 模板。我们使用 reportData 字典中的键将适当的值插入 HTML:

string htmlContent = $@"
<html>
<head><title>{reportData ["Title"]}</title></head>
<body>
    <h1>{reportData ["Title"]}</h1>
    <p>Month: {reportData ["Month"]}</p>
    <p>Year: {reportData ["Year"]}</p>
    <p>Total Sales: {reportData ["TotalSales"]}</p>
    <p>Items Sold: {reportData ["ItemsSold"]}</p>
</body>
</html>";
string htmlContent = $@"
<html>
<head><title>{reportData ["Title"]}</title></head>
<body>
    <h1>{reportData ["Title"]}</h1>
    <p>Month: {reportData ["Month"]}</p>
    <p>Year: {reportData ["Year"]}</p>
    <p>Total Sales: {reportData ["TotalSales"]}</p>
    <p>Items Sold: {reportData ["ItemsSold"]}</p>
</body>
</html>";
Dim htmlContent As String = $"
<html>
<head><title>{reportData ("Title")}</title></head>ignoreignore<body><h1>{reportData ("Title")}</h1><p>Month: {reportData ("Month")}</p><p>Year: {reportData ("Year")}</p><p>Total Sales: {reportData ("TotalSales")}</p><p>Items Sold: {reportData ("ItemsSold")}</p></body></html>"
VB   C#

最后,我们使用 IronPDF 将 HTML 代码转换为 PDF 文档。我们使用 ChromePdfRenderer 创建一个 PDF 渲染器,用它将 HTML 转换为 PDF,然后保存 PDF:

var Renderer = new ChromePdfRenderer();
var PDF = Renderer.RenderHtmlAsPdf(htmlContent);
PDF.SaveAs("Report.pdf");
var Renderer = new ChromePdfRenderer();
var PDF = Renderer.RenderHtmlAsPdf(htmlContent);
PDF.SaveAs("Report.pdf");
Dim Renderer = New ChromePdfRenderer()
Dim PDF = Renderer.RenderHtmlAsPdf(htmlContent)
PDF.SaveAs("Report.pdf")
VB   C#

Newtonsoft Jsonpath(如何为开发人员工作):图 1

用例 2 JSON 转 PDF 表单

在此用例中,我们将读取 JSON 数据,以填写 PDF 文档中的表单字段。在本例中,我们假设有以下 JSON 数据:

{
    "FirstName": "John",
    "LastName": "Smith",
    "PhoneNumber": "+19159969739",
    "Email": "John@email.com",
    "City": "Chicago"
}

此 JSON 表示一个人的个人信息。

首先,我们使用 Newtonsoft.Json 从文件中读取 JSON 数据并将其解析为字典:

string jsonString = File.ReadAllText("data.json");
var person = JsonConvert.DeserializeObject<Dictionary<string, string>>(jsonString);
string jsonString = File.ReadAllText("data.json");
var person = JsonConvert.DeserializeObject<Dictionary<string, string>>(jsonString);
Dim jsonString As String = File.ReadAllText("data.json")
Dim person = JsonConvert.DeserializeObject(Of Dictionary(Of String, String))(jsonString)
VB   C#

该软件创建了一个名为 "person "的字典,其中包含键"FirstName"、"LastName"、"PhoneNumber"、"Email"和"City"及其相应的值。

接下来,我们使用 IronPdf 打开 PDF 文档并获取表单:

var doc = PdfDocument.FromFile("myPdfForm.pdf");
var form = doc.Form;
var doc = PdfDocument.FromFile("myPdfForm.pdf");
var form = doc.Form;
Dim doc = PdfDocument.FromFile("myPdfForm.pdf")
Dim form = doc.Form
VB   C#

现在,我们可以使用 person 字典来填写 PDF 文档中的表单字段:

form.Fields [0].Value = person ["FirstName"];
form.Fields [1].Value = person ["LastName"];
form.Fields [2].Value = person ["PhoneNumber"];
form.Fields [3].Value = person ["Email"];
form.Fields [4].Value = person ["City"];
form.Fields [0].Value = person ["FirstName"];
form.Fields [1].Value = person ["LastName"];
form.Fields [2].Value = person ["PhoneNumber"];
form.Fields [3].Value = person ["Email"];
form.Fields [4].Value = person ["City"];
form.Fields (0).Value = person ("FirstName")
form.Fields (1).Value = person ("LastName")
form.Fields (2).Value = person ("PhoneNumber")
form.Fields (3).Value = person ("Email")
form.Fields (4).Value = person ("City")
VB   C#

每个表单字段都与字典中的一个键相关联。

最后,我们保存填好的 PDF 表单:

doc.SaveAs("myPdfForm_filled.pdf");
doc.SaveAs("myPdfForm_filled.pdf");
doc.SaveAs("myPdfForm_filled.pdf")
VB   C#

该方法将创建一个新的 PDF 文档,表单字段将使用 JSON 文件中的数据填写。

这演示了如何有效地使用 Newtonsoft.Json 来解析 JSON 数据,并使用 IronPDF 来处理 PDF 文档。

Newtonsoft Jsonpath(如何为开发人员工作):图 2

使用案例 3 将 PDF 元数据转换为 JSON

首先,使用 IronPDF 从 PDF 中提取元数据:

var PDF = IronPdf.PdfDocument.FromFile("document.pdf");
var metadata = PDF.MetaData;
var PDF = IronPdf.PdfDocument.FromFile("document.pdf");
var metadata = PDF.MetaData;
Dim PDF = IronPdf.PdfDocument.FromFile("document.pdf")
Dim metadata = PDF.MetaData
VB   C#

然后,使用 Newtonsoft.Json将数据序列化为 JSON 字符串:

string jsonString = JsonConvert.SerializeObject(metadata, Formatting.Indented);
File.WriteAllText("metadata.json", jsonString);
string jsonString = JsonConvert.SerializeObject(metadata, Formatting.Indented);
File.WriteAllText("metadata.json", jsonString);
Dim jsonString As String = JsonConvert.SerializeObject(metadata, Formatting.Indented)
File.WriteAllText("metadata.json", jsonString)
VB   C#

在这段代码中,"metadata "对象包含 "作者"、"标题"、"创建日期 "等属性。这些属性被序列化为 JSON 字符串,并写入名为 "metadata.json "的文件。

Newtonsoft Jsonpath(如何为开发人员工作):图 3

结合使用 Newtonsoft.Json 和 IronPDF,您可以在 PDF 文件和 JSON 之间进行数据转换,从而满足广泛的使用需求。

结论

总之,Newtonsoft.Json 和 IronPDF 一起为在 .NET 中处理 JSON 数据和生成 PDF 文件提供了强大而灵活的解决方案。通过使用 Newtonsoft.Json 将 JSON 数据解析为 .NET 对象或字典,我们可以处理这些数据并将其用于各种场合,如填写 PDF 表单或从模板生成动态 PDF 报告。IronPDF 使创建和管理 PDF 的过程变得简单而高效。

本文介绍了这两个库,重点介绍了它们的一些核心功能。然而,这两个库还能提供更多。我们强烈建议您查阅它们的大量文档,深入了解它们的特性和功能。

如果您有兴趣试用 IronPDF,他们提供了一个 免费试用因此,在购买之前,您可以探索其功能并评估其是否满足您的需求。一旦您决定继续使用 IronPDF,许可费用将从 $749 开始,其中包括继续使用我们讨论过的所有功能以及支持和更新。这将确保您拥有在.NET项目中有效生成、管理和处理PDF文件的工具和帮助。

< 前一页
Math Floor C#(开发者如何使用)
下一步 >
C# 和(它如何为开发人员工作)

准备开始了吗? 版本: 2024.9 刚刚发布

免费NuGet下载 总下载量: 10,731,156 查看许可证 >