C#序列化与反序列化（封装与拆收）

已于 2022-05-30 17:14:10 修改
阅读量368 收藏 1
点赞数 2
文章标签： json c#
于 2022-05-30 17:12:23 首次发布
原文链接：https://docs.microsoft.com/zh-cn/dotnet/standard/serialization/system-text-json-how-to?pivots=dotnet-6-0
版权

序列化有很多种方法

比如二进制序列化

xml序列化

json序列化

二进制序列化相较于其他两种会快，但是亲身体验并没有多大区别但是二进制是存储所有的信息流

xml序列化（没有试过但是原理差不多）

json序列化

json序列化相比于其他两种会更加便于阅读，比如：（下图是我导出的bin文件）（有对文件内容进行整理，是流所以是一条很多的那种，和很多.json文件一样，并不会分行的那种）

在Microsoft的dos文档中有看到这个，同步的创建是比较方便的，觉得很有帮助 

代码实现：

//所需要的引用：
using System.Text.Json;
using System.Text.Json.Serialization;

将.net对象进行序列化

若要将 JSON 编写为字符串或文件，请调用 JsonSerializer.Serialize 方法。

下面的示例将 JSON 创建为字符串：

using System.Text.Json;

namespace SerializeBasic
{
    public class WeatherForecast
    {
        public DateTimeOffset Date { get; set; }
        public int TemperatureCelsius { get; set; }
        public string? Summary { get; set; }
    }

    public class Program
    {
        public static void Main()
        {
            var weatherForecast = new WeatherForecast
            {
                Date = DateTime.Parse("2019-08-01"),
                TemperatureCelsius = 25,
                Summary = "Hot"
            };

            string jsonString = JsonSerializer.Serialize(weatherForecast);

            Console.WriteLine(jsonString);
        }
    }
}
// output:
//{"Date":"2019-08-01T00:00:00-07:00","TemperatureCelsius":25,"Summary":"Hot"}

默认情况下，JSON 输出会缩小（将删除空格、缩进和换行符）。

下面的示例使用同步代码创建 JSON 文件：

using System.Text.Json;

namespace SerializeToFile
{
    public class WeatherForecast
    {
        public DateTimeOffset Date { get; set; }
        public int TemperatureCelsius { get; set; }
        public string? Summary { get; set; }
    }

    public class Program
    {
        public static void Main()
        {
            var weatherForecast = new WeatherForecast
            {
                Date = DateTime.Parse("2019-08-01"),
                TemperatureCelsius = 25,
                Summary = "Hot"
            };

            string fileName = "WeatherForecast.json"; 
            string jsonString = JsonSerializer.Serialize(weatherForecast);
            File.WriteAllText(fileName, jsonString);

            Console.WriteLine(File.ReadAllText(fileName));
        }
    }
}
// output:
//{"Date":"2019-08-01T00:00:00-07:00","TemperatureCelsius":25,"Summary":"Hot"}

下面的示例使用异步代码创建 JSON 文件：

using System.Text.Json;

namespace SerializeToFileAsync
{
    public class WeatherForecast
    {
        public DateTimeOffset Date { get; set; }
        public int TemperatureCelsius { get; set; }
        public string? Summary { get; set; }
    }

    public class Program
    {
        public static async Task Main()
        {
            var weatherForecast = new WeatherForecast
            {
                Date = DateTime.Parse("2019-08-01"),
                TemperatureCelsius = 25,
                Summary = "Hot"
            };

            string fileName = "WeatherForecast.json";
            using FileStream createStream = File.Create(fileName);
            await JsonSerializer.SerializeAsync(createStream, weatherForecast);
            await createStream.DisposeAsync();

            Console.WriteLine(File.ReadAllText(fileName));
        }
    }
}
// output:
//{"Date":"2019-08-01T00:00:00-07:00","TemperatureCelsius":25,"Summary":"Hot"}

前面的示例对要序列化的类型使用类型推理。 Serialize() 的重载采用泛型类型参数：

using System.Text.Json;

namespace SerializeWithGenericParameter
{
    public class WeatherForecast
    {
        public DateTimeOffset Date { get; set; }
        public int TemperatureCelsius { get; set; }
        public string? Summary { get; set; }
    }

    public class Program
    {
        public static void Main()
        {
            var weatherForecast = new WeatherForecast
            {
                Date = DateTime.Parse("2019-08-01"),
                TemperatureCelsius = 25,
                Summary = "Hot"
            };

            string jsonString = JsonSerializer.Serialize<WeatherForecast>(weatherForecast);

            Console.WriteLine(jsonString);
        }
    }
}
// output:
//{"Date":"2019-08-01T00:00:00-07:00","TemperatureCelsius":25,"Summary":"Hot"}

序列化示例

以下示例演示了如何序列化包含集合属性和用户定义类型的类：

using System.Text.Json;

namespace SerializeExtra
{
    public class WeatherForecast
    {
        public DateTimeOffset Date { get; set; }
        public int TemperatureCelsius { get; set; }
        public string? Summary { get; set; }
        public string? SummaryField;
        public IList<DateTimeOffset>? DatesAvailable { get; set; }
        public Dictionary<string, HighLowTemps>? TemperatureRanges { get; set; }
        public string[]? SummaryWords { get; set; }
    }

    public class HighLowTemps
    {
        public int High { get; set; }
        public int Low { get; set; }
    }

    public class Program
    {
        public static void Main()
        {
            var weatherForecast = new WeatherForecast
            {
                Date = DateTime.Parse("2019-08-01"),
                TemperatureCelsius = 25,
                Summary = "Hot",
                SummaryField = "Hot",
                DatesAvailable = new List<DateTimeOffset>() 
                    { DateTime.Parse("2019-08-01"), DateTime.Parse("2019-08-02") },
                TemperatureRanges = new Dictionary<string, HighLowTemps>
                    {
                        ["Cold"] = new HighLowTemps { High = 20, Low = -10 },
                        ["Hot"] = new HighLowTemps { High = 60 , Low = 20 }
                    },
                SummaryWords = new[] { "Cool", "Windy", "Humid" }
            };

            var options = new JsonSerializerOptions { WriteIndented = true };
            string jsonString = JsonSerializer.Serialize(weatherForecast, options);

            Console.WriteLine(jsonString);
        }
    }
}
// output:
//{
//  "Date": "2019-08-01T00:00:00-07:00",
//  "TemperatureCelsius": 25,
//  "Summary": "Hot",
//  "DatesAvailable": [
//    "2019-08-01T00:00:00-07:00",
//    "2019-08-02T00:00:00-07:00"
//  ],
//  "TemperatureRanges": {
//    "Cold": {
//      "High": 20,
//      "Low": -10
//    },
//    "Hot": {
//    "High": 60,
//      "Low": 20
//    }
//  },
//  "SummaryWords": [
//    "Cool",
//    "Windy",
//    "Humid"
//  ]
//}

序列化行为

当你在 ASP.NET Core 应用中间接使用 System.Text.Json 时，某些默认行为会有所不同。 有关详细信息，请参阅 JsonSerializerOptions 的 Web 默认值。

支持的类型包括：

如何将 JSON 读取为 .NET 对象（反序列化）

反初始化 JSON 的常用方法是首先创建一个类，该类具有属性和表示一个或多个 JSON 属性的字段。 接着，若要从字符串或文件进行反序列化，请调用 JsonSerializer.Deserialize 方法。 对于泛型重载，传递创建的类的类型作为泛型类型参数。 对于非泛型重载，传递创建的类的类型作为方法参数。 可以以同步或异步方式反初始化。 将忽略类中未表示的任何 JSON 属性。

以下示例演示如何对 JSON 字符串进行反初始化：

using System.Text.Json;

namespace DeserializeExtra
{
    public class WeatherForecast
    {
        public DateTimeOffset Date { get; set; }
        public int TemperatureCelsius { get; set; }
        public string? Summary { get; set; }
        public string? SummaryField;
        public IList<DateTimeOffset>? DatesAvailable { get; set; }
        public Dictionary<string, HighLowTemps>? TemperatureRanges { get; set; }
        public string[]? SummaryWords { get; set; }
    }

    public class HighLowTemps
    {
        public int High { get; set; }
        public int Low { get; set; }
    }

    public class Program
    {
        public static void Main()
        {
            string jsonString =
@"{
  ""Date"": ""2019-08-01T00:00:00-07:00"",
  ""TemperatureCelsius"": 25,
  ""Summary"": ""Hot"",
  ""DatesAvailable"": [
    ""2019-08-01T00:00:00-07:00"",
    ""2019-08-02T00:00:00-07:00""
  ],
  ""TemperatureRanges"": {
                ""Cold"": {
                    ""High"": 20,
      ""Low"": -10
                },
    ""Hot"": {
                    ""High"": 60,
      ""Low"": 20
    }
            },
  ""SummaryWords"": [
    ""Cool"",
    ""Windy"",
    ""Humid""
  ]
}
";
                
            WeatherForecast? weatherForecast = 
                JsonSerializer.Deserialize<WeatherForecast>(jsonString);

            Console.WriteLine($"Date: {weatherForecast?.Date}");
            Console.WriteLine($"TemperatureCelsius: {weatherForecast?.TemperatureCelsius}");
            Console.WriteLine($"Summary: {weatherForecast?.Summary}");
        }
    }
}
// output:
//Date: 8/1/2019 12:00:00 AM -07:00
//TemperatureCelsius: 25
//Summary: Hot

若要使用同步代码从文件进行反序列化，请将文件读入字符串中，如下面的示例中所示：

using System.Text.Json;

namespace DeserializeFromFile
{
    public class WeatherForecast
    {
        public DateTimeOffset Date { get; set; }
        public int TemperatureCelsius { get; set; }
        public string? Summary { get; set; }
    }

    public class Program
    {
        public static void Main()
        {
            string fileName = "WeatherForecast.json";
            string jsonString = File.ReadAllText(fileName);
            WeatherForecast weatherForecast = JsonSerializer.Deserialize<WeatherForecast>(jsonString)!;

            Console.WriteLine($"Date: {weatherForecast.Date}");
            Console.WriteLine($"TemperatureCelsius: {weatherForecast.TemperatureCelsius}");
            Console.WriteLine($"Summary: {weatherForecast.Summary}");
        }
    }
}
// output:
//Date: 8/1/2019 12:00:00 AM -07:00
//TemperatureCelsius: 25
//Summary: Hot

 若要使用异步代码从文件进行反序列化，请调用 DeserializeAsync 方法：

using System.Text.Json;

namespace DeserializeFromFileAsync
{
    public class WeatherForecast
    {
        public DateTimeOffset Date { get; set; }
        public int TemperatureCelsius { get; set; }
        public string? Summary { get; set; }
    }

    public class Program
    {
        public static async Task Main()
        {
            string fileName = "WeatherForecast.json";
            using FileStream openStream = File.OpenRead(fileName);
            WeatherForecast? weatherForecast = 
                await JsonSerializer.DeserializeAsync<WeatherForecast>(openStream);

            Console.WriteLine($"Date: {weatherForecast?.Date}");
            Console.WriteLine($"TemperatureCelsius: {weatherForecast?.TemperatureCelsius}");
            Console.WriteLine($"Summary: {weatherForecast?.Summary}");
        }
    }
}
// output:
//Date: 8/1/2019 12:00:00 AM -07:00
//TemperatureCelsius: 25
//Summary: Hot

如果有要反序列化的 JSON，但没有反序列化的目标类，则除了手动创建所需的类外，还有其他选项：

  • 反序列化为文档对象模型 (JSON DOM)，并从 DOM 中提取所需的内容。

    DOM 允许你导航到 JSON 有效负载的子节，并反序列化单个值、自定义类型或数组。 有关 .NET 6 中的 JsonNode DOM 的信息，请参阅JsonNode。 有关 JsonDocument DOM 的详细信息，请参阅JsonDocument。

  • 直接使用 Utf8JsonReader。

  • 使用 Visual Studio 2022 自动生成所需的类：

    • 复制需要反序列化的 JSON。
    • 创建一个类文件并删除模板代码。
    • 选择“编辑”“选择性粘贴”“将 JSON 粘贴为类”。 结果是可用于反序列化目标的类。

序列化为格式化 JSON

若要对 JSON 输出进行优质打印，请将 JsonSerializerOptions.WriteIndented 设置为 true：

using System.Text.Json;

namespace SerializeWriteIndented
{
    public class WeatherForecast
    {
        public DateTimeOffset Date { get; set; }
        public int TemperatureCelsius { get; set; }
        public string? Summary { get; set; }
    }

    public class Program
    {
        public static void Main()
        {
            var weatherForecast = new WeatherForecast
            {
                Date = DateTime.Parse("2019-08-01"),
                TemperatureCelsius = 25,
                Summary = "Hot"
            };

            var options = new JsonSerializerOptions { WriteIndented = true };
            string jsonString = JsonSerializer.Serialize(weatherForecast, options);

            Console.WriteLine(jsonString);
        }
    }
}
// output:
//{
//  "Date": "2019-08-01T00:00:00-07:00",
//  "TemperatureCelsius": 25,
//  "Summary": "Hot"
//}

原文链接：（不得不说Microsoft帮助文档还是牛哇）如何使用 C# 对 JSON 进行序列化和反序列化 - .NET | Microsoft Docsicon-default.png?t=M4ADhttps://docs.microsoft.com/zh-cn/dotnet/standard/serialization/system-text-json-how-to?pivots=dotnet-6-0

开开心心做好自己的事
关注
  • 2
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
C8051的C语言的彻底应用_C语言_
10-03
C8051的C语言学习应用，教你如何快速学习掌握C8051的知识。
对象序列化为JSON
qq_43527485的博客
12-27 510
这段代码是C#代码，它使用Json.NET（也称为Newtonsoft.Json）库来设置JSON序列化选项。，以便在序列化JSON时包含缩进。这通常用于美化输出的JSON，使其更容易阅读。是Json.NET库中的一个类，用于配置JSON序列化和反序列化的行为。是C#中的一个关键字，用于声明一个隐式类型的局部变量。最终，这段代码的目的是创建一个新的。：这是一个对象初始化器，用于设置。：这是一个变量声明。
c#格式化json string
zhaoyahui_666的博客
07-23 634
c#格式化json string
序列化与反序列化
学习笔记
01-04 1767
在ASP.NET AJAX中使用了JSON作为客户端与服务器端传递对象信息的方式。因此，在ASP.NET AJAX的客户端与服务器端均提供了序列化与反序列化的能力。了解这些内容的使用方法，可以说是使用与扩展ASP.NET AJAX所必须的能力。在这两篇文章里，我们就来看一下ASP.NET AJAX中的序列化与反序列化的能力。一、客户端的序列化与反序列化能力：　　在ASP.NET AJAX中
C#实现封装序列化和反序列化操作的泛型工具类SerializeHandler
分享技术，传播知识!
09-30 1601
C#实现封装序列化和反序列化操作的泛型工具类SerializeHandler背景代码实现注意点 背景 在不同项目开的发过程中，可能会用到许多相同或类似的功能开发或业务处理，从抽象设计的角度考虑，通常会把这些功能或业务操作进行封装，方便在不同项目中调用，这也是重用思想的重要体现。本次分享的是在C#中实现序列化和反序列化的功能封装，包括二进制序列化、Soap序列化和xml序列化的泛型实现。 代码实现 ...
.net core 在网络高并发下提高JSON的处理效率
dcnna0422的博客
04-11 895
现有的webapi一般都基于JSON的格式来处理数据，由于JSON是一个文本类的序列化协议所以在性能上自然就相对低效一些。在.net中常用Newtonsoft.Json是最常用的组件，由于提供简便基于完整的json的String方法使用起来非常方便；但也正是这原因导致Newtonsoft.Json在性能上一直被说慢，虽然Newtonsoft.Json提供Stream的方式来处理JSON不...
.net 逐行读取大文本文件_一款功能强大的高性能二进制序列化器Bssom.Net
weixin_39746794的博客
11-26 174
(给DotNet加星标，提升.Net技能)转自：小曾看世界cnblogs.com/1996V/p/13884968.html前言开源了一款高性能的二进制序列化器Bssom.Net和新颖的二进制协议Bssom,欢迎大家Star,欢迎参与项目贡献!另外,我还在抖音申请了一个账号,用来记录自己的日常生活, 想了解我平常是怎么写代码的吗? 来关注我一下,哈哈! 抖音号: 198152455Bss...
C#实现Xml序列化与反序列化的方法
09-04
主要介绍了C#实现Xml序列化与反序列化的方法,将序列化与反序列化的方法封装入一个类文件中,包含了较为详尽的注释说明,非常具有实用价值,需要的朋友可以参考下
序列化和反序列化的封装类
04-22
序列化和反序列化的封装类，只要调用就行 序列化和反序列化的封装类 序列化和反序列化的封装类 序列化和反序列化的封装类 序列化和反序列化的封装类
C#实现xml序列化帮助类
12-14
C#帮助类（Helper class）是一种用于封装常用功能的类。它通常包含一组静态方法，这些方法能够执行特定的任务或提供通用的功能。帮助类的目的是为了提高代码的可重用性和可维护性，避免重复编写相似的功能代码。 ...
c#中带头（声明）的xml（封装）生成
01-02
代码如下: XmlDocument downLoadFilexml = new XmlDocument(); XmlElement root = null; XmlElement kisokChild = null; //生成xml的头 XmlNode xmlnode= downLoadFilexml.CreateXmlDeclaration(“1.0”, “utf-8”,...
电影售票系统（ 序列化对象）
03-20
c#电影售票通过序列化把对象封装，使用再把对象反序列化，并支持销售存储！售票信息通过XML提供 可自己再去扩展功能！！！
Java普通接口协议HTTP、数据封装和序列化、长连接、状态码
qq_43185254的博客
07-20 237
超文本传输协议(Hypertext Transfer Protocol，简称HTTP)是是一个应用层协议，HTTP协议是构建在TCP/IP协议之上的。HTTP 是一种请求/响应式的协议，即一个客户端与服务器建立连接后，向服务器发送一个请求;// Keep-Alive不会永久保持连接，它有一个持续时间，可以在不同的服务器软件中设定这个时间。HTTP 请求报文由请求行、请求头部、空行 和 请求包体 4 个部分组成。HTTP 1.1：默认使用长连接，用以保持连接特性。3xx表示请求被重定向。
[译]试用新的System.Text.Json API
weixin_30709929的博客
06-15 1402
译注 可能有的小伙伴已经知道了，在.NET Core 3.0中微软加入了对JSON的内置支持。 一直以来.NET开发者们已经习惯使用Json.NET这个强大的库来处理JSON。 那么.NET为什么要增加JSON的内置支持呢？ 最近，.NET的官方博客再次发表文章说明了这么做的原因、并介绍了相关API的用法。 现翻译出来分享给大家。 原文地址: https://devblogs.micr...
.NET 6 中 System.Text.Json 的新特性
dotNET跨平台
01-07 474
1支持忽略循环引用在 .NET 6 之前，如果 System.Text.Json 检测到循环引用，就会抛出 JsonException 异常。在 .NET 6 中，你可以忽略它们。Cate...
序列化_.Net Core 5.0 Json序列化和反序列化 | System.Text.Json 的json序列化和反序列化...
weixin_29131709的博客
01-13 1325
注意: .Net Core 5.0中的序列化和反序列化 ，沿用.Net Core 3.0版本的类封装JsonSerializer静态类JSONAPI：Utf8JsonReader -读操作，快速，低级Utf8JsonWriter -写操作，快速，低级JsonDocument-基于DOM，快速JsonSeriliazer -串行化/反串行化，快速二、序列化使用介绍...
C# 对象序列化之序列化为Json文件（二）
q__y__L的博客
05-17 301
本文接着上一篇补充几个问题 1序列化派生类的属性 不支持多态类型层次结构的序列化。 例如，如果属性定义为接口或抽象类，则即使运行时类型具有其他属性，也只会序列化对接口或抽象类定义的属性。 此部分中介绍了此行为的例外情况。 例如，假设有一个WeatherForecast类和一个派生类WeatherForecastDerived： public class WeatherForecast { public DateTimeOffset Date { get; set; } pu...
Ubuntu22.04本地部署qwen模型、jupyterlab开发环境、LoRA微调全流程-续
最新发布
weixin_42118737的博客
05-18 658
接着上一篇，在Ubuntu22.04本地部署qwen模型，准备数据，进行LoRA微调。
json序列化和反序列化 接口
08-23
- *1* [C#或.net json序列化反序列化，适用于与第三方系统做接口用](https://download.csdn.net/download/Man_508/12454543)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值