CN110825376A

CN110825376A - 一种解析带注释json文件的方法、存储介质及装置

Info

Publication number: CN110825376A
Application number: CN201810890555.6A
Authority: CN
Inventors: 吴晓红
Original assignee: Shenzhen TCL Digital Technology Co Ltd
Current assignee: Shenzhen TCL Digital Technology Co Ltd
Priority date: 2018-08-07
Filing date: 2018-08-07
Publication date: 2020-02-21
Anticipated expiration: 2038-08-07
Also published as: CN110825376B

Abstract

本发明公开了一种解析带注释JSON文件的方法、存储介质及装置，其中，所述方法包括步骤：读取带注释JSON文件并将所述带注释JSON文件转换成带注释JSON字符串文件；对所述带注释JSON字符串文件中的注释内容和非注释内容进行识别，并将识别的注释内容进行剔除，得到不带注释的JSON字符串文件；将所述不带注释的JSON字符串文件解析成不同的JSON类并存放在相应的List文件中，并提供接口获取相应JSON类对应的值。通过本发明提供的方法能够实现对各式各样的带注释JSON文件进行方便、快速的解析。

Description

一种解析带注释JSON文件的方法、存储介质及装置

技术领域

本发明涉及JSON文件解析领域，尤其涉及一种解析带注释JSON文件的方法、存储介质及装置。

背景技术

JSON(JavaScript Object Notation， JS对象简谱)是一种轻量级的数据交换格式，其简洁和清晰的层次结构使得 JSON 成为理想的数据交换语言。易于人阅读和编写，同时也易于机器解析和生成，并有效地提升网络传输效率。

随着互联网技术的普及，轻量级的JSON格式越来越多的受到青睐。而对于JSON格式文件的快速解析，也在一定程度上影响了互联网响应速度和用户体验。但是目前的JSON解析方式都只能够解析标准无注释的JSON格式文件，对于带有注释的JSON格式文件都无法做到快速解析。

因此，现有技术还有待于改进和发展。

发明内容

鉴于上述现有技术的不足，本发明的目的在于提供一种解析带注释JSON文件的方法、存储介质及装置，旨在解决现有技术无法对带有注释的JSON文件进行快速解析的问题。

本发明的技术方案如下：

一种解析带注释JSON文件的方法，其中，包括步骤：

读取带注释JSON文件并将所述带注释JSON文件转换成带注释JSON字符串文件；

对所述带注释JSON字符串文件中的注释内容和非注释内容进行识别，并将识别的注释内容进行剔除，得到不带注释的JSON字符串文件；

将所述不带注释的JSON字符串文件解析成不同的JSON类并将解析到的JSON类存放在相应的List文件中。

所述解析带注释JSON文件的方法，其中，所述带注释JSON字符串文件中的注释内容前端设置有注释起始标识，注释内容末端设置有注释终止标识。

所述解析带注释JSON文件的方法，其中，所述对带注释JSON字符串文件中的注释内容和非注释内容进行识别，并将识别的注释内容进行剔除，得到不带注释的JSON字符串文件的步骤，具体包括：

读取所述带注释JSON字符串文件中的字符，当读取到注释起始标识时，则将所述注释起始标识后面的内容识别为注释内容，直至读取到所述注释终止标识则判定当前注释内容识别结束；

依次读取所述带注释JSON字符串文件中剩余的字符，直至带注释JSON字符串文件中的字符全部读取完毕；

将所述读取到的注释起始标识、注释内容以及注释终止标识剔除，将读取到的非注释内容依次保存到tmp文件中，即得到所述不带注释的JSON字符串文件。

所述解析带注释JSON文件的方法，其特征在于，所述注释起始标识包括多行注释起始标识和单行注释起始标识，所述注释终止标识包括多行注释终止标识和单行注释终止字符。

所述解析带注释JSON文件的方法，其中，所述多行注释起始标识为/*，所述多行注释终止标识为*/。

所述解析带注释JSON文件的方法，其中，所述单行注释起始标识为//，所述单行注释终止标识为跨行空格。

所述解析带注释JSON文件的方法，其中，所述将不带注释的JSON字符串文件解析成不同的JSON类并将解析到的JSON类存放在相应的List文件中的步骤，之后还包括：

提供相应接口获取存放在List文件中相应JSON类对应的值。

所述解析带注释JSON文件的方法，其中，所述将不带注释的JSON字符串文件解析成不同的JSON类并将解析到的JSON类存放在相应的List文件中，提供相应接口获取存放在List文件中相应JSON类对应的值的步骤，具体包括：

通过JSONTokener将所述不带注释的JSON字符串文件解析成JSONArray数组并存放在相应的List文件中，并提供相应接口获取所述JSONArray数组对应的值；

通过JSONTokener将所述不带注释的JSON字符串文件解析成JSONObject对象并存放在相应的List文件中，并提供相应接口获取所述JSONObject对象对应的值。

一种存储介质，其中，包括存储指令，所述存储指令适于由处理器加载并执行所述解析带注释JSON文件的方法步骤。

一种解析带注释JSON文件的装置，其中，包括处理器，适于实现各指令；以及存储设备，适于存储多条指令，所述指令适于由处理器加载并执行所述解析带注释JSON文件的方法步骤。

有益效果：本发明首先通过对所述带注释JSON字符串文件中的注释内容和非注释内容进行识别，并将识别的注释内容进行剔除，得到不带注释的JSON字符串文件；然后将所述不带注释的JSON字符串文件解析成不同的JSON类并将解析到的JSON类存放在相应的List文件中。通过本发明提供的方法能够实现对各式各样的带注释JSON文件进行方便、快速的解析，从而使得JSON文件不再局限于内容信息的传递，还可以提供注释，方便后续跟踪使用说明。

附图说明

图1为本发明一种解析带注释JSON文件的方法较佳实施例的流程图。

图2为本发明一种解析带注释JSON文件的装置较佳实施例的结构框图。

具体实施方式

本发明提供了一种解析带注释JSON文件的方法、存储介质及装置，为使本发明的目的、技术方案及效果更加清楚、明确，以下对本发明进一步详细说明。应当理解，此处所描述的具体实施例仅仅用以解释本发明，并不用于限定本发明。

请参阅图1，图1为本发明一种解析带注释JSON文件的方法较佳实施例的流程图，如图所示，其中，包括步骤：

S100、读取带注释JSON文件并将所述带注释JSON文件转换成带注释JSON字符串文件；

S200、对所述带注释JSON字符串文件中的注释内容和非注释内容进行识别，并将识别的注释内容进行剔除，得到不带注释的JSON字符串文件；

S300、将所述不带注释的JSON字符串文件解析成不同的JSON类并将解析到的JSON类存放在相应的List文件中。

具体来讲，JSON(JavaScript Object Notation， JS 对象简谱) 是一种轻量级的数据交换格式，它是基于ECMAScript (欧洲计算机协会制定的js规范)的一个子集，采用完全独立于编程语言的文本格式来存储和表示数据。其简洁和清晰的层次结构使得 JSON 成为理想的数据交换语言，既易于人阅读和编写，同时也易于机器解析和生成，并有效地提升网络传输效率。

现有的JSON解析方式通常只能够解析标准无注释的JSON格式文件，对于带有注释的JSON文件则无法做到快速解析，这极大地限制了JSON文件的应用范围，不便于用户使用。

基于此，本发明提供了一种解析带注释JSON文件的方法，通过预先将带注释JSON文件转换成带注释JSON字符串文件，然后对所述带注释JSON字符串文件中的注释内容和非注释内容进行识别，并剔除掉识别到的注释内容；最后将剩下的不带注释内容的JSON字符串文件解析成不同的JSON类并存放在相应的List文件中，并提供接口获取相应JSON类对应的值。显然，通过本发明能够实现对各式各样的带注释JSON文件进行方便、快速的解析，从而使得JSON文件不再局限于内容信息的传递，还可以提供注释，方便后续跟踪使用说明。

JSON 可以将 JavaScript 对象中表示的一组数据转换为字符串，然后就可以在网络或者程序之间轻松地传递这个字符串，并在需要的时候将它还原为各编程语言所支持的数据格式，例如在 PHP 中，可以将 JSON 还原为数组或者一个基本对象。在用到AJAX时，如果需要用到数组传值，这时就需要用JSON将数组转化为字符串。

作为其中一实施方式，在所述步骤S100中，为了便于后期对JSON文件中的注释内容以及非注释内容进行有效识别，本发明预先将读取的带注释JSON文件转换成带注释JSON字符串文件。

进一步地，对所述带注释JSON字符串文件中的注释内容和非注释内容进行识别，并将识别的注释内容进行剔除，得到不带注释的JSON字符串文件。

具体来讲，所述带注释JSON字符串文件中的注释内容前端设置有注释起始标识，注释内容末端设置有注释终止标识。通过依次读取所述带注释JSON字符串文件中的字符，当读取到注释起始标识时，则将所述注释起始标识后面的内容识别为注释内容，直至读取到所述注释终止标识则认定注释内容读取结束。

更具体地，在读取所述带注释JSON字符串文件过程中，每次读取的字符数量可根据实际需求进行设置。作为举例，假设所述注释起始标识的字符数量以及注释终止标识的字符数量均为2个字符时，此时可设定每次读取所述带注释JSON字符串文件中的1个字符。

将当前读取到的字符与前1个字符组合后，再将组合的字符与预设的注释起始标识进行比对，若一致，则判定当前读取的字符后面的内容均为注释内容；此时，继续读取所述带注释JSON字符串文件并将读取到的字符与前1个字符进行组合，再将组合后的字符与预设的注释终止标识进行比对，若一致，则判定该段注释内容读取结束；按照上述方法继续读取后面的带注释JSON字符串文件，直至所述带注释JSON字符串文件读取完毕。

优选地，在读取所述带注释JSON字符串文件过程中，每次读取的字符数量与注释起始标识数量以及注释终止标识数量相同。作为举例，假设所述注释起始标识的字符数量以及注释终止标识的字符数量均为2个字符时，可设定每次读取所述带注释JSON字符串文件中2个字符。

将当前读取到的每2个字符直接与预设的注释起始标识进行比对，若一致，则判定该字符后面的字符内容均为注释内容，继续读取所述带注释JSON字符串文件，此时则将读取到的每2个字符与预设的注释终止标识进行比对，若一致，则判定该段注释内容读取结束；按照上述方法继续读取后面的带注释JSON字符串文件，直至所述带注释JSON字符串文件读取完毕。

进一步地，完整读取所述带注释JSON字符串文件，将所述读取识别到的注释起始标识、注释内容以及注释终止标识剔除，将读取到的非注释内容依次保存到tmp文件中，即得到所述不带注释的JSON字符串文件。

作为其中一实施方式，所述带注释JSON字符串文件中的注释内容包括单行注释内容以及多行注释内容，所述多行注释内容前设置有多行注释起始标识，所述多行注释内容后设置有多行注释终止标识；所述单行注释内容前设置有单行注释起始标识，所述单行注释内容后设置有单行注释终止标识。

作为举例，所述多行注释起始标识为/*，所述多行注释终止标识为*/，但不限于此；所述单行注释起始标识为//，所述单行注释终止标识为跨行空格，但不限于此。

具体来讲，假设一带注释JSON字符串文件如下所示：

{

/*

*学生个人信息

*（多行注释）

*/

“id”：“20181007”，//学号（单行注释）

“subject”：“计算机科学与技术”，//主修专业信息（单行注释）

“address”：{//地址信息（单行注释）

“country”：“china”，

“province”：“Beijing”，

“detail”：“NAN Block 123 street 101”

}

“Language”：[“English”，“Chinese”]//熟悉语言（单行注释）

}

如上所示，所述带注释JSON字符串文件中既包括多行注释内容又包括单行注释内容，当采用本发明上述方法读取并剔除注释内容后，得到的不带注释的JSON字符串文件如下所示：

{

“id”：“20181007”，

“subject”：“计算机科学与技术”，

“address”：{

“country”：“china”，

“province”：“Beijing”，

“detail”：“NAN Block 123 street 101”

}

“Language”：[“English”，“Chinese”]

}

更进一步地，当得到所述不带注释的JSON字符串文件后，则通过JSONTokener将所述不带注释的JSON字符串文件解析成不同的JSON类并存放在相应的List文件中，并提供接口获取相应JSON类对应的值。

具体来讲，在JS 语言中，一切都是对象,因此，任何支持的类型都可以通过 JSON来表示，例如字符串、数字、对象、数组等。但是对象和数组是比较特殊且常用的两种类型。

所述对象在 JS 中是使用大括号{}包裹起来的内容，数据结构为 {key1：value1,key2：value2, ...} 的键值对结构。在面向对象的语言中，key 为对象的属性，value 为对应的值，键名可以使用整数和字符串来表示，值的类型可以是任意类型。如上所提供的带注释JSON字符串文件中，所述{

“country”：“china”，

“province”：“Beijing”，

“detail”：“NAN Block 123 street 101”

}

即为JSONObject对象。通过JSONTokener将所述不带注释的JSON字符串文件解析成JSONObject对象并存放在相应的List文件中，并对外提供get XX (key)相应接口获取所述JSONObject对象中key对应的值（Value），所述key对应的value可以是JSONArray数组、JSONObject对象或简单的String。

所述数组在 JS 中是方括号 [] 包裹起来的内容，数据结构为 ["java", "javascript", "vb", ...] 的索引结构。在 JS 中，数组是一种比较特殊的数据类型，它也可以像对象那样使用键值对，但还是索引使用得多。同样，值的类型可以是任意类型。如上所提供的带注释JSON字符串文件中，所述[“English”，“Chinese”]即为JSONArray数组。通过JSONTokener将所述不带注释的JSON字符串文件解析成JSONArray数组并存放在相应的List文件中，并对外提供get XX (index)相应接口获取所述JSONArray数组中第index对应的值(Value)。

基于上述方法，本发明还提供一种存储介质，其中，包括存储指令，所述存储指令适于由处理器加载并执行上述解析带注释JSON文件的方法步骤。

作为举例，所述存储介质包括的存储指令适于由处理器加载并具体执行：

将所述不带注释的JSON字符串文件解析成不同的JSON类并存放在相应的List文件中，并提供接口获取相应JSON类对应的值。

进一步地，本发明还提供一种解析带注释JSON文件的装置，其中，如图2所示，包括处理器10，适于实现各指令；以及存储设备20，适于存储多条指令，所述指令适于由处理器10加载并执行上述解析带注释JSON文件的方法步骤。

具体来说，所述处理器10在一些实施例中可以是一中央处理器，微处理器或其他数据处理芯片，用于运行所述存储设备20中存储的程序代码或处理数据。

所述存储设备20在一些实施例中可以是所述装置的内部存储单元，例如该装置的硬盘或内存。所述存储设备20在另一些实施例中也可以是所述装置的外部存储器，例如所述装置上配备的插接式硬盘，智能存储卡（Smart Media Card, SMC），安全数字（SecureDigital, SD）卡，闪存卡（Flash Card）等。

进一步地，所述存储设备20还可以既包括所述装置的内部存储单元也包括外部存储装置。所述存储设备20用于存储安装于所述装置的应用软件及各类数据。所述存储设备20还可以用于暂时地存储已经输出或者将要输出的数据。

综上所述，本发明首先通过对所述带注释JSON字符串文件中的注释内容和非注释内容进行识别，并将识别的注释内容进行剔除，得到不带注释的JSON字符串文件；然后将所述不带注释的JSON字符串文件解析成不同的JSON类并存放在相应的List文件中，并提供接口获取相应JSON类对应的值。通过本发明提供的方法能够实现对各式各样的带注释JSON文件进行方便、快速的解析，从而使得JSON文件不再局限于内容信息的传递，还可以提供注释，方便后续跟踪使用说明。

应当理解的是，本发明的应用不限于上述的举例，对本领域普通技术人员来说，可以根据上述说明加以改进或变换，所有这些改进和变换都应属于本发明所附权利要求的保护范围。

Claims

1.一种解析带注释JSON文件的方法，其特征在于，包括步骤：

2.根据权利要求1所述解析带注释JSON文件的方法，其特征在于，所述带注释JSON字符串文件中的注释内容前端设置有注释起始标识，注释内容末端设置有注释终止标识。

3.根据权利要求2所述解析带注释JSON文件的方法，其特征在于，所述对带注释JSON字符串文件中的注释内容和非注释内容进行识别，并将识别的注释内容进行剔除，得到不带注释的JSON字符串文件的步骤，具体包括：

4.根据权利要求3所述解析带注释JSON文件的方法，其特征在于，所述注释起始标识包括多行注释起始标识和单行注释起始标识，所述注释终止标识包括多行注释终止标识和单行注释终止字符。

5.根据权利要求4所述解析带注释JSON文件的方法，其特征在于，所述多行注释起始标识为/*，所述多行注释终止标识为*/。

6.根据权利要求4所述解析带注释JSON文件的方法，其特征在于，所述单行注释起始标识为//，所述单行注释终止标识为跨行空格。

7.根据权利要求1所述解析带注释JSON文件的方法，其特征在于，所述将不带注释的JSON字符串文件解析成不同的JSON类并将解析到的JSON类存放在相应的List文件中的步骤，之后还包括：

提供相应接口获取存放在List文件中相应JSON类对应的值。

8.根据权利要求7所述解析带注释JSON文件的方法，其特征在于，所述将不带注释的JSON字符串文件解析成不同的JSON类并将解析到的JSON类存放在相应的List文件中，提供相应接口获取存放在List文件中相应JSON类对应的值的步骤，具体包括：

9.一种存储介质，其特征在于，包括存储指令，所述存储指令适于由处理器加载并执行上述权利要求1-8任一所述解析带注释JSON文件的方法步骤。

10.一种解析带注释JSON文件的装置，其特征在于，包括处理器，适于实现各指令；以及存储设备，适于存储多条指令，所述指令适于由处理器加载并执行上述权利要求1-8任一所述解析带注释JSON文件的方法步骤。