酷站(www.ku0.com)-致力于为互联网从业者提供动力!

热门关键词:  企业  as  baidu  c4rp3nt3r  美女
【ECS精选特惠】新用户上云低至1折起
百度资源

.NET Core 3.0里新的JSON API介绍

来源:互联网搜集 作者:秩名 人气: 发布时间:2020-03-17
本篇文章主要介绍了.NET Core 3.0里新的JSON API介绍,对大家的学习或者工作具有一定的参考学习价值,感兴趣的小伙伴们可以参考一下,也感谢大家对酷站(ku0.com)的支持。

为什么需要新的 JSON API ?

JSON.NET  大家都用过,老版本的 ASP.NET Core 也依赖于 JSON.NET 。  

然而这个依赖就会引起一些版本问题:例如 ASP .NET  Core某个版本需要使用 JSON .NET  v10 ,而另一个库需要使用 JSON.NET  v11 ;或者 JSON .NET   出现了一个新版本,而ASP .NET Core 还不能支持这个版本,而您却想使用该版本。  

System.Text.Json  

随着 NET Core  3.0 的出现,出现了 System .Text.Json 命名空间和它下面一些用于处理 JSON 的类。  

特点

这个内置 JSON API 具有与生俱来的高性能、地分配的特点:  

JSON .NET  使用 .NET  里面的字符串作为基本数据类型,其实也就是 UTF16 ,而 .NET Core 中新的 JSON  API 直接使用数据原始的 UTF8 格式。  

新的 JSON API 基于 Span <byte> 这个数据类型来进行操作 JSON 数据,从而具有低分配的特点,这就可以极大的改善吞吐量和内存使用情况。  

但是新的JSON API 的特性还不那么丰富,有一些 JSON .NET 具有的特性都还不支持。  

例子  

随便找了一个 JSON 示例文件:  

针对这个文件,需要修改一下它的属性:

Utf8JsonReader  

先使用   Utf8JsonReader  来读取JSON文件。  

Utf8JsonReader   并不会读取文件或者 stream ,它会读取Span数据类型。  

直接上代码:

Main方法里面,我们使用 File .ReadAllBytes 从 sample .json 文件读取数格式为 byte[] ,然后通过 AsSpan 这个扩展方法将其转化为 Span <byte> 数据类型,然后把它传递到   Utf8JsonReader  的构造函数来创建一个JSON的 reader 。  

接下来使用while循环对JSON数据的每个 Token 进行读取,每次执行 Read() 方法时, reader 就会移动到 JSON 数据里面的下一个 Token 那里。  

Token 分成几种类型, GetToken Info 方法就是判断一下 Token 的类型,并返回一些描述性信息,这里面应该是包含了所有的类型。这里面使用到了C#  8  的  switch  表达式。  

运行程序

结果如下:

可以看到 sample.json 文件里面的每个 Token 都被正确的显示了。  

Json Document 类  

Json Document 是基于 Utf8JsonReader  构建的 。 JsonDocument  可分析  JSON  数据并生成只读文档对象模型  (DOM) ,可对模型进行查询,以支持随机访问和枚举。使用  JsonDocument  分析常规  JSON  有效负载并访问其所有成员比使用  Json.NET  快  2-3  倍,且为合理大小(即  < 1 MB )的数据所分配的量非常少。  

JsonDocument 可以处理 Span ,也可以处理 Stream 。  

例子:

这里我通过 File .OpenRead 把 json 文件转化为 stream 。然后使用 Json Document.Parse 方法把 stream 解析成 JSON 文档对象模型。  

注意,这里我使用了 C# 8 的 using var 语法,这个以后再说。  

下面我们开始从这个 JSON 文档对象模型的根节点开始遍历,也就是 RootElement :  

然后通过 root 这个 JsonElement 类型的对象的 GetProperty 方法来获得相应的属性,而且这个方法可以连串使用:  

最后一行使用 GetString 方法来获得该属性的字符串值。  

然后我们可以写一个递归调用的方法来遍历整个模型的每个属性:

这个方法接受 JsonElement 类型的对象,然后对该元素的属性进行循环。  

如果当前属性是另一个对象,那么就继续递归调用这个方法;

否则就输出原始的文本。

最后调用该方法:

输出结果为:

与json文件的内容匹配。

Utf8JsonWriter 类  

下面研究一下如何写入json文件。这里需要使用Utf 8JsonWriter 类。  

直接看代码:

这个类需要传递的参数类型是 Stream 或者Buffer,也就是向 Stream 或 Buffer 里面写入数据。  

那么就提供一个 buffer :  

下面单独写一个方法,来生成json数据:

参数类型是Utf 8JsonWriter 。通过智能提示可以看到它提供了很多用于写入不同类型数据的方法。  

写 JSON 对象  

现在我想写一个json对象,那么就从Write StartObject () 开始,然后以WriteEnd Object() 结束 :  

这样的话,实际上我已经拥有了一个合法的json文档。

写属性和值  

可以分开写属性和值:

也可以同时把属性和值写出来:

显示 JSON 数据  

我先写这些内容,然后在Main方法里面调用一下:

首先需要告诉writer把它的内容flush给buffer,使用这个buffer我们可以获得 writer 的输出,这样的话就会得到一个byte数组,然后把这个 byte 数组转化为字符串,这样就可以在控制台显示它了:  

运行一下看看效果:

没啥太大的问题,就是格式不好看。

对输出进行格式化  

.NET Core 提供了一个 JsonWrite r Options 类,它可以对Writer进行一些设置。  

这里对输出进行了缩进,最后把这个options传递给Utf 8JsonWriter 的构造函数即可。  

再次运行:

现在好看多了。

JsonSerializer  

前面几节的内容可能稍微有点底层,我们大部分时候可能只需要对 C# 的类进行串行化或者将 JSON 数据反串行化成 C# 类,在 .NET Core  3.0 里面,我们可以使用 JsonSerializer 这个类来做这些事情。  

例子:

还是使用之前用到的 json 数据:  

然后我们需要建建立两个类,对应这个文件:

反串行化  

可以使用Json Serializer 类的 Deserialize() 方法对 json 数据反串行化。这个方法支持三种类型的输入参数,分别是:  

  • JSON数据的字符串
  • Utf 8JsonReader  
  • Read OnlySpan<byte> ,它里面包含 JSON 数据  

为了简单一点,我直接把json文件读取成字符串,然后传给 Deserialize 方法:  

然后我试图打印出反串行化之后的一些属性数据。但是这不会成功。因为JSON文件里面数据的大小写命名规范使用的是 camel casing (简单理解为首字母是小写的),而默认情况下 Deserializer 会寻找 Pascal casing 这种规范(简单理解为每个单词的首字母都是大写的)的属性名。  

格式化  

为解决这个问题,就需要使用 JsonSerializerOptions 类:  

建立该类的一个实例,设置 Property NamingPolicy 为 CamelCase ,然后把这个实例传递给 Deserialize 方法的第二个参数。  

运行看结果 :  

这次就没有问题了。

串行化  

Json Serializer 也支持串行化,也就是把C#数据转化为 JSON 数据:  

这里使用了相同的 options 。  

运行结果:

如果想让输出结果更好看一些,可以在 JsonSerializerOptions 里面进行相应的设置:  

这次输出结果为:

总结  

总结一下 .NET Core 3.0 新的JSON  API :  

  • Utf 8JsonReader -  读操作,快速,低级  
  • Utf 8JsonWriter -  写操作,快速,低级  
  • JsonDocument -  基于DOM,快速  
  • Json Seriliazer -  串行化 / 反串行化,快速  

另外 JSON .NET  仍然被支持。  

版权声明:本文内容来源于互联网或用户自行发布贡献,该文观点仅代表原作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 959677720#qq.cn(#换@) 举报,一经查实,本站将立刻删除。
原文链接:https://www.cnblogs.com/cgzl/p/11736011.html

相关文章

  • .NET Core 3.0里新的JSON API介绍

    .NET Core 3.0里新的JSON API介绍

    为什么需要新的 JSON API ? JSON.NET 大家都用过,老版本的 ASP.NET Core 也依赖于 JSON.NET 。 然而这个依赖就会引起一些版本问题:例如 ASP .NET Core某个版本需要使用 JSON .NET v10 ,而另一个库需要使用 JSON.NET v11 ;或者 JSON ......
    03-17
  • Net Core Web Api项目与在NginX下发布的方法

    Net Core Web Api项目与在NginX下发布的方法

    前言 本文将介绍Net Core的一些基础知识和如何NginX下发布Net Core的WebApi项目。 测试环境 操作系统:windows 10 开发工具:visualstudio 2019 框架:Net Core 3 Net Core WebApi项目创建 首先创建一个Net Core WebApi项目CorePublishFo......
    03-17
  • ASP.NET Core中的Http缓存使用

    ASP.NET Core中的Http缓存使用

    Http响应缓存可减少客户端或代理对web服务器发出的请求数。响应缓存还减少了web服务器生成响应所需的工作量。响应缓存由Http请求中的header控制。 而ASP.NET Core对其都有相应的实现,并不需要了解里面的工作细节,即可对其进行良好的控......
    03-08
  • 详解把.net Core项目迁移到VS2019 for MAC的方法

    详解把.net Core项目迁移到VS2019 for MAC的方法

    VS2019 for MAC已经发布很长时间了,本以为项目移过去很麻烦,一直没有动作,最近呆家里快发霉了,决定研究研究,没想到一句代码都不需要动,直接完功,这下可以生产了。同学们可以放心整了。 本次平台的需求: MAC OS : mac OS Catalin......
    03-08
  • .NET Core基于Websocket实现的在线聊天室

    .NET Core基于Websocket实现的在线聊天室

    什么是Websocket 我们在传统的客户端程序要实现实时双工通讯第一想到的技术就是socket通讯,但是在web体系是用不了socket通讯技术的,因为http被设计成无状态,每次跟服务器通讯完成后就会断开连接。 在没有websocket之前web系统如果要做......
    03-07
  • 详解在ASP.NET Core Mvc集成MarkDown的方法

    详解在ASP.NET Core Mvc集成MarkDown的方法

    这几天在做文章编辑,首先就想到了markdown,它比其它的都要新,而且很好用,相对于其它的html编辑器,好久不更新,要好得多,哦~对了我现在已经用上新版的Edge了,经过很多朋友测试,性能比谷歌浏览器都要好很多,并且资源消耗也相对来......
    03-05
  • ASP.Net Core3.0中使用JWT认证

    ASP.Net Core3.0中使用JWT认证

    JWT认证简单介绍 关于Jwt的介绍网上很多,此处不在赘述,我们主要看看jwt的结构。 JWT主要由三部分组成,如下: 1 HEADER.PAYLOAD.SIGNATURE HEADER包含token的元数据,主要是加密算法,和签名的类型,如下面的信息,说明了 加密的对象类......
    02-27
  • asp.net全局变量的实例介绍

    asp.net全局变量的实例介绍

    asp.net获取全局变量方法 第一种,首先打开visual studio,新建web项目。 其次,在新建的web项目中,打开web.config文件,在此文件中添加关键字appSettings标记,如下图所示。 第三,在appSettings中添加你想要的全局变量add key=key1 val......
    02-27
  • ASP.NET Core MVC 中实现中英文切换

    ASP.NET Core MVC 中实现中英文切换

    哈喽..大家好 很久没有更新了,今天就来一篇最近开发用到的功能,那就是中英文切换,这个实际上也不是高大上,先说一下原理,在.NET Core框架中给我们提供了全球化的类,叫做Localization,其官方的文档地址传送门。 在我的项目中,我是......
    02-24
  • 详解asp.net core 授权方法

    详解asp.net core 授权方法

    IAuthorizeDate接口代表了授权系统的源头: public interface IAuthorizeData{ string Policy { get; set; } string Roles { get; set; } string AuthenticationSchemes { get; set; }} 接口中定义的三个属性分别代表了三种授权类型: 1......
    01-23

最新更新