接口组件化开发方法及装置、介质、设备与流程

1.本发明涉及接口开发技术领域，尤其是涉及一种接口组件化开发方法及装置、介质、设备。


背景技术：

2.随着社会进步和信息化的不断发展，人们对于信息化带来的便捷要求越来越高，需求也越来越多，企业信息化建设的内容越来越精细，对各行各业的软件需求越来越多，产生了大量不同系统，系统与系统之间存在越来越多的信息孤岛，与日俱增的信息化数据量给用户带来便利的同时也存在更高的信息交互需求，需要更多的接口来提升信息带来的更高价值。
3.虽然接口的交互具有很大的功能，但是每个接口都完整的开发会带来大量的代码冗余和更长的项目开发周期，将人力浪费在很多不必要的工作中。


技术实现要素：

4.针对以上至少一个技术问题，本发明实施例提供一种接口组件化开发方法及装置、介质、设备。
5.根据第一方面，本发明实施例提供的接口组件化开发方法，包括：
6.对业务系统的待开发接口的接口信息进行配置，并根据配置的所述接口信息生成接口配置文件；
7.配置所述待开发接口的接口代码对应的包文件的指定存储路径；
8.配置所述待开发接口的数据库连接信息和所述数据库连接信息所指向的目标数据库中需要生成的实体类的表名称；
9.根据所述接口配置文件、所述数据库连接信息和所述表名称，生成所述待开发接口的接口代码，将所述接口代码打包为包文件，并将所述包文件存储于所述指定存储路径下。
10.根据第二方面，本发明实施例提供的接口组件化开发装置，包括：
11.第一配置模块，用于对业务系统的待开发接口的接口信息进行配置，并根据配置的所述接口信息生成接口配置文件；
12.第二配置模块，用于配置所述待开发接口的接口代码对应的包文件的指定存储路径；
13.第三配置模块，用于配置所述待开发接口的数据库连接信息和所述数据库连接信息所指向的目标数据库中需要生成的实体类的表名称；
14.代码生成模块，用于根据所述接口配置文件、所述数据库连接信息和所述表名称，生成所述待开发接口的接口代码，将所述接口代码打包为包文件，并将所述包文件存储于所述指定存储路径下。
15.根据第三方面，本发明实施例提供计算机可读存储介质，其上存储有计算机程序，
当所述计算机程序在计算机中执行时，令计算机执行实现第一方面提供的方法。
16.根据第四方面，本发明实施例提供的计算设备，包括存储器和处理器，所述存储器中存储有可执行代码，所述处理器执行所述可执行代码时，实现第一方面提供的方法。
17.本发明实施例提供的接口组件化开发方法及装置、介质、设备，首先对业务系统的待开发接口的接口信息进行配置，并根据配置的所述接口信息生成接口配置文件，然后配置指定存储路径、数据库连接信息和所述数据库连接信息所指向的目标数据库中需要生成的实体类的表名称，最后根据所述接口配置文件、所述数据库连接信息和所述表名称，生成所述待开发接口的接口代码，将所述接口代码打包为包文件，并将所述包文件存储于所述指定存储路径下。该方法可以可以缩短项目开发周期，将人力从很多不必要的工作中解放出来完成专业的业务任务；采用统一生成的方式可以降本增效，加速项目开发进程，使项目获得更短的交付周期。而且，可以降低代码的耦合度，使代码编更为简洁，使程序的运行更加稳定，更好的执行代码编写规范，统一生成的代码风格更易于后期的维护和更新。可见，本发明实施例提供的方法是一种实用性强、加速开发进程、降低人员要求、降低耦合的快速开发方法。
附图说明
18.图1为本发明一实施例中接口组件化开发方法的流程示意图。
具体实施方式
19.第一方面，本发明实施例提供一种接口组件化开发方法。
20.参见图1，该方法包括如下步骤s110～s140：
21.s110、对业务系统的待开发接口的接口信息进行配置，并根据配置的所述接口信息生成接口配置文件；
22.可理解的是，不同的业务系统具有不同的特点，因此可以根据每一个业务系统的特点，对该业务系统的待开发接口的接口信息进行配置。
23.其中，所述接口信息中可以包括接口名称、接口方法的名称、接口参数和包名称，所述包名称为所述包文件的名称。
24.其中，包名称是指将待开发接口的接口代码打包后得到的包文件的名称。
25.其中，所述包文件的名称可以为所述包文件的相对路径。
26.在一个实施例中，所述根据配置的所述接口信息生成接口配置文件，具体可以包括：根据所述接口信息中的接口名称和接口参数，生成接口类的属性和方法，所述接口类的属性和方法形成所述接口配置文件。
27.也就是说，根据配置的接口名称和接口参数，生成接口类的属性和方法，该方法是指接口方法，接口方法即函数，且该接口方法以所述接口信息中的接口方法的名称进行命名。
28.可见，所述接口配置文件中包括接口类的属性和方法。
29.s120、配置所述待开发接口的接口代码对应的包文件的指定存储路径；
30.其中，指定存储路径也可以称为文件生成路径。
31.在一个实施例中，所述配置所述待开发接口的接口代码对应的包文件的指定存储
路径，具体可以包括：
32.建立第一配置文件；
33.在所述第一配置文件中配置所述指定存储路径；其中，所述指定存储路径为绝对路径；
34.检查所述指定存储路径下是否存在文件夹；
35.若不存在，则在所述指定存储路径下创建文件夹；其中，所述文件夹用来存储所述待开发接口的接口代码对应的包文件。
36.其中，第一配置文件可以称为生成目录配置文件，是一种yaml文件，在该文件中配置指定存储路径。
37.其中，所述指定存储路径是绝对路径。
38.其中，在配置好指定存储路径后，可以从第一配置文件中读取出指定存储路径，进而检查在该指定存储路径下是否存在文件夹。如果不存在文件夹，说明待开发接口之前没有创建过，因此在所述指定存储路径下创建文件夹，创建好的文件夹用于在开发完成后存储待开发接口的接口代码的包文件。如果存在文件夹，说明待开发接口之前创建过，本次创建是为了对之前的接口代码的包文件进行更新，因此在待开发接口的接口代码的包文件得到之后，将该包文件替代指定存储路径下的文件夹中的同名称的原包文件。
39.s130、配置所述待开发接口的数据库连接信息和所述数据库连接信息所指向的目标数据库中需要生成的实体类的表名称；
40.其中，数据库连接信息中包括目标数据库的ip地址、用户信息等。
41.其中，在目标数据库中存在多个数据库表，并不是所有的数据库表都需要生成实体类，这里定义了需要生成实体类的数据库表的名称。
42.在一个实施例中，所述配置所述待开发接口的数据库连接信息和所述数据库连接信息所指向的目标数据库中需要生成的实体类的表名称，可以包括：
43.建立第二配置文件；
44.将所述数据库连接信息和所述数据库连接信息所指向的目标数据库中需要生成的实体类的表名称配置在所述第二配置文件中。
45.其中，第二配置文件是一种yaml文件。
46.其中，在s140中，可以从第二配置文件中读取到数据库连接信息和表名称，从而基于读取到的信息动态生成实体类。
47.s140、根据所述接口配置文件、所述数据库连接信息和所述表名称，生成所述待开发接口的接口代码，将所述接口代码打包为包文件，并将所述包文件存储于所述指定存储路径下。
48.也就是说，先生成接口代码，然后将接口代码打包为包文件，对包文件命名为上述包名称，进而将包文件存储在指定存储路径下。
49.在一个实施例中，所述根据所述接口配置文件、所述数据库连接信息和所述表名称，生成所述待开发接口的接口代码，具体包括：根据所述第二配置文件中配置的所述数据库连接信息和所述表名称，生成实体类；根据所述接口配置文件和所述实体类，生成接口代码。
50.例如，数据层获取到接口配置文件、第二配置文件；应用层根据获取到的第二配置
文件中的数据库连接信息和所述表名称，动态生成实体类；然后根据实体类、接口配置文件中的接口类的属性和方法，使用接口动态生成方法，生成接口代码，得到设定的通用接口，最后将接口代码打包，得到包文件。
51.可理解的是，本发明实施例提供了一种基于igix平台架构下与其他三方接口的组件化快速开发方法，该方法可以将层与层之间的参数传递时采用统一的映射图进行，返回结果采用统一的对象进行存储，让开发者不用去关注参数与返回值，并且常规方法统一省略不写，以实现自关注特殊业务的编写的原则，从而实现快速开发。而且，该方法使得某些业务模块可以重复利用，同时也提供了对模块化的开发设计与支持，被复用性比较高的，支持打包成jar文件，其他的项目依赖即可热插进去。还有，可以集成安全框架提供校验框架，作为登录支持；还可以支撑使用模板工具统一生成，减少大量重复代码的编写，减轻项目开发难度，协作开发效率高，可以给企业降低开发费用和维护难度，具有很高的推广和经济价值。
52.综上，本发明实施例提供的方法可以在igix平台下实现接口代码的自动生成，可以缩短项目开发周期，将人力从很多不必要的工作中解放出来完成专业的业务任务；采用统一生成的方式可以降本增效，加速项目开发进程，使项目获得更短的交付周期。可以降低代码的耦合度，使代码编更为简洁，使程序的运行更加稳定，更好的执行代码编写规范，统一生成的代码风格更易于后期的维护和更新。可见，本发明实施例提供的方法是一种实用性强、加速开发进程、降低人员要求、降低耦合的快速开发方法。
53.第二方面，本发明实施例提供一种接口组件化开发装置，包括：
54.第一配置模块，用于对业务系统的待开发接口的接口信息进行配置，并根据配置的所述接口信息生成接口配置文件；
55.第二配置模块，用于配置所述待开发接口的接口代码对应的包文件的指定存储路径；
56.第三配置模块，用于配置所述待开发接口的数据库连接信息和所述数据库连接信息所指向的目标数据库中需要生成的实体类的表名称；
57.代码生成模块，用于根据所述接口配置文件、所述数据库连接信息和所述表名称，生成所述待开发接口的接口代码，将所述接口代码打包为包文件，并将所述包文件存储于所述指定存储路径下。
58.在一个实施例中，所述接口信息中包括接口名称、接口方法的名称、接口参数和包名称，所述包名称为所述包文件的名称。
59.在一个实施例中，所述包文件的名称为所述包文件的相对路径。
60.在一个实施例中，第一配置模块具体用于：根据所述接口信息中的接口名称和接口参数，生成接口类的属性和方法，所述接口类的属性和方法形成所述接口配置文件。
61.在一个实施例中，第二配置模块具体用于：建立第一配置文件；在所述第一配置文件中配置所述指定存储路径；其中，所述指定存储路径为绝对路径；检查所述指定存储路径下是否存在文件夹；若不存在，则在所述指定存储路径下创建文件夹；其中，所述文件夹用来存储所述待开发接口的接口代码对应的包文件。
62.在一个实施例中，第三配置模块具体用于：建立第二配置文件；将所述数据库连接信息和所述数据库连接信息所指向的目标数据库中需要生成的实体类的表名称配置在所
述第二配置文件中。
63.在一个实施例中，代码生成模块具体用于：根据所述第二配置文件中配置的所述数据库连接信息和所述表名称，生成实体类；根据所述接口配置文件和所述实体类，生成接口代码。
64.可理解的是，本发明实施例提供的装置中有关内容的解释、具体实施方式、有益效果、举例等内容可以参见第一方面提供的方法中的相应部分，此处不再赘述。
65.第三方面，本发明实施例提供一种计算机可读介质，所述计算机可读介质上存储有计算机指令，所述计算机指令在被处理器执行时，使所述处理器执行第一方面提供的方法。
66.具体地，可以提供配有存储介质的系统或者装置，在该存储介质上存储着实现上述实施例中任一实施例的功能的软件程序代码，且使该系统或者装置的计算机(或cpu或mpu)读出并执行存储在存储介质中的程序代码。
67.在这种情况下，从存储介质读取的程序代码本身可实现上述实施例中任何一项实施例的功能，因此程序代码和存储程序代码的存储介质构成了本发明的一部分。
68.用于提供程序代码的存储介质实施例包括软盘、硬盘、磁光盘、光盘(如cd-rom、cd-r、cd-rw、dvd-rom、dvd-ram、dvd-rw、dvd+rw)、磁带、非易失性存储卡和rom。可选择地，可以由通信网络从服务器计算机上下载程序代码。
69.此外，应该清楚的是，不仅可以通过执行计算机所读出的程序代码，而且可以通过基于程序代码的指令使计算机上操作的操作系统等来完成部分或者全部的实际操作，从而实现上述实施例中任意一项实施例的功能。
70.此外，可以理解的是，将由存储介质读出的程序代码写到插入计算机内的扩展板中所设置的存储器中或者写到与计算机相连接的扩展模块中设置的存储器中，随后基于程序代码的指令使安装在扩展板或者扩展模块上的cpu等来执行部分和全部实际操作，从而实现上述实施例中任一实施例的功能。
71.可理解的是，本发明实施例提供的计算机可读介质中有关内容的解释、具体实施方式、有益效果、举例等内容可以参见第一方面提供的方法中的相应部分，此处不再赘述。
72.第四方面，本说明书一个实施例提供了一种计算设备，包括存储器和处理器，所述存储器中存储有可执行代码，所述处理器执行所述可执行代码时，实现执行说明书中任一个实施例中的方法。
73.可理解的是，本发明实施例提供的计算设备中有关内容的解释、具体实施方式、有益效果、举例等内容可以参见第一方面提供的方法中的相应部分，此处不再赘述。
74.本说明书中的各个实施例均采用递进的方式描述，各个实施例之间相同相似的部分互相参见即可，每个实施例重点说明的都是与其他实施例的不同之处。尤其，对于装置实施例而言，由于其基本相似于方法实施例，所以描述的比较简单，相关之处参见方法实施例的部分说明即可。
75.本领域技术人员应该可以意识到，在上述一个或多个示例中，本发明所描述的功能可以用硬件、软件、挂件或它们的任意组合来实现。当使用软件实现时，可以将这些功能存储在计算机可读介质中或者作为计算机可读介质上的一个或多个指令或代码进行传输。
76.以上所述的具体实施方式，对本发明的目的、技术方案和有益效果进行了进一步
详细说明，所应理解的是，以上所述仅为本发明的具体实施方式而已，并不用于限定本发明的保护范围，凡在本发明的技术方案的基础之上，所做的任何修改、等同替换、改进等，均应包括在本发明的保护范围之内。

技术特征：
1.一种接口组件化开发方法，其特征在于，包括：对业务系统的待开发接口的接口信息进行配置，并根据配置的所述接口信息生成接口配置文件；配置所述待开发接口的接口代码对应的包文件的指定存储路径；配置所述待开发接口的数据库连接信息和所述数据库连接信息所指向的目标数据库中需要生成的实体类的表名称；根据所述接口配置文件、所述数据库连接信息和所述表名称，生成所述待开发接口的接口代码，将所述接口代码打包为包文件，并将所述包文件存储于所述指定存储路径下。2.根据权利要求1所述的方法，其特征在于，所述接口信息中包括接口名称、接口方法的名称、接口参数和包名称，所述包名称为所述包文件的名称。3.根据权利要求2所述的方法，其特征在于，所述包文件的名称为所述包文件的相对路径。4.根据权利要求2所述的方法，其特征在于，所述根据配置的所述接口信息生成接口配置文件，包括：根据所述接口信息中的接口名称和接口参数，生成接口类的属性和方法，所述接口类的属性和方法形成所述接口配置文件。5.根据权利要求1所述的方法，其特征在于，所述配置所述待开发接口的接口代码对应的包文件的指定存储路径，包括：建立第一配置文件；在所述第一配置文件中配置所述指定存储路径；其中，所述指定存储路径为绝对路径；检查所述指定存储路径下是否存在文件夹；若不存在，则在所述指定存储路径下创建文件夹；其中，所述文件夹用来存储所述待开发接口的接口代码对应的包文件。6.根据权利要求2所述的方法，其特征在于，所述配置所述待开发接口的数据库连接信息和所述数据库连接信息所指向的目标数据库中需要生成的实体类的表名称，包括：建立第二配置文件；将所述数据库连接信息和所述数据库连接信息所指向的目标数据库中需要生成的实体类的表名称配置在所述第二配置文件中。7.根据权利要求6所述的方法，其特征在于，所述根据所述接口配置文件、所述数据库连接信息和所述表名称，生成所述待开发接口的接口代码，包括：根据所述第二配置文件中配置的所述数据库连接信息和所述表名称，生成实体类；根据所述接口配置文件和所述实体类，生成接口代码。8.一种接口组件化开发装置，其特征在于，包括：第一配置模块，用于对业务系统的待开发接口的接口信息进行配置，并根据配置的所述接口信息生成接口配置文件；第二配置模块，用于配置所述待开发接口的接口代码对应的包文件的指定存储路径；第三配置模块，用于配置所述待开发接口的数据库连接信息和所述数据库连接信息所指向的目标数据库中需要生成的实体类的表名称；代码生成模块，用于根据所述接口配置文件、所述数据库连接信息和所述表名称，生成
所述待开发接口的接口代码，将所述接口代码打包为包文件，并将所述包文件存储于所述指定存储路径下。9.一种计算机可读存储介质，其特征在于，其上存储有计算机程序，当所述计算机程序在计算机中执行时，令计算机执行实现实现权利要求1～7中的任一项所述的方法。10.一种计算设备，其特征在于，包括存储器和处理器，所述存储器中存储有可执行代码，所述处理器执行所述可执行代码时，实现权利要求1～7中的任一项所述的方法。

技术总结
本发明提供一种接口组件化开发方法及装置、介质、设备，该方法包括：对业务系统的待开发接口的接口信息进行配置，并根据配置的所述接口信息生成接口配置文件；配置所述待开发接口的接口代码对应的包文件的指定存储路径；配置所述待开发接口的数据库连接信息和所述数据库连接信息所指向的目标数据库中需要生成的实体类的表名称；根据所述接口配置文件、所述数据库连接信息和所述表名称，生成所述待开发接口的接口代码，将所述接口代码打包为包文件，并将所述包文件存储于所述指定存储路径下。本发明实施例提供的方法是一种实用性强、加速开发进程、降低人员要求、降低耦合的快速开发方法。开发方法。开发方法。


技术研发人员：曲鹏 何兴川 赵月
受保护的技术使用者：浪潮通用软件有限公司
技术研发日：2023.07.11
技术公布日：2023/10/15