CN115391289A

CN115391289A - 一种包含文件信息的目录结构生成方法及装置

Info

Publication number: CN115391289A
Application number: CN202210973214.1A
Authority: CN
Inventors: 郑桂; 赖彦彰; 卢超
Original assignee: Guangzhou Xuanwu Wireless Technology Co Ltd
Current assignee: Guangzhou Xuanwu Wireless Technology Co Ltd
Priority date: 2022-08-15
Filing date: 2022-08-15
Publication date: 2022-11-25
Anticipated expiration: 2042-08-15
Also published as: CN115391289B

Abstract

本发明公开了一种包含文件信息的目录结构生成方法及装置，所述方法包括：获取文件列表数据，所述文件列表数据包括若干个文件夹，每个文件夹包含若干个文件；从所述文件列表数据分别提取关于文件夹和对应文件的路径关系的文件目录结构，以及关于每个文件描述内容的信息，得到多个描述信息，每个描述信息对应一个文件；将所述多个描述信息分别添加至所述文件目录结构中，得到目录树结构。本发明可以在抽取各个文件的层级结构时，读取文件夹内每个文件的描述信息，将各个描述信息添加至层级结构中生成文件的目录树结构，不但可以通过层级结构了解各个文件之间的层级关系，也可以通过各个文件的描述信息流量文件内容，以简化查询流程，提高查询效率。

Description

一种包含文件信息的目录结构生成方法及装置

技术领域

本发明涉及文件夹目录处理的技术领域，尤其涉及一种包含文件信息的目录结构生成方法及装置。

背景技术

在软件的开发和应用过程中，为了能适配不同用户的应用需求，会不断增加软件的应用功能。随着软件的应用功能逐渐增加，软件项目所涉及的数据量也逐渐增加。为了能让参与项目的技术人员了解项目的内容，会将项目涉及的所有文件及其所在文件夹制作成文件夹目录结构，供技术人员通过文件夹目录结构查看项目的文件信息以了解项目进展。

目前常用的文件夹目录结构的构建方法是：先确定各个文件夹以及其包含的各个文件之间的父子关系或层级结构，利用文件夹与文件之间的父子关系或层级结构来构建生成整个项目的树形目录结构。

但目前常用的方法有如下技术问题：随着项目的拓展，项目所涉及的文件夹数量以及文件数量也随之增加，构建的树形目录结构，也更加复杂。当技术人员需要了解或核实结构内的某一个文件夹以及某一文件的内容时，则要从树形目录结构顶部开始，按照结构的层级关系逐一翻查，直到查找到相应的文件夹或文件并再打开查看，整个操作过程繁琐，耗时长，效率低。

发明内容

本发明提出一种包含文件信息的目录结构生成方法及装置，所述方法可以在抽取各个文件的层级结构时，读取文件夹内每个文件的信息，利用信息与层级结构生成对应的文件夹目录结构，用户不但可以浏览各个文件间的层级关系，也可以快速浏览目录内每个文件的内容，以简化查询流程，提高查询效率。

本发明实施例的第一方面提供了一种包含文件信息的目录结构生成方法，所述方法包括：

获取文件列表数据，所述文件列表数据包括若干个文件夹，每个文件夹包含若干个文件；

从所述文件列表数据分别提取关于文件夹和对应文件的路径关系的文件目录结构，以及关于每个文件描述内容的信息，得到多个描述信息，每个描述信息对应一个文件；

将所述多个描述信息分别添加至所述文件目录结构中，得到目录树结构。

在第一方面的一种可能的实现方式中，所述从所述文件列表数据分别提取关于文件夹和对应文件的路径关系的文件目录结构，以及关于每个文件描述内容的信息，得到多个描述信息，包括：

遍历所述文件列表数据的每个文件夹和每个文件的路径，得到文件目录结构；

读取所述文件列表数据内每个文件所包含的描述内容，得到多个描述信息。

在第一方面的一种可能的实现方式中，所述遍历所述文件列表数据的每个文件夹和每个文件的路径，得到文件目录结构，包括：

基于fn方法，遍历所述文件列表数据的每个数据节点，每个数据节点对应一个文件夹或文件；

当所述数据节点为文件，则清除所述数据节点对应路径的文件后缀名，得到文件路径；

当所述数据节点为文件夹，则确定文件夹是否包含index文件；

若文件夹包含index文件，则将index文件移出文件夹，并确定文件夹的路径，得到文件夹路径；

若文件夹不包含index文件，则清空文件夹的路径，得到文件夹路径；

利用tree方法，对所述文件夹路径和所述文件路径进行递归，生成文件目录结构。

在第一方面的一种可能的实现方式中，所述读取所述文件列表数据内每个文件所包含的描述内容，得到多个描述信息，包括：

遍历每个文件所包含的文件字段，得到多个文件字段；

并按照预设的字段符号，从每个所述文件字段提取对应的字段值，得到描述信息。

在第一方面的一种可能的实现方式中，在所述读取所述文件列表数据内每个文件的文件信息得到多个文件信息的步骤后，所述方法还包括：

读取所述文件列表数据内的异步数据，得到异步补充信息，所述异步数据为关于所述文件列表数据内未读取的文件的异步代码；

将所述异步补充信息添加至所述多个描述信息中。

在第一方面的一种可能的实现方式中，所述获取文件列表数据，包括：

获取文件夹的路径信息，对所述路径信息进行解析得到绝对路径信息；

采用readdirSync方法，查找在所述绝对路径信息所包含的若干个文件夹名称以及每个所述文件夹名称对应的多个文件名称；

采用所述若干个文件夹名称和所述多个文件名称拼接成文件列表数据。

在第一方面的一种可能的实现方式中，所述将所述多个描述信息分别添加至所述文件目录结构中，得到目录树结构，包括：

查找所述文件目录结构中所包含的文件路径，每个文件路径对应的一个描述信息；

按照所述文件路径，将每个所述描述信息分别添加至所述文件目录结构中，得到目录树结构。

本发明实施例的第二方面提供了一种包含文件信息的目录结构生成装置，所述装置包括：

获取模块，用于获取文件列表数据，所述文件列表数据包括若干个文件夹，每个文件夹包含若干个文件；

提取模块，用于从所述文件列表数据分别提取关于文件夹和对应文件的路径关系的文件目录结构，以及关于每个文件描述内容的信息，得到多个描述信息，每个描述信息对应一个文件；

生成模块，用于将所述多个描述信息分别添加至所述文件目录结构中，得到目录树结构。

相比于现有技术，本发明实施例提供的一种包含文件信息的目录结构生成方法及装置，其有益效果在于：本发明可以在抽取各个文件的层级结构时，读取文件夹内每个文件的描述信息，将各个文件的描述信息添加至文件的层级结构中生成文件的目录树结构，当用户查看时，不但可以通过层级结构了解各个文件之间的层级关系，也可以通过各个文件的描述信息流量文件内容，以简化查询流程，提高查询效率。

附图说明

图1是本发明一实施例提供的一种包含文件信息的目录结构生成方法的流程示意图；

图2是本发明一实施例提供的文件夹处理的操作流程图；

图3是本发明一实施例提供的文件信息提取的操作流程图；

图4是本发明一实施例提供的一种包含文件信息的目录结构生成装置的结构示意图。

具体实施方式

下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有作出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

为了解决上述问题，下面将通过以下具体的实施例对本申请实施例提供的一种包含文件信息的目录结构生成方法进行详细介绍和说明。

在一实施例中，所述方法可以是用于智能终端，由终端进行数据处理以生成文件目录。

参照图1，示出了本发明一实施例提供的一种包含文件信息的目录结构生成方法的流程示意图。

其中，作为示例的，所述包含文件信息的目录结构生成方法，可以包括：

S11、获取文件列表数据，所述文件列表数据包括若干个文件夹，每个文件夹包含若干个文件。

在一实施例中，所述文件列表数据可以包括若干个文件夹的相关数据，每个文件夹可以包括至少一个文件。

其中，作为示例的，步骤S11可以包括以下子步骤：

S111、获取文件夹的路径信息，对所述路径信息进行解析得到绝对路径信息。

在一实施例中，用户可以将待整理的文件夹的相关数据输入至智能终端中，其中，路径信息可以是文件夹在智能终端或数据库的存储路径。

绝对路径信息是对路径信息进行解析得到的路径内容。

在具体实现中，可以使用node.js提供的path模块的resolve方法对路径信息中的序列进行解析，是路径信息解析为绝对路径，得到绝对路径信息。

S112、采用readdirSync方法，查找在所述绝对路径信息所包含的若干个文件夹名称以及每个所述文件夹名称对应的多个文件名称。

S113、采用所述若干个文件夹名称和所述多个文件名称拼接成文件列表数据。

在一实施例中，可以利用fs模块提供的readdirSync方法，找到当前绝对路径下的所有文件以及所在文件夹对应的名称，将各个名称组成临时文件列表数组，得到文件列表数据。

在一实施例中，可以创建list为文件列表数据，中文：临时文件列表数组，再创建两个新的数组：folders(中文：文件夹数组)、files(中文：文件数组)，用于后续存放文件列表数据的对象信息。其中，对象信息中包含title(中文：文件名称)、path(中文：文件路径)和children(中文：子级目录结构)。

在一实施例中，可以通过两个数组分别存储文件夹和文件，采用此方式在存放子文件时，文件夹能排到首位，文件排到文件夹后面，符合平时编辑器打开时文件夹在文件前面的操作习惯。

而文件列表数据与文件夹数组和文件数组的关系是包含关系与被包含关系，因为文件夹数组和文件数组的推入(push)过程都是在为临时文件列表数组中进行的。

S12、从所述文件列表数据分别提取关于文件夹和对应文件的路径关系的文件目录结构，以及关于每个文件描述内容的信息，得到多个描述信息，每个描述信息对应一个文件。

在获取文件列表数据后，可以对文件类别数据进行遍历和读取，从而能从文件列表数据中分别提取得到文件目录结构和描述信息，其中，文件目录结构是关于文件夹和文件层级关系的树形结构。描述信息是关于文件存储内容的信息。

通过提取文件中所存储内容，可以将其内容添加至文件结构中，供用户查看。

在一可选的实施例中，步骤S12可以包括以下子步骤：

S121、遍历所述文件列表数据的每个文件夹和每个文件的路径，得到文件目录结构。

在一实施例中，可以获取每个文件夹的路径以及每个文件的路劲，通过各个路径之间的关系，构建得到文件目录结构，该文件目录结构可以是树形的目标结构。

在一实施例中，步骤S121可以包括以下子步骤：

S1211、基于fn方法，遍历所述文件列表数据的每个数据节点，每个数据节点对应一个文件夹或文件。

S1212、当所述数据节点为文件，则清除所述数据节点对应路径的文件后缀名，得到文件路径。

S1213、当所述数据节点为文件夹，则确定文件夹是否包含index文件。

S1214、若文件夹包含index文件，则将index文件移出文件夹，并确定文件夹的路径，得到文件夹路径。

S1215、若文件夹不包含index文件，则清空文件夹的路径，得到文件夹路径。

S1216、利用tree方法，对所述文件夹路径和所述文件路径进行递归，生成文件目录结构。

参照图2，示出了本发明一实施例提供的文件夹处理的操作流程图。

在一可选的操作方式中，可以先通过fn方法(具体可以是tree方法)，遍历文件列表数据中的每个数据节点，其中，数据节点可以对应一个文件夹或一个文件。确定当前的数据节点是文件夹还是文件，若当前的数据节点为文件，则清除该数据节点对应路径的文件后缀名，得到文件路径。若数据节点为文件夹，则判断文件夹所包含的子文件中是否包含index文件。当文件夹包含index文件，则将index文件移出文件夹，在确定文件夹的路径，得到文件夹路径；若文件夹不包含index文件，则直接清空文件夹的路径，得到文件夹路径。最后利用tree方法，对文件夹路径和文件路径进行递归，生成文件目录结构。

S122、读取所述文件列表数据内每个文件所包含的描述内容，得到多个描述信息。

在一实施例中，在构建目录结构时，可以读取每个文件的内容，再从读取的文件内容中该文件的相关描述内容，进而得到每个文件的描述信息。通过这些描述信息可以确定该文件的主要内容，以方便用户后续的查看使用。

在一实施例中，步骤S122可以包括以下子步骤：

S1221、遍历每个文件所包含的文件字段，得到多个文件字段。

S1222、并按照预设的字段符号，从每个所述文件字段提取对应的字段值，得到描述信息。

具体地，在确定数据节点是文件后，可以新建一个promise(代码)，读取这个文件的内容，如果内容中读取到/*@@*/字符的内容，则将/*@@*/中间的内容提取出来作为文件的描述信息，一并写入文件信息，将obj推入到files数组中，从而可以将描述信息(临时对象存放的信息也一并写入文件信息中)写入sidebars(文件目录结构树)中。

需要说明的是，obj是在判定数据节点是文件或文件夹后创建的一个临时对象，用于存放文件列表数据所需的信息(title、path、children)。

在具体实现中，可以通过stat提供的isDirectory方法(如果<fs.Stats>对象描述文件系统目录，也就是文件夹，则返回true，详情参考http://nodejs.cn/api/fs/stats_isdirectory.html)可以判断出数据节点stat是文件还是文件夹，此处判断的是stat，临时文件对象不参与判断。(，如果是文件则将文件信息(临时对象存放的信息也一并写入文件信息中)写入sidebars中，新建一个promise，读取这个文件的内容，如果内容中读取到/*@@*/则将中间的内容提取出来作为文件的描述信息，一并写入文件信息，将obj推入到files数组中。如果是文件夹则不仅要写入文件信息(临时对象存放的信息也一并写入文件信息中),还要继续调用tree方法进行递归，传入路径改为现在这个文件夹的路径，将obj推入到folders数组中。

在使用tree方法完成递归后，sidebar数组形成树形结构的文件目录结构也已经构建完成，但是执行tree方法期间也有一部分异步代码(promise)，也就是读取文件内容的操作是尚未完成的。为了读取所有文件的内容，其中，作为示例的，在步骤S12后，所述方法还可以包括：

S21、读取所述文件列表数据内的异步数据，得到异步补充信息，所述异步数据为关于所述文件列表数据内未读取的文件的异步代码。

S22、将所述异步补充信息添加至所述多个描述信息中。

在一实施例中，可以将每个文件对应的异步补充信息添加至其对应的描述信息中，从而能在后续将描述信息添加至目录结构中。

具体地，可以执行promise.all来确保所有的文件都已经读取完毕再往下执行代码。由于在文件目录结构的构建过程中，文件目录结构已经存在，但是数据不完整，只有对文件的所有内容读取完毕后，并将补充的信息添加至描述信息中，再将文件信息对文件目录结构进行补充，才算是完整的目录树结构，从而能避免信息遗漏的情况。

参照图3，示出了本发明一实施例提供的文件信息提取的操作流程图。

在一实际操作的方式中，提取路径和读取信息的操作步骤如下：

第一，先执行generateDirectoryList方法，构建xt_directoryList的树结构，该树结构用于在生成xt_directoryList.md文件(markdown类型文件)，以缩进的风格直观的看出文件与文件夹的关系。

分别进行以下定义：

①定义indent，用于保存当前树节点缩进的空格数量。

②定义space，通过padStart方法创建出同等长度的空字符串，用于占位。

③将space(空格占位字符串)，当前树节点的名称(title)，当前节点的描述(desc)和换行符\n形成一个字符串，加入到markdownText中。

第二，以markdownText为文件内容，输出树结构(生成xt_directoryList.md文件)。

第三，调用generateSidebarJson方法，生成sidebar的json文件。

第四，定义tempSidebar变量，深克隆sidebar，深克隆是为了断掉与sidebars的引用关系，避免因为tempSidebar的改变而影响到sidebars里面的内容。

第五，定义一个fn方法，用于递归遍历sidebar数组，此次sidebar是文件列表数组。

第六，执行fn方法，如果当前节点是文件夹，则先对文件夹的children进行查找，检测里面是否有index文件，如果有，则把该文件移出文件夹。如果没有则清空当前文件夹的path。执行完判断是否有index文件后，对文件夹的children进行forEach遍历，执行fn方法，实现递归。如果当前节点是文件，则把当前节点的path的文件后缀名去掉。到此整个fn方法执行完毕，这里执行fn方法的意义在于vuepress对sidebar的处理机制，对于有path路径的，只要当前路径下存在index.md或者README.md都会默认选中该文件，如果sidebar中不去掉index文件的话，会导致该文件夹路径下的内容都显示不出来。

S13、将所述多个描述信息分别添加至所述文件目录结构中，得到目录树结构。

在分别获取目录结构和文件的描述信息后，可以将描述信息添加至目录结构中，使得目录结构包含文字的描述内容。待用户查看时，既可以看到项目中所包含各个文件、文件间的关系，也可以查看每个文件的内容，方便用户使用。

在其中一种的实施例中，步骤S13可以包括以下子步骤：

S131、查找所述文件目录结构中所包含的文件路径，每个文件路径对应的一个描述信息。

S132、按照所述文件路径，将每个所述描述信息分别添加至所述文件目录结构中，得到目录树结构。

具体地，等待forEach遍历结束后，通过当前tree方法传进来的文件路径(对象的key)找到存放的描述信息(parent)，parent的children里面存放解构出来的folders和files的数组，再按照每个文件路径，将对应的每个描述信息分别添加至文件目录结构(具体可以添加至文件目录结构的文件的开头处)，生成目录树结构。

在本实施例中，本发明实施例提供了一种包含文件信息的目录结构生成方法，其有益效果在于：本发明可以在抽取各个文件的层级结构时，读取文件夹内每个文件的描述信息，将各个文件的描述信息添加至文件的层级结构中生成文件的目录树结构，当用户查看时，不但可以通过层级结构了解各个文件之间的层级关系，也可以通过各个文件的描述信息流量文件内容，以简化查询流程，提高查询效率。

本发明实施例还提供了一种包含文件信息的目录结构生成装置，参见图4，示出了本发明一实施例提供的一种包含文件信息的目录结构生成装置的结构示意图。

其中，作为示例的，所述包含文件信息的目录结构生成装置可以包括：

获取模块401，用于获取文件列表数据，所述文件列表数据包括若干个文件夹，每个文件夹包含若干个文件；

提取模块402，用于从所述文件列表数据分别提取关于文件夹和对应文件的路径关系的文件目录结构，以及关于每个文件描述内容的信息，得到多个描述信息，每个描述信息对应一个文件；

生成模块403，用于将所述多个描述信息分别添加至所述文件目录结构中，得到目录树结构。

可选地，所述提取模块，还用于：

遍历每个文件所包含的文件字段，得到多个文件字段；

可选地，所述装置还包括：

读取异步数据模块，用于读取所述文件列表数据内的异步数据，得到异步补充信息，所述异步数据为关于所述文件列表数据内未读取的文件的异步代码；

异步信息添加模块，用于将所述异步补充信息添加至所述多个描述信息中。

可选地，所述获取模块，还用于：

可选地，所述生成模块还用于：

所属技术领域的技术人员可以清楚地了解到，为方便的描述和简洁，上述描述的装置的具体工作过程，可以参考前述方法实施例中的对应过程，在此不再赘述。

进一步的，本申请实施例还提供了一种电子设备，包括：存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，所述处理器执行所述程序时实现如上述实施例所述的包含文件信息的目录结构生成方法。

进一步的，本申请实施例还提供了一种计算机可读存储介质，所述计算机可读存储介质存储有计算机可执行程序，所述计算机可执行程序用于使计算机执行如上述实施例所述的包含文件信息的目录结构生成方法。

以上所述是本发明的优选实施方式，应当指出，对于本技术领域的普通技术人员来说，在不脱离本发明原理的前提下，还可以做出若干改进和润饰，这些改进和润饰也视为本发明的保护范围。

Claims

1.一种包含文件信息的目录结构生成方法，其特征在于，所述方法包括：

2.根据权利要求1所述的包含文件信息的目录结构生成方法，其特征在于，所述从所述文件列表数据分别提取关于文件夹和对应文件的路径关系的文件目录结构，以及关于每个文件描述内容的信息，得到多个描述信息，包括：

3.根据权利要求2所述的包含文件信息的目录结构生成方法，其特征在于，所述遍历所述文件列表数据的每个文件夹和每个文件的路径，得到文件目录结构，包括：

4.根据权利要求2所述的包含文件信息的目录结构生成方法，其特征在于，所述读取所述文件列表数据内每个文件所包含的描述内容，得到多个描述信息，包括：

遍历每个文件所包含的文件字段，得到多个文件字段；

5.根据权利要求1所述的包含文件信息的目录结构生成方法，其特征在于，在所述读取所述文件列表数据内每个文件的文件信息得到多个文件信息的步骤后，所述方法还包括：

将所述异步补充信息添加至所述多个描述信息中。

6.根据权利要求1所述的包含文件信息的目录结构生成方法，其特征在于，所述获取文件列表数据，包括：

7.根据权利要求1所述的包含文件信息的目录结构生成方法，其特征在于，所述将所述多个描述信息分别添加至所述文件目录结构中，得到目录树结构，包括：

8.一种包含文件信息的目录结构生成装置，其特征在于，所述装置包括：

9.一种电子设备，包括：存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，其特征在于，所述处理器执行所述程序时实现如权利要求1-7任意一项所述的包含文件信息的目录结构生成方法。

10.一种计算机可读存储介质，其特征在于，所述计算机可读存储介质存储有计算机可执行程序，所述计算机可执行程序用于使计算机执行如权利要求1-7任意一项所述的包含文件信息的目录结构生成方法。