网站后台无法更新缓存,wordpress在php7.0,手游app开发公司,网页制作基本方法一、引言
在当今数字化时代#xff0c;数据的高效交换与处理成为软件开发的核心环节。JSON#xff08;JavaScript Object Notation#xff09;凭借其简洁、轻量且易于读写的特性#xff0c;已然成为数据交换领域的中流砥柱。无论是前后端数据交互#xff0c;还是配置文件…一、引言
在当今数字化时代数据的高效交换与处理成为软件开发的核心环节。JSONJavaScript Object Notation凭借其简洁、轻量且易于读写的特性已然成为数据交换领域的中流砥柱。无论是前后端数据交互还是配置文件的编写亦或是分布式系统间的数据传输JSON 都无处不在。
在 C# 的开发世界里.NET Core 3.0 及更高版本引入的 System.Text.Json 库为开发者提供了一套强大且高效的 JSON 序列化和反序列化解决方案。相较于旧有的库它不仅性能卓越还与.NET 平台深度集成更契合现代化开发的需求。
本文将全方位、深入地探讨 System.Text.Json 库的使用方法从基础的序列化与反序列化操作到进阶的自定义转换器、属性控制等高级特性通过丰富详实的代码示例助力开发者熟练掌握这一强大工具在项目开发中灵活运用提升数据处理的效率与质量。
二、System.Text.Json 简介
2.1 是什么
System.Text.Json 是内置于.NET Core 3.0 及后续版本的高性能 JSON 序列化器 专为高效处理 JSON 数据而设计。其与.NET 平台深度融合在性能、安全性及与现代开发模式的契合度上表现卓越。
在性能优化方面System.Text.Json 采用了先进的算法与数据结构在序列化和反序列化过程中极大地减少了内存分配与对象创建次数。在处理大型 JSON 文档时相较于部分传统 JSON 库其速度优势显著。例如在将复杂的业务对象转换为 JSON 字符串或从庞大的 JSON 数据中还原对象时能够快速完成操作为应用程序节省宝贵的时间开销。
在安全性上它默认采取了一系列安全措施有效防范常见的安全风险。如在反序列化时严格限制数据深度避免因恶意构造的 JSON 数据导致的栈溢出攻击对输入数据进行严格验证防止非法数据注入为应用程序筑牢安全防线。
此外System.Text.Json 全面支持.NET 中的各种数据类型无论是基本数据类型如整数、字符串、布尔值等还是复杂的自定义对象、泛型集合抑或是日期时间类型等都能精准地进行序列化和反序列化操作确保数据在不同形式间的无损转换。
2.2 与其他 JSON 库对比
在.NET 开发领域提及 JSON 处理Newtonsoft.Json即Json.NET曾是广泛使用的库。然而System.Text.Json 与之相比具有独特优势。
从性能维度剖析在处理大规模数据或高并发的序列化、反序列化场景时System.Text.Json 的表现更为出色。在一个电商系统中需频繁对大量商品信息包含复杂的嵌套结构与海量数据进行 JSON 序列化以传输给前端展示。经测试使用 System.Text.Json 的处理速度比 Newtonsoft.Json 快了近 30%内存占用也降低了约 25%。这得益于其底层针对 JSON 处理的优化设计如更高效的编码方式、更合理的内存管理策略等。
在集成度方面System.Text.Json 作为.NET Core 的内置库与.NET 平台无缝集成。在创建ASP.NET Core Web API 项目时默认的 JSON 序列化和反序列化功能就由 System.Text.Json 提供。开发者无需额外安装或配置即可直接使用大大简化了开发流程。而使用 Newtonsoft.Json 时需通过 NuGet 包管理器进行安装并进行相应的配置才能在项目中正常使用。
尽管 Newtonsoft.Json 功能丰富在处理复杂 JSON 结构与某些特殊场景时具有较高灵活性但 System.Text.Json 凭借其性能优势与深度集成特性在现代化的.NET 开发中尤其是注重性能与开发效率的项目里正逐渐成为开发者的首选 。
三、使用前准备
3.1 环境要求
若想在项目中畅享 System.Text.Json 库带来的便利项目的运行环境需满足一定条件。它最低要求项目基于.NET Core 3.0 版本及以上构建 。这意味着若你的项目版本低于此标准需将项目升级至.NET Core 3.0 或后续版本。
在 Visual Studio 中右键点击项目名称选择 “属性”。在弹出的属性窗口中切换至 “目标框架” 下拉菜单查看当前项目的目标框架版本。若版本低于.NET Core 3.0可从下拉菜单中选择合适的更高版本进行升级。需注意升级过程可能会因项目依赖、代码兼容性等问题需要对部分代码进行调整与测试以确保项目正常运行。
若因特殊原因无法升级项目框架可考虑选用其他 JSON 处理库如 Newtonsoft.Json 等以满足项目对 JSON 数据处理的需求 。
3.2 安装与导入
当项目环境满足要求后使用 System.Text.Json 库极为便捷。由于它是.NET Core 3.0 及更高版本的内置库无需通过 NuGet 等包管理器进行额外安装。
在代码文件中仅需在文件开头添加如下语句即可导入 System.Text.Json 命名空间开启对该库的使用之旅
using System.Text.Json;若在序列化或反序列化过程中涉及对属性的自定义设置、处理复杂类型等操作还需导入 System.Text.Json.Serialization 命名空间
using System.Text.Json.Serialization;如此一来在当前代码文件中便能自由调用 System.Text.Json 库中的各类方法与类型如 JsonSerializer 类的 Serialize 和 Deserialize 方法用于实现对象与 JSON 字符串之间的相互转换 。
四、基本使用方法
4.1 序列化基础
4.1.1 简单对象序列化
在实际开发中将对象转换为 JSON 字符串是常见操作。以一个简单的Person类为例展示如何利用 System.Text.Json 库实现对象的序列化。代码如下
using System;
using System.Text.Json;public class Person
{public string Name { get; set; }public int Age { get; set; }
}class Program
{static void Main(){var person new Person{Name 张三,Age 30};string jsonString JsonSerializer.Serialize(person);Console.WriteLine(jsonString);}
}上述代码中首先定义了Person类包含Name和Age两个属性。在Main方法中创建了Person类的实例person并为其属性赋值。接着使用JsonSerializer.Serialize方法将person对象转换为 JSON 格式的字符串。执行该代码控制台将输出如下结果
{Name:张三,Age:30}这便是Person对象序列化后的 JSON 字符串表示。通过这种方式可方便地将对象数据在网络中传输或存储到文件、数据库等介质中 。
4.1.2 复杂对象序列化
实际应用场景中数据结构往往更为复杂包含嵌套对象、集合等。假设有一个表示订单的Order类其中包含客户信息、订单明细列表等。代码实现如下
using System;
using System.Collections.Generic;
using System.Text.Json;public class Customer
{public string Name { get; set; }public string Email { get; set; }
}public class OrderItem
{public string ProductName { get; set; }public int Quantity { get; set; }public decimal Price { get; set; }
}public class Order
{public int OrderId { get; set; }public Customer Customer { get; set; }public ListOrderItem OrderItems { get; set; }
}class Program
{static void Main(){var customer new Customer{Name 李四,Email lisiexample.com};var orderItem1 new OrderItem{ProductName 笔记本电脑,Quantity 1,Price 5999.99m};var orderItem2 new OrderItem{ProductName 无线鼠标,Quantity 2,Price 99.99m};var order new Order{OrderId 1001,Customer customer,OrderItems new ListOrderItem { orderItem1, orderItem2 }};string jsonString JsonSerializer.Serialize(order);Console.WriteLine(jsonString);}
}上述代码定义了Customer类、OrderItem类和Order类其中Order类包含Customer类型的属性和OrderItem类型的集合属性。在Main方法中创建了相应的对象实例并将其组装成一个完整的订单信息。最后通过JsonSerializer.Serialize方法对Order对象进行序列化。执行代码输出的 JSON 字符串如下
{OrderId:1001,Customer:{Name:李四,Email:lisiexample.com},OrderItems:[{ProductName:笔记本电脑,Quantity:1,Price:5999.99},{ProductName:无线鼠标,Quantity:2,Price:99.99}]}可以看到System.Text.Json 库能够准确地将复杂对象结构序列化为对应的 JSON 格式确保数据的完整性与准确性 。
4.2 反序列化基础
4.2.1 简单 JSON 字符串反序列化
将 JSON 字符串还原为对象是与序列化相反的过程。对于简单的 JSON 字符串使用 System.Text.Json 库进行反序列化同样便捷。以之前的Person类为例假设从外部获取到一个 JSON 字符串需要将其转换为Person对象。代码如下
using System;
using System.Text.Json;public class Person
{public string Name { get; set; }public int Age { get; set; }
}class Program
{static void Main(){string jsonString {\Name\:\王五\,\Age\:25};Person person JsonSerializer.DeserializePerson(jsonString);Console.WriteLine($姓名: {person.Name}, 年龄: {person.Age});}
}在这段代码中通过JsonSerializer.Deserialize方法将包含Person对象信息的 JSON 字符串转换回Person类型的对象。Deserialize方法的泛型参数指定了要转换的目标类型。执行该代码控制台将输出
姓名: 王五, 年龄: 25如此便实现了简单 JSON 字符串到对象的反序列化操作为后续对对象数据的处理提供了基础 。
4.2.2 处理复杂 JSON 结构反序列化
面对多层嵌套、数组等复杂结构的 JSON 数据反序列化时需确保定义的类结构与 JSON 结构相匹配。例如有如下复杂的 JSON 数据
{OrderId: 1002,Customer: {Name: 赵六,Email: zhaoliuexample.com},OrderItems: [{ProductName: 平板电脑,Quantity: 1,Price: 2999.99},{ProductName: 蓝牙键盘,Quantity: 1,Price: 199.99}]
}针对该 JSON 数据反序列化的代码实现如下
using System;
using System.Collections.Generic;
using System.Text.Json;public class Customer
{public string Name { get; set; }public string Email { get; set; }
}public class OrderItem
{public string ProductName { get; set; }public int Quantity { get; set; }public decimal Price { get; set; }
}public class Order
{public int OrderId { get; set; }public Customer Customer { get; set; }public ListOrderItem OrderItems { get; set; }
}class Program
{static void Main(){string jsonString {OrderId: 1002,Customer: {Name: 赵六,Email: zhaoliuexample.com},OrderItems: [{ProductName: 平板电脑,Quantity: 1,Price: 2999.99},{ProductName: 蓝牙键盘,Quantity: 1,Price: 199.99}]};Order order JsonSerializer.DeserializeOrder(jsonString);Console.WriteLine($订单ID: {order.OrderId});Console.WriteLine($客户姓名: {order.Customer.Name}, 客户邮箱: {order.Customer.Email});Console.WriteLine(订单明细:);foreach (var item in order.OrderItems){Console.WriteLine($商品名称: {item.ProductName}, 数量: {item.Quantity}, 价格: {item.Price});}}
}在上述代码中定义的Order类、Customer类和OrderItem类的结构与 JSON 数据结构一一对应。通过JsonSerializer.Deserialize方法将复杂的 JSON 字符串成功转换为Order对象。随后通过遍历Order对象的属性输出订单的详细信息。执行代码控制台将输出完整的订单信息包括订单 ID、客户信息以及订单明细 。在处理复杂 JSON 结构反序列化时准确匹配类结构至关重要确保每个属性的名称、类型和层级关系与 JSON 数据一致才能实现正确的反序列化。
五、进阶技巧
5.1 自定义序列化行为
5.1.1 自定义转换器
在实际开发中默认的序列化和反序列化行为可能无法满足所有需求。例如在处理日期类型时若期望使用特定的日期格式进行序列化和反序列化可通过自定义转换器实现。
以将日期格式化为 “yyyy-MM-dd” 为例代码如下
using System;
using System.Text.Json;
using System.Text.Json.Serialization;public class Person
{public string Name { get; set; }public DateTime BirthDate { get; set; }
}public class CustomDateTimeConverter : JsonConverterDateTime
{public override DateTime Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options){return DateTime.ParseExact(reader.GetString(), yyyy-MM-dd, System.Globalization.CultureInfo.InvariantCulture);}public override void Write(Utf8JsonWriter writer, DateTime value, JsonSerializerOptions options){writer.WriteStringValue(value.ToString(yyyy-MM-dd));}
}class Program
{static void Main(){var options new JsonSerializerOptions{Converters { new CustomDateTimeConverter() }};var person new Person{Name 张三,BirthDate new DateTime(1990, 1, 1)};string jsonString JsonSerializer.Serialize(person, options);Console.WriteLine(jsonString);Person deserializedPerson JsonSerializer.DeserializePerson(jsonString, options);Console.WriteLine($姓名: {deserializedPerson.Name}, 出生日期: {deserializedPerson.BirthDate});}
}在上述代码中首先定义了CustomDateTimeConverter类它继承自JsonConverter并重写了Read和Write方法。在Read方法中将读取到的 JSON 字符串按照指定格式转换为DateTime类型在Write方法中将DateTime类型的值格式化为指定的字符串后写入 JSON。
接着在JsonSerializerOptions中注册该自定义转换器。在进行序列化和反序列化操作时使用包含自定义转换器的JsonSerializerOptions实例从而实现对日期类型的自定义序列化和反序列化逻辑 。
5.1.2 使用特性控制序列化
System.Text.Json 提供了丰富的特性用于精细控制属性在 JSON 中的序列化和反序列化行为。其中JsonPropertyName特性尤为常用可指定属性在 JSON 中的名称。
假设有如下Product类希望在 JSON 中ProductName属性显示为 “商品名称”Price属性显示为 “价格”代码实现如下
using System.Text.Json.Serialization;public class Product
{[JsonPropertyName(商品名称)]public string ProductName { get; set; }[JsonPropertyName(价格)]public decimal Price { get; set; }
}在进行序列化时Product类的实例将按照特性指定的名称生成 JSON。例如
using System.Text.Json;class Program
{static void Main(){var product new Product{ProductName 笔记本电脑,Price 5999.99m};string jsonString JsonSerializer.Serialize(product);Console.WriteLine(jsonString);}
}执行上述代码输出的 JSON 字符串为
{商品名称:笔记本电脑,价格:5999.99}通过这种方式可灵活调整属性在 JSON 中的表示使其更符合业务需求或外部接口的要求。此外还有JsonIgnore特性用于在序列化和反序列化时忽略某个属性JsonRequired特性用于指定某个属性在 JSON 中必须存在等开发者可根据实际情况合理运用这些特性优化 JSON 序列化和反序列化的效果 。
5.2 优化序列化与反序列化
5.2.1 性能优化策略
在处理大规模数据或对性能要求极高的场景下优化 System.Text.Json 的序列化和反序列化性能至关重要。
从减少内存占用角度出发可避免在序列化和反序列化过程中创建过多不必要的临时对象。在处理大型集合时尽量使用Span和Memory等类型这些类型提供了对内存的高效访问方式减少了内存复制和垃圾回收的压力。在反序列化一个包含大量数据的 JSON 数组时使用Utf8JsonReader直接读取 JSON 数据并利用Span来处理数据可有效降低内存占用。
为提高序列化和反序列化速度可对常用的类型进行缓存。由于每次序列化和反序列化操作时System.Text.Json 都需对类型信息进行解析和处理通过缓存类型信息可避免重复的解析工作显著提升性能。可创建一个静态字典用于存储已解析的类型信息在进行序列化和反序列化操作前先检查字典中是否存在对应的类型信息若存在则直接使用从而减少类型解析的时间开销。
此外合理配置JsonSerializerOptions也能提升性能。在序列化时可根据数据特点设置合适的Encoder以减少字符编码转换的时间在反序列化时通过设置PropertyNameCaseInsensitive为true可避免在属性名称匹配时进行大小写转换提高匹配速度 。
5.2.2 处理特殊情况
在实际应用中常遇到一些特殊情况如处理空值、循环引用等需进行特殊配置和处理。
当遇到空值时可通过配置JsonSerializerOptions设置DefaultIgnoreCondition JsonIgnoreCondition.WhenWritingNull使序列化过程中忽略值为null的属性。例如
using System.Text.Json;
using System.Text.Json.Serialization;public class Product
{public string Name { get; set; }public string Description { get; set; }
}class Program
{static void Main(){var product new Product{Name 鼠标,Description null};var options new JsonSerializerOptions{DefaultIgnoreCondition JsonIgnoreCondition.WhenWritingNull};string jsonString JsonSerializer.Serialize(product, options);Console.WriteLine(jsonString);}
}上述代码中由于Description属性值为null且设置了忽略空值属性输出的 JSON 字符串将不包含Description属性
{Name:鼠标}若处理对象间的循环引用可在JsonSerializerOptions中设置ReferenceHandler ReferenceHandler.Preserve。假设存在两个相互引用的类ClassA和ClassB
using System.Text.Json.Serialization;public class ClassB;public class ClassA
{public string Name { get; set; }public ClassB RelatedB { get; set; }
}public class ClassB
{public string Name { get; set; }public ClassA RelatedA { get; set; }
}在进行序列化时可通过如下方式处理循环引用
using System.Text.Json;class Program
{static void Main(){var a new ClassA{Name A实例,};var b new ClassB{Name B实例,RelatedA a};a.RelatedB b;var options new JsonSerializerOptions{ReferenceHandler ReferenceHandler.Preserve};string jsonString JsonSerializer.Serialize(a, options);Console.WriteLine(jsonString);}
}通过上述配置在序列化包含循环引用的对象时System.Text.Json 会使用引用标识符来处理循环避免无限递归确保序列化和反序列化的正常进行 。
六、实际应用案例
6.1 Web API 数据交互
在ASP.NET Core Web API 开发中System.Text.Json 扮演着关键角色负责处理请求和响应数据的序列化与反序列化。
假设创建一个管理图书信息的 Web API。首先定义Book类用于表示图书信息
public class Book
{public int Id { get; set; }public string Title { get; set; }public string Author { get; set; }public decimal Price { get; set; }
}接着在控制器中创建一个获取所有图书的方法。在这个方法中从数据库或其他数据源获取图书列表并将其作为响应返回给客户端。由于ASP.NET Core 默认使用 System.Text.Json 进行 JSON 序列化返回的图书列表会自动序列化为 JSON 格式。代码如下
[ApiController]
[Route([controller])]
public class BookController : ControllerBase
{private readonly ListBook _books new ListBook{new Book { Id 1, Title C#编程指南, Author 张三, Price 59.99m },new Book { Id 2, Title ASP.NET Core实战, Author 李四, Price 79.99m }};[HttpGet]public IEnumerableBook GetBooks(){return _books;}
}当客户端发送 GET 请求到/Book端点时Web API 会将_books列表序列化为如下 JSON 格式的响应
[{Id: 1,Title: C#编程指南,Author: 张三,Price: 59.99},{Id: 2,Title: ASP.NET Core实战,Author: 李四,Price: 79.99}
]在接收客户端请求时System.Text.Json 同样发挥作用。比如创建一个添加图书的方法客户端通过 POST 请求将图书信息以 JSON 格式发送到服务器Web API 会自动将请求中的 JSON 数据反序列化为Book对象。代码如下
[HttpPost]
public IActionResult AddBook([FromBody] Book book)
{_books.Add(book);return CreatedAtAction(nameof(GetBooks), new { id book.Id }, book);
}客户端发送的 POST 请求体可能如下
{Title: 新的图书,Author: 王五,Price: 49.99
}Web API 接收到请求后利用 System.Text.Json 将其反序列化为Book对象进而完成图书添加操作 。通过这种方式System.Text.Json 在 Web API 的数据交互中实现了数据的高效、准确传输与处理为前后端的顺畅通信提供了有力支持。
6.2 数据存储与读取
在实际项目中常需将数据以 JSON 格式存储到文件或数据库中以便后续读取和使用。借助 System.Text.Json 库这一过程变得简单高效。
以将用户配置信息存储到文件为例首先定义表示用户配置的类
public class UserConfig
{public string Username { get; set; }public string Email { get; set; }public int Theme { get; set; }
}在需要存储配置信息时创建UserConfig对象实例并将其序列化为 JSON 字符串后写入文件。代码如下
var config new UserConfig
{Username admin,Email adminexample.com,Theme 1
};string jsonString JsonSerializer.Serialize(config);
File.WriteAllText(config.json, jsonString);上述代码将config对象序列化为 JSON 字符串并使用File.WriteAllText方法将其写入名为config.json的文件中。
当需要读取配置信息时从文件中读取 JSON 字符串并将其反序列化为UserConfig对象。代码如下
string json File.ReadAllText(config.json);
UserConfig loadedConfig JsonSerializer.DeserializeUserConfig(json);
Console.WriteLine($用户名: {loadedConfig.Username}, 邮箱: {loadedConfig.Email}, 主题: {loadedConfig.Theme});在数据库存储方面假设使用 SQLite 数据库可将 JSON 数据存储在文本类型的字段中。在插入数据时先将对象序列化为 JSON 字符串再执行 SQL 插入语句。例如使用Dapper库进行数据操作
using Dapper;
using System.Data.SQLite;var person new Person
{Name 赵七,Age 35
};string jsonPerson JsonSerializer.Serialize(person);using (var connection new SQLiteConnection(Data Sourcetest.db))
{string insertQuery INSERT INTO People (JsonData) VALUES (JsonData);connection.Execute(insertQuery, new { JsonData jsonPerson });
}在读取数据时从数据库中获取 JSON 字符串再进行反序列化。代码如下
using (var connection new SQLiteConnection(Data Sourcetest.db))
{string selectQuery SELECT JsonData FROM People WHERE Id 1;string jsonResult connection.QuerySinglestring(selectQuery);Person retrievedPerson JsonSerializer.DeserializePerson(jsonResult);Console.WriteLine($姓名: {retrievedPerson.Name}, 年龄: {retrievedPerson.Age});
}通过这些示例可以看出无论是文件存储还是数据库存储System.Text.Json 库都能很好地实现数据的序列化存储与反序列化读取确保数据的持久化与恢复 。
七、常见问题与解决方案
7.1 序列化和反序列化错误排查
在使用 System.Text.Json 进行序列化和反序列化操作时难免会遭遇各种错误。其中类型不匹配和属性丢失是较为常见的问题。
当出现类型不匹配的情况时如在反序列化时JSON 数据中的某个属性值的类型与目标类中对应属性的类型不一致便会抛出异常。假设目标类中有一个int类型的属性而 JSON 数据中该属性的值却是一个字符串就会引发此类错误。此时需仔细检查 JSON 数据与目标类的属性类型确保二者完全匹配。在反序列化前可对 JSON 数据进行预处理将不匹配的类型转换为目标类型或者调整目标类的属性类型以适应 JSON 数据。
属性丢失也是常见错误之一。若 JSON 数据中缺少目标类中某个必需的属性在反序列化时可能会导致属性值为默认值或者抛出异常取决于具体配置。为解决该问题可在目标类的属性上使用JsonPropertyName特性明确指定 JSON 数据中对应的属性名称防止因名称不一致导致的属性丢失。同时在反序列化时仔细检查 JSON 数据的结构确保包含目标类所需的所有属性 。
7.2 性能瓶颈解决
尽管 System.Text.Json 在性能方面表现出色但在特定场景下仍可能出现性能瓶颈。
在处理超大规模数据时序列化和反序列化的速度可能无法满足需求。此时可通过优化数据结构来提升性能。减少不必要的嵌套层次简化对象结构能降低处理的复杂度。在序列化一个包含多层嵌套的复杂对象时若某些嵌套层级并非必需可将其扁平化处理从而加快序列化和反序列化的速度。
若在高并发环境下频繁的序列化和反序列化操作可能导致资源竞争和性能下降。针对这种情况可采用缓存策略将常用的序列化和反序列化结果进行缓存。在下次需要相同数据的转换时先从缓存中获取避免重复的转换操作有效减轻系统负担提升整体性能 。
八、总结与展望
System.Text.Json 库作为.NET 开发中处理 JSON 数据的核心工具具备强大的功能与卓越的性能 。通过本文的深入探索我们系统掌握了其基础与进阶用法。从简单对象到复杂结构的序列化与反序列化再到自定义序列化行为、优化性能等操作开发者能够依据不同的业务需求灵活运用该库实现高效的数据处理。
展望未来随着.NET 技术的持续演进System.Text.Json 库有望在性能、功能及易用性方面实现更大突破。在面对日益复杂的应用场景与海量数据时相信它将提供更强大的解决方案助力开发者轻松应对各种挑战。
衷心希望本文能成为你在使用 System.Text.Json 库道路上的得力指南为你的开发工作注入新的活力与效率。期待你在实际项目中充分发挥其优势创造出更优秀的应用程序 。
