CN109298861A - 一种根据接口文档自动生成文件的方法及装置 - Google Patents

Abstract

本申请提供了一种根据接口文档自动生成文件的方法，包括：根据接口文档数据，按照预设文档格式生成标准接口文档；对所述标准接口文档进行解析，生成目标文件的文件模板、配置文件和数据库脚本；依据所述目标文件的文件模板、配置文件和数据库脚本，生成所述目标文件。本发明通过读取标准格式的接口文档，自动生成所有代码，减少程序员开发的工作量和错误率。

Description

一种根据接口文档自动生成文件的方法及装置

技术领域

本发明涉及软件开发技术领域，更具体的，涉及一种根据接口文档自动生成文件的方法及装置。

背景技术

目前批量文本在各个系统间流转是根据接口文档生成文本，然后下发给各个系统。

为了实现根据接口文档生成文本这一业务流程，在开发过程中，由业务驱动，每新增一个业务接口，都需要开发人员手动编写相应的模板、配置文件、数据库脚本等多种代码。

但是，在实际开发过程中，接口字段可能多达上百个，可能出现数据类型、字段长度、取值范围等各不相同的情况。在这种情况下，手动编写代码容易出现字段缺少，字段和类型对应不上等情况，开发人员的工作量大且错误率高。

发明内容

有鉴于此，本发明公开了一种根据接口文档自动生成文件的方法及装置，通过读取标准格式的接口文档，自动生成所有代码，减少程序员开发的工作量和错误率。

为了实现上述发明目的，本发明提供的具体技术方案如下：

一种根据接口文档自动生成文件的方法，包括：

根据接口文档数据，按照预设文档格式生成标准接口文档；

对所述标准接口文档进行解析，生成目标文件的文件模板、配置文件和数据库脚本；

依据所述目标文件的文件模板、配置文件和数据库脚本，生成所述目标文件。

可选的，所述根据接口文档数据，按照预设文档格式生成标准接口文档，包括：

根据预设文档格式，确定标准接口文档所需的所有字段、以及每个字段的填写规则；

从接口文档数据中提取标准接口文档所需的所有字段和每个字段的数据；

按照每个字段的填写规则在标准接口文档中填写相应字段的数据，从而生成标准接口文档。

可选的，所述对所述标准接口文档进行解析，生成目标文件的文件模板、配置文件和数据库脚本，包括：

对所述标准接口文档进行解析，获取所述标准接口文档中的数据表、以及数据表中的每个数据项、每个数据项的属性；

根据所述标准接口文档中的每个数据项，生成目标文件的文件模板；

依据所述标准接口文档中的数据表，生成所述目标文件的配置文件；

基于所述标准接口文档中的数据表、以及数据表中的每个数据项，生成所述目标文件的数据库脚本，运行所述目标文件的数据库脚本用于读取所述目标文件的数据。

可选的，所述方法还包括：

在生成所述目标文件的过程中，利用读取线程读取数据，利用写入线程写入数据，并行执行读取线程和写入线程；

根据所述目标文件的交易量在读取数据时设置至少一个读取线程，并在写入数据时设置至少一个写入线程。

一种根据接口文档自动生成文件的装置，包括：

第一生成单元，用于根据接口文档数据，按照预设文档格式生成标准接口文档；

第二生成单元，用于对所述标准接口文档进行解析，生成目标文件的文件模板、配置文件和数据库脚本；

第三生成单元，用于依据所述目标文件的文件模板、配置文件和数据库脚本，生成所述目标文件。

可选的，所述第一生成单元，具体用于根据预设文档格式，确定标准接口文档所需的所有字段、以及每个字段的填写规则；从接口文档数据中提取标准接口文档所需的所有字段和每个字段的数据；按照每个字段的填写规则在标准接口文档中填写相应字段的数据，从而生成标准接口文档。

可选的，所述第二生成单元，具体用于对所述标准接口文档进行解析，获取所述标准接口文档中的数据表、以及数据表中的每个数据项、每个数据项的属性；根据所述标准接口文档中的每个数据项，生成目标文件的文件模板；依据所述标准接口文档中的数据表，生成所述目标文件的配置文件；基于所述标准接口文档中的数据表、以及数据表中的每个数据项，生成所述目标文件的数据库脚本，运行所述目标文件的数据库脚本用于读取所述目标文件的数据。

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

线程设置单元，用于在生成所述目标文件的过程中，利用读取线程读取数据，利用写入线程写入数据，并行执行读取线程和写入线程；根据所述目标文件的交易量在读取数据时设置至少一个读取线程，并在写入数据时设置至少一个写入线程。

相对于现有技术，本发明的有益效果如下：

本发明公开的一种根据接口文档自动生成文件的方法及装置，根据接口文档数据生成标准接口文档，通过读取标准接口文档自动生成目标文件的文件模板、配置文件和数据库脚本，以依据文件模板、配置文件和数据库脚本生成目标文件，解决了现有技术中程序员手动编写文件模板、配置文件和数据库脚本造成的开发工作量大和错误率高的问题，提高了开发效率。

附图说明

为了更清楚地说明本发明实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本发明的实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据提供的附图获得其他的附图。

图1为本发明实施例公开的一种根据接口文档自动生成文件的方法流程示意图；

图2为本发明实施例公开的一种标准接口文档的生成方法流程示意图；

图3为本发明实施例公开的一种生成目标文件的文件模板、配置文件和数据库脚本的方法流程示意图；

图4为本发明实施例公开的生产者消费者模式示意图；

图5为本发明实施例公开的一种根据接口文档自动生成文件的装置结构示意图。

具体实施方式

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

请参阅图1，本实施公开了一种根据接口文档自动生成文件的方法，具体包括以下步骤：

S101：根据接口文档数据，按照预设文档格式生成标准接口文档；

需要说明的是，所有的接口文档数据都需按照预设文档格式生成统一格式的标准接口文档。

标准接口文档对应唯一一个数据表，标准接口文档包括数据表名、数据表中的每个数据项信息。

具体的，请参阅表1，表1为一种可选的标准接口文档的文档格式。

表1 标准接口文档的文档格式

其中，数据项序号为数据项在标准接口文档中的唯一标识，数据类型为数据项数据的类型，数据长度释义表示数据项的字节数，数据最大长度为数据项数据的最大长度，若数据类型为数值型时还包括小数位长度，数据项的属性还包括：是否可以为空、是否为主键、字段含义和取值范围等。

具体的，请参阅图2，生成标准接口文档的方法具体包括以下步骤：

S201：根据预设文档格式，确定标准接口文档所需的所有字段、以及每个字段的填写规则；

以表1为例，标准接口文档所需的字段包括：数据表英文名、数据表中文名、数据项序号、数据项英文名、数据项中文名、数据类型、数据长度释义、数据最大长度、是否为空、是否主键、字段含义、取值范围。其中，预设文档格式还规定了每个字段的填写规则，如是否为空这一字段只能填是或否。

S202：从接口文档数据中提取标准接口文档所需的所有字段和每个字段的数据；

S203：按照每个字段的填写规则在标准接口文档中填写相应字段的数据，从而生成标准接口文档。

S102：对所述标准接口文档进行解析，生成目标文件的文件模板、配置文件和数据库脚本；

目标文件的文件模板规定了目标文件的格式；目标文件的配置文件包括目标文件的数据源服务器的IP地址、最大线程数、文件生成路径、文件名称、报文格式等信息；运行目标文件的数据库脚本用于读取目标文件的数据。

具体的，请参阅图3，生成目标文件的文件模板、配置文件和数据库脚本的方法具体包括以下步骤：

S301：对所述标准接口文档进行解析，获取所述标准接口文档中的数据表、以及数据表中的每个数据项、每个数据项的属性；

标准接口文档中包括唯一一个数据表，数据表中包括多个数据项，以上述表1为例，数据项的属性包括：数据项英文名、数据项中文名、数据类型、数据长度释义、数据最大长度、是否为空、是否主键、字段含义、取值范围。

S302：根据所述标准接口文档中的每个数据项，生成目标文件的文件模板；

目标文件以文件模板为模板生成，文件模板中包括数据表中的每个数据项。

S303：依据所述标准接口文档中的数据表，生成所述目标文件的配置文件；

数据表与配置文件之间存在对应关系，根据标准接口文档中的数据表、以及数据表与配置文件之间的对应关系，得到目标文件的配置文件。

S304：基于所述标准接口文档中的数据表、以及数据表中的每个数据项，生成所述目标文件的数据库脚本，运行所述目标文件的数据库脚本用于读取所述目标文件的数据。

S103：依据所述目标文件的文件模板、配置文件和数据库脚本，生成所述目标文件。

具体的，依据目标文件的配置文件中的配置信息，运行目标文件的数据库脚本，读取目标文件的数据，生成以目标文件的文件模板为模板的目标文件。

本实施例公开的一种根据接口文档自动生成文件的方法，根据接口文档数据生成标准接口文档，通过读取标准接口文档自动生成目标文件的文件模板、配置文件和数据库脚本，以依据文件模板、配置文件和数据库脚本生成目标文件，解决了现有技术中程序员手动编写文件模板、配置文件和数据库脚本造成的开发工作量大和错误率高的问题，提高了开发效率。

现有技术中，生成文件采用单线程模式，一次性将所有数据写入文件，效率低下。为了解决这一技术问题，本实施例公开的根据接口文档自动生成文件的方法引入多线程机制，根据目标文件的数据量设置适当的线程数，具体的该方法包括：

在生成所述目标文件的过程中，利用读取线程读取数据，利用写入线程写入数据，并行执行读取线程和写入线程；

根据所述目标文件的交易量在读取数据时设置至少一个读取线程，并在写入数据时设置至少一个写入线程。

可选的，请参阅图4，创建读取线程和写入线程，并生成文件的模式可以采用生产者消费者模式。

读取线程为生产者消费者模式中的生产者，读取线程从数据库中获取符合条件的记录，以任务的形式放入传输队列中，写入线程为生产者消费者模式中的消费者，写入线程从传输队列中获取任务，将相应的数据写入目标文件。

本实施公开的根据接口文档自动生成文件的方法，优化了文件生成机制，多线程并发执行，通过目标文件的交易量在读取数据时设置适当的读取线程，并在写入数据时设置适当的写入线程，提高文件的生成速度。

基于上述实施例公开的一种根据接口文档自动生成文件的方法，请参阅图5，本实施例对应公开了一种根据接口文档自动生成文件的装置，包括：

第一生成单元501，用于根据接口文档数据，按照预设文档格式生成标准接口文档；

第二生成单元502，用于对所述标准接口文档进行解析，生成目标文件的文件模板、配置文件和数据库脚本；

第三生成单元503，用于依据所述目标文件的文件模板、配置文件和数据库脚本，生成所述目标文件。

可选的，所述第一生成单元501，具体用于根据预设文档格式，确定标准接口文档所需的所有字段、以及每个字段的填写规则；从接口文档数据中提取标准接口文档所需的所有字段和每个字段的数据；按照每个字段的填写规则在标准接口文档中填写相应字段的数据，从而生成标准接口文档。

可选的，所述第二生成单元502，具体用于对所述标准接口文档进行解析，获取所述标准接口文档中的数据表、以及数据表中的每个数据项、每个数据项的属性；根据所述标准接口文档中的每个数据项，生成目标文件的文件模板；依据所述标准接口文档中的数据表，生成所述目标文件的配置文件；基于所述标准接口文档中的数据表、以及数据表中的每个数据项，生成所述目标文件的数据库脚本，运行所述目标文件的数据库脚本用于读取所述目标文件的数据。

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

线程设置单元，用于在生成所述目标文件的过程中，利用读取线程读取数据，利用写入线程写入数据，并行执行读取线程和写入线程；根据所述目标文件的交易量在读取数据时设置至少一个读取线程，并在写入数据时设置至少一个写入线程。

本实施例公开的一种根据接口文档自动生成文件的装置，根据接口文档数据生成标准接口文档，通过读取标准接口文档自动生成目标文件的文件模板、配置文件和数据库脚本，以依据文件模板、配置文件和数据库脚本生成目标文件，解决了现有技术中程序员手动编写文件模板、配置文件和数据库脚本造成的开发工作量大和错误率高的问题，提高了开发效率。

对所公开的实施例的上述说明，使本领域专业技术人员能够实现或使用本发明。对这些实施例的多种修改对本领域的专业技术人员来说将是显而易见的，本文中所定义的一般原理可以在不脱离本发明的精神或范围的情况下，在其它实施例中实现。因此，本发明将不会被限制于本文所示的这些实施例，而是要符合与本文所公开的原理和新颖特点相一致的最宽的范围。

Claims (8)

1.一种根据接口文档自动生成文件的方法，其特征在于，包括：

根据接口文档数据，按照预设文档格式生成标准接口文档；

对所述标准接口文档进行解析，生成目标文件的文件模板、配置文件和数据库脚本；

依据所述目标文件的文件模板、配置文件和数据库脚本，生成所述目标文件。

2.根据权利要求1所述的方法，其特征在于，所述根据接口文档数据，按照预设文档格式生成标准接口文档，包括：

根据预设文档格式，确定标准接口文档所需的所有字段、以及每个字段的填写规则；

从接口文档数据中提取标准接口文档所需的所有字段和每个字段的数据；

按照每个字段的填写规则在标准接口文档中填写相应字段的数据，从而生成标准接口文档。

3.根据权利要求1所述的方法，其特征在于，所述对所述标准接口文档进行解析，生成目标文件的文件模板、配置文件和数据库脚本，包括：

对所述标准接口文档进行解析，获取所述标准接口文档中的数据表、以及数据表中的每个数据项、每个数据项的属性；

根据所述标准接口文档中的每个数据项，生成目标文件的文件模板；

依据所述标准接口文档中的数据表，生成所述目标文件的配置文件；

基于所述标准接口文档中的数据表、以及数据表中的每个数据项，生成所述目标文件的数据库脚本，运行所述目标文件的数据库脚本用于读取所述目标文件的数据。

4.根据权利要求1所述的方法，其特征在于，所述方法还包括：

在生成所述目标文件的过程中，利用读取线程读取数据，利用写入线程写入数据，并行执行读取线程和写入线程；

根据所述目标文件的交易量在读取数据时设置至少一个读取线程，并在写入数据时设置至少一个写入线程。

5.一种根据接口文档自动生成文件的装置，其特征在于，包括：

第一生成单元，用于根据接口文档数据，按照预设文档格式生成标准接口文档；

第二生成单元，用于对所述标准接口文档进行解析，生成目标文件的文件模板、配置文件和数据库脚本；

第三生成单元，用于依据所述目标文件的文件模板、配置文件和数据库脚本，生成所述目标文件。

6.根据权利要求5所述的装置，其特征在于，所述第一生成单元，具体用于根据预设文档格式，确定标准接口文档所需的所有字段、以及每个字段的填写规则；从接口文档数据中提取标准接口文档所需的所有字段和每个字段的数据；按照每个字段的填写规则在标准接口文档中填写相应字段的数据，从而生成标准接口文档。

7.根据权利要求5所述的装置，其特征在于，所述第二生成单元，具体用于对所述标准接口文档进行解析，获取所述标准接口文档中的数据表、以及数据表中的每个数据项、每个数据项的属性；根据所述标准接口文档中的每个数据项，生成目标文件的文件模板；依据所述标准接口文档中的数据表，生成所述目标文件的配置文件；基于所述标准接口文档中的数据表、以及数据表中的每个数据项，生成所述目标文件的数据库脚本，运行所述目标文件的数据库脚本用于读取所述目标文件的数据。

8.根据权利要求5所述的装置，其特征在于，所述装置还包括：

线程设置单元，用于在生成所述目标文件的过程中，利用读取线程读取数据，利用写入线程写入数据，并行执行读取线程和写入线程；根据所述目标文件的交易量在读取数据时设置至少一个读取线程，并在写入数据时设置至少一个写入线程。