CN114489603A - 代码生成方法、装置、电子设备、介质和产品 - Google Patents

Abstract

本申请公开了代码生成方法、装置、电子设备、介质和产品，可应用于金融领域或其他领域。无需开发人员人为编写接口代码，而是预先构建接口代码模板，从得到的接口信息中查找接口代码模板包含的字段的字段值，并填入接口代码模板，从而得到接口对应的目标接口代码，在这过程中，需要用户选择接口对应的接口代码模板，后续接口代码自动生成，无需开发人员需要针对每一接口编写接口代码，所以占用开发人员的时间大大减少，且提高了接口代码的生成效率。

Description

代码生成方法、装置、电子设备、介质和产品

技术领域

本申请涉及软件技术领域，更具体的说，是涉及代码生成方法、装置、电子设备、介质和产品。

背景技术

前端客户端与后台服务器需要通过接口进行数据交互，即开发人员需要编写接口对应的接口代码，前端客户端通过调用接口代码以实现通过接口与后台服务器进行交互的目的。由于前端客户端的种类繁多，所以需要开发人员一一针对不同的接口编写相应的接口代码，操作繁琐。

发明内容

有鉴于此，本申请提供了一种代码生成方法、装置、电子设备、介质和产品。

为实现上述目的，本申请提供如下技术方案：

根据本公开实施例的第一方面，提供一种代码生成方法，包括：

获取接口对应的接口信息，所述接口信息包括多个字段以及多个字段分别对应的字段值，所述多个字段包括：后台服务器的通讯地址、向所述后台服务器发送的报文携带的参数名称、所述报文的结构以及所述报文的请求方式；

控制显示用户界面，所述用户界面用于指示用户选择接口代码模板，所述接口代码模板包括待填写字段值的多个字段；

获取通过所述用户界面确定的所述接口对应的接口代码模板；

从所述接口信息中查找所述接口代码模板包含的字段的字段值，并填入所述接口代码模板，以生成所述接口对应的目标接口代码。

在第一方面的第一种可能实现方式中，还包括：

基于预先设置的接口代码与文件位置的对应关系中，查找所述目标接口代码对应的目标文件位置；

将所述目标接口代码***预构建的前端客户端的代码文件的所述目标文件位置。

在第一方面的第二种可能实现方式中，所述获取接口对应的接口信息包括：

获取所述接口对应的接口文档；

解析所述接口文档，以获得所述接口信息。

在第一方面的第三种可能实现方式中，所述获取接口对应的接口信息包括：

建立与在线接口管理工具的通信连接，所述在线接口管理工具包含所述接口对应的接口信息；

通过所述在线接口管理工具获得所述接口对应的接口信息。

根据本公开实施例的第二方面，提供一种代码生成装置，包括：

第一获取模块，用于获取接口对应的接口信息，所述接口信息包括多个字段以及多个字段分别对应的字段值，所述多个字段包括：后台服务器的通讯地址、向所述后台服务器发送的报文携带的参数名称、所述报文的结构以及所述报文的请求方式；

控制模块，用于控制显示用户界面，所述用户界面用于指示用户选择接口代码模板，所述接口代码模板包括待填写字段值的多个字段；

第二获取模块，用于获取通过所述用户界面确定的所述接口对应的接口代码模板；

生成模块，用于从所述接口信息中查找所述接口代码模板包含的字段的字段值，并填入所述接口代码模板，以生成所述接口对应的目标接口代码。

在第二方面的第一种可能实现方式中，还包括：

查找模块，用于基于预先设置的接口代码与文件位置的对应关系中，查找所述目标接口代码对应的目标文件位置；

***模块，用于将所述目标接口代码***预构建的前端客户端的代码文件的所述目标文件位置。

在第二方面的第二种可能实现方式中，所述第一获取模块包括：

第一获取单元，用于获取所述接口对应的接口文档；

解析单元，用于解析所述接口文档，以获得所述接口信息。

在第二方面的第三种可能实现方式中，所述第一获取模块包括：

建立连接单元，用于建立与在线接口管理工具的通信连接，所述在线接口管理工具包含所述接口对应的接口信息；

第二获取单元，用于通过所述在线接口管理工具获得所述接口对应的接口信息。

根据本公开实施例的第三方面，提供一种电子设备包括：

处理器；

用于存储所述处理器可执行指令的存储器；

其中，所述处理器被配置为执行所述指令，以实现如第一方面所述的代码生成方法。

根据本公开实施例的第四方面，提供一种计算机可读存储介质，当所述存储介质中的指令由电子设备的处理器执行时，使得所述电子设备能够执行如第一方面所述的代码生成方法。

根据本公开实施例的第五方面，提供一种计算机程序产品，可直接加载到计算机的内部存储器，所述存储器为第三方面所示的所述电子设备包含的存储器中，并含有软件代码，所述计算机程序经由计算机载入并执行后能够实现如第一方面所述的代码生成方法。

经由上述的技术方案可知，本申请提供的代码生成方法中，无需开发人员人为编写接口代码，而是预先构建接口代码模板，从得到的接口信息中查找接口代码模板包含的字段的字段值，并填入接口代码模板，从而得到接口对应的目标接口代码，在这过程中，需要用户选择接口对应的接口代码模板，后续接口代码自动生成，无需开发人员针对每一接口编写接口代码，所以占用开发人员的时间大大减少，且提高了接口代码的生成效率。

附图说明

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

图1为本申请实施例提供的代码生成方法的流程图；

图2为本申请实施例提供的代码生成装置的结构图；

图3是根据一示例性实施例示出的一种用于电子设备的装置的框图。

具体实施方式

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

本申请实施例提供了一种代码生成方法、装置、电子设备、介质及产品，在介绍本申请提供的技术方案之前，先对本申请涉及的硬件架构进行说明。

本申请实施例涉及的硬件架构包括：电子设备。

示例性的，电子设备可以是任何一种可与用户通过键盘、触摸板、触摸屏、遥控器、语音交互或手写设备等一种或多种方式进行人机交互的电子产品，例如，手机、笔记本电脑、平板电脑、掌上电脑、个人计算机、可穿戴设备、智能电视、PAD等。

电子设备中可以运行有前端客户端，前端客户端可以为应用程序客户端或网页版客户端或小程序。

前端客户端与各服务器进行交互的接口对应的接口代码都可以通过本申请提供的代码生成方法生成，从而无需开发人员一一编写各接口的接口代码，操作简便，且提高了效率。

可以理解的是，在生成各接口对应的接口代码后，将接口代码***前端客户端的代码文件的相应位置，从而开发完毕前端客户端，前端客户端即可投入使用。

本领域技术人员应能理解上述电子设备仅为举例，其他现有的或今后可能出现的电子设备如可适用于本公开，也应包含在本公开保护范围以内，并在此以引用方式包含于此。

下面结合上述硬件架构对本申请实施例提供的代码生成方法进行说明。

如图1所示，为本申请实施例提供的代码生成方法的流程图，该方法包括以下步骤S11至步骤S14。

步骤S11：获取接口对应的接口信息，所述接口信息包括多个字段以及多个字段分别对应的字段值，所述多个字段包括：后台服务器的通讯地址、向所述后台服务器发送的报文携带的参数名称、所述报文的结构以及所述报文的请求方式。

可以理解的是，在前端客户端开发过程中，开发人员会根据前端客户端的业务拆解各个功能，然后针对每一功能，确定若实现该功能，前端客户端需要进行交互的后台服务器，从而确定该功能对应的接口。所以接口与前端客户端的功能相关。

接口信息是生成接口代码的基础，下面说明为何接口信息需要包括上述多个字段。

可以理解的是，前端客户端在与后台服务器进行交互的过程中，是通过Http(HyperText Transfer Protocol，超文本传输协议)协议通信的。前端客户端可以向后台服务器发送报文，例如，Http报文，报文包含报文头和报文体。

报文中携带有接口相关的参数名称和参数名称对应的字段值。后台服务器在接收到报文后，会核实报文中携带的参数名称是否与该接口的功能相符，若相符则会向前端客户端反馈响应报文。

下面以前端客户端包含的功能为登录功能为例进行说明。前端客户端可以接收用户输入的用户名和密码(报文中携带的参数名称包括用户名和密码)，前端客户端通过登录接口向后台服务器发送登录请求报文，后台服务器接收到登录请求报文后，会核实该请求报文是否携带用户名和密码，若携带，则进行验证用户名和密码的字段值是否满足要求，并返回验证是否通过的响应报文。

报文中携带后台服务器的通讯地址，示例性的，通讯地址可以为IP地址(InternetProtocol Address,又译为网际协议地址)和端口号。报文中携带的目的地址即为后台服务器的通讯地址。

报文的请求方式包括但不限于：GET请求方式、POST请求方式、PUT请求方式、Delete请求方式。请求方式表征了前端客户端与后台服务器的交互方式。

在前端客户端与后台服务器进行交互的过程中，需要知道对方的报文的结构，否则无法从报文中解析出字段和字段值。所以需要报文的结构这一参数。

步骤S12：控制显示用户界面，所述用户界面用于指示用户选择接口代码模板，所述接口代码模板包括待填写字段值的多个字段。

接口代码模板是预先构建的，不同类型的接口对应的接口代码模板不同。每一接口对应的接口代码模板中只包含该接口所需要的各字段，各字段对应的字段值未填写，示例性的，字段对应的字段值可以用占位符表示。

示例性的，接口代码模板至少包括以下字段：请求方式、参数名称、后台服务器的通讯地址。

步骤S13：获取通过所述用户界面确定的所述接口对应的接口代码模板。

示例性的，每个接口代码模板对应一个模板名称，用户可以通过模板名称确定接口对应的接口代码模板，所以用户可以不是开发人员。

示例性的，用户界面可以显示接口代码模板包含的字段，用户可以通过接口代码模板显示的字段，从中选择与接口的功能相对应的接口代码模板。

步骤S14：从所述接口信息中查找所述接口代码模板包含的字段的字段值，并填入所述接口代码模板，以生成所述接口对应的目标接口代码。

示例性的，若接口代码模板中包含的字段的字段值均被填充，就得到了目标接口代码。

示例性的，若接口代码模板中一个或多个字段的字段值未从接口信息中查找到，则可以控制显示提示框，以提示用户人为写入。

本申请实施例提供的代码生成方法中，无需开发人员人为编写接口代码，而是预先构建接口代码模板，从得到的接口信息中查找接口代码模板包含的字段的字段值，并填入接口代码模板，从而得到接口对应的目标接口代码，在这过程中，需要用户选择接口对应的接口代码模板，后续接口代码自动生成，无需开发人员针对每一接口编写接口代码，所以占用开发人员的时间大大减少，且提高了接口代码的效生成率。

可以理解的是，接口代码需要***前端客户端对应的代码文件的相应位置，在运行前端客户端对应的代码文件的过程中，http请求库会自动调用代码文件中相应位置的接口代码。在一可选实现方式中，上述方法还包括以下步骤A1至步骤A2。

步骤A1：基于预先设置的接口代码与文件位置的对应关系中，查找所述目标接口代码对应的目标文件位置。

示例性的，可以变更接口代码与文件位置的对应关系。

步骤A2：将所述目标接口代码***预构建的前端客户端的代码文件的所述目标文件位置。

本申请中通过接口代码模板的方式生成接口代码，并***至代码文件的目标文件位置，所以本申请是将接口代码作为模块的方式使用，避免了代码文件过于臃肿，在后续开发人员阅读代码文件时思路也比较清晰。

在一可选实现方式中，步骤S11的实现方式有多种，本申请实施例提供但不限于以下三种。

第一种步骤S11的实现方式包括以下步骤B1至步骤B2。

步骤B1：获取所述接口对应的接口文档。

示例性的，接口文档是由开发人员编写并上传至电子设备中的。

接口文档包括前端客户端的开发人员和后台服务器的开发人员共同定义的接口信息。前端客户端的开发人员和后台服务器的开发人员在开发前端客户端和后台服务器的过程中是基于接口文档进行开发的。

步骤B2：解析所述接口文档，以获得所述接口信息。

接口文档包括多个字段以及多个字段分别对应的字段值。接口文档的结构是固定的，所以可以基于接口文档的结构定义解析接口文档的方式。

第二种步骤S11的实现方式包括以下步骤C1至步骤C2。

步骤C1：建立与在线接口管理工具的通信连接，所述在线接口管理工具包含所述接口对应的接口信息。

示例性的，在线接口管理工具可以为：Swagger、RAP、APIDOC、Spring REST Docs。

开发人员可以在在线接口管理工具中设置一个或多个接口分别对应的接口信息。

示例性的，在线接口管理工具可以位于其他电子设备中，运行有前端客户端的电子设备可以与其他电子设备建立远程连接。

步骤C2：通过所述在线接口管理工具获得所述接口对应的接口信息。

第三种步骤S11的实现方式包括：解析工程源代码，以得到接口信息。

在一可选实现方式中，本申请实施例提供的代码生成方法支持常用的插件，例如，IDE插件。可以通过IDE插件调用本申请提供的代码生成方法，以实现接口代码的更新。

上述本申请公开的实施例中详细描述了方法，对于本申请的方法可采用多种形式的装置实现，因此本申请还公开了一种装置，下面给出具体的实施例进行详细说明。

如图2所示，为本申请实施例提供的代码生成装置的结构图，该装置包括：第一获取模块21、控制模块22、第二获取模块23以及生成模块24，其中：

第一获取模块21，用于获取接口对应的接口信息，所述接口信息包括多个字段以及多个字段分别对应的字段值，所述多个字段包括：后台服务器的通讯地址、向所述后台服务器发送的报文携带的参数名称、所述报文的结构以及所述报文的请求方式；

控制模块22，用于控制显示用户界面，所述用户界面用于指示用户选择接口代码模板，所述接口代码模板包括待填写字段值的多个字段；

第二获取模块23，用于获取通过所述用户界面确定的所述接口对应的接口代码模板；

生成模块24，用于从所述接口信息中查找所述接口代码模板包含的字段的字段值，并填入所述接口代码模板，以生成所述接口对应的目标接口代码。

在一可选实现方式中，还包括：

查找模块，用于基于预先设置的接口代码与文件位置的对应关系中，查找所述目标接口代码对应的目标文件位置；

***模块，用于将所述目标接口代码***预构建的前端客户端的代码文件的所述目标文件位置。

在一可选实现方式中，所述第一获取模块包括：

第一获取单元，用于获取所述接口对应的接口文档；

解析单元，用于解析所述接口文档，以获得所述接口信息。

在一可选实现方式中，所述第一获取模块包括：

建立连接单元，用于建立与在线接口管理工具的通信连接，所述在线接口管理工具包含所述接口对应的接口信息；

第二获取单元，用于通过所述在线接口管理工具获得所述接口对应的接口信息。

关于上述实施例中的装置，其中各个模块执行操作的具体方式已经在有关该方法的实施例中进行了详细描述，此处将不做详细阐述说明。

图3是根据一示例性实施例示出的一种用于电子设备的装置的框图。

电子设备包括但不限于：处理器31、存储器32、网络接口33、I/O控制器34以及通信总线35。

需要说明的是，本领域技术人员可以理解，图3中示出的电子设备的结构并不构成对电子设备的限定，电子设备可以包括比图3所示更多或更少的部件，或者组合某些部件，或者不同的部件布置。

下面结合图3对电子设备的各个构成部件进行具体的介绍：

处理器31是电子设备的控制中心，利用各种接口和线路连接整个电子设备的各个部分，通过运行或执行存储在存储器32内的软件程序和/或模块，以及调用存储在存储器32内的数据，执行电子设备的各种功能和处理数据，从而对电子设备进行整体监控。处理器31可包括一个或多个处理单元；示例性的，处理器31可集成应用处理器和调制解调处理器，其中，应用处理器主要处理操作***、用户界面和应用程序等，调制解调处理器主要处理无线通信。可以理解的是，上述调制解调处理器也可以不集成到处理器31中。

处理器31可能是一个中央处理器(Central Processing Unit，CPU)，或者是特定集成电路ASIC(Application Specific Integrated Circuit)，或者是被配置成实施本发明实施例的一个或多个集成电路等；

存储器32可能包含内存，例如高速随机存取存储器(Random-Access Memory，RAM)321和只读存储器(Read-Only Memory，ROM)322，也可能还包括大容量存储设备323，例如至少1个磁盘存储器等。当然，该电子设备还可能包括其他业务所需要的硬件。

其中，上述的存储器32，用于存储上述处理器31可执行指令。上述处理器31具有以下功能：获取接口对应的接口信息，所述接口信息包括多个字段以及多个字段分别对应的字段值，所述多个字段包括：后台服务器的通讯地址、向所述后台服务器发送的报文携带的参数名称、所述报文的结构以及所述报文的请求方式；

控制显示用户界面，所述用户界面用于指示用户选择接口代码模板，所述接口代码模板包括待填写字段值的多个字段；

获取通过所述用户界面确定的所述接口对应的接口代码模板；

从所述接口信息中查找所述接口代码模板包含的字段的字段值，并填入所述接口代码模板，以生成所述接口对应的目标接口代码。

一个有线或无线网络接口33被配置为将电子设备连接到网络。

处理器31、存储器32、网络接口33和I/O控制器34可以通过通信总线35相互连接，该通信总线可以是ISA(Industry Standard Architecture，工业标准体系结构)总线、PCI(Peripheral Component Interconnect，外设部件互连标准)总线或EISA(ExtendedIndustry Standard Architecture，扩展工业标准结构)总线等。所述总线可以分为地址总线、数据总线、控制总线等。

在示例性实施例中，电子设备可以被一个或多个应用专用集成电路(ASIC)、数字信号处理器(DSP)、数字信号处理设备(DSPD)、可编程逻辑器件(PLD)、现场可编程门阵列(FPGA)、控制器、微控制器、微处理器或其他电子元件实现，用于执行上述代码生成方法。

在示例性实施例中，本公开实施例提供了一种包括指令的存储介质，例如包括指令的存储器32，上述指令可由电子设备的处理器31执行以完成上述方法。可选地，存储介质可以是非临时性计算机可读存储介质，例如，所述非临时性计算机可读存储介质可以是ROM、随机存取存储器(RAM)、CD-ROM、磁带、软盘和光数据存储设备等。

在示例性实施例中，还提供了一种计算机可读存储介质，可直接加载到计算机的内部存储器，例如上述存储器32中，并含有软件代码，该计算机程序经由计算机载入并执行后能够实现上述代码生成方法任一实施例所示步骤。

在示例性实施例中，还提供一种计算机程序产品，可直接加载到计算机的内部存储器，例如所述电子设备包含的存储器中，并含有软件代码，该计算机程序经由计算机载入并执行后能够实现上述所述代码生成方法任一实施例所示步骤。

需要说明的是，本发明提供的代码生成方法、装置、电子设备、介质及产品可用于金融领域或其他领域，例如，可用于金融领域中的代码生成应用场景。其他领域为除金融领域之外的任意领域，例如，电力领域。上述仅为示例，并不对本发明提供的代码生成方法、装置、电子设备、介质及产品的应用领域进行限定。

需要说明的是，本说明书中的各个实施例中记载的特征可以相互替换或者组合。对于装置或***类实施例而言，由于其与方法实施例基本相似，所以描述的比较简单，相关之处参见方法实施例的部分说明即可。

还需要说明的是，在本文中，诸如第一和第二等之类的关系术语仅仅用来将一个实体或者操作与另一个实体或操作区分开来，而不一定要求或者暗示这些实体或操作之间存在任何这种实际的关系或者顺序。而且，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的过程、方法、物品或者设备不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、方法、物品或者设备所固有的要素。在没有更多限制的情况下，由语句“包括一个……”限定的要素，并不排除在包括所述要素的过程、方法、物品或者设备中还存在另外的相同要素。

结合本文中所公开的实施例描述的方法或算法的步骤可以直接用硬件、处理器执行的软件模块，或者二者的结合来实施。软件模块可以置于随机存储器(RAM)、内存、只读存储器(ROM)、电可编程ROM、电可擦除可编程ROM、寄存器、硬盘、可移动磁盘、CD-ROM、或技术领域内所公知的任意其它形式的存储介质中。

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

Claims (10)

1.一种代码生成方法，其特征在于，包括：

获取接口对应的接口信息，所述接口信息包括多个字段以及多个字段分别对应的字段值，所述多个字段包括：后台服务器的通讯地址、向所述后台服务器发送的报文携带的参数名称、所述报文的结构以及所述报文的请求方式；

控制显示用户界面，所述用户界面用于指示用户选择接口代码模板，所述接口代码模板包括待填写字段值的多个字段；

获取通过所述用户界面确定的所述接口对应的接口代码模板；

从所述接口信息中查找所述接口代码模板包含的字段的字段值，并填入所述接口代码模板，以生成所述接口对应的目标接口代码。

2.根据权利要求1所述代码生成方法，其特征在于，还包括：

基于预先设置的接口代码与文件位置的对应关系中，查找所述目标接口代码对应的目标文件位置；

将所述目标接口代码***预构建的前端客户端的代码文件的所述目标文件位置。

3.根据权利要求1或2所述代码生成方法，其特征在于，所述获取接口对应的接口信息包括：

获取所述接口对应的接口文档；

解析所述接口文档，以获得所述接口信息。

4.根据权利要求1或2所述代码生成方法，其特征在于，所述获取接口对应的接口信息包括：

建立与在线接口管理工具的通信连接，所述在线接口管理工具包含所述接口对应的接口信息；

通过所述在线接口管理工具获得所述接口对应的接口信息。

5.一种代码生成装置，其特征在于，包括：

第一获取模块，用于获取接口对应的接口信息，所述接口信息包括多个字段以及多个字段分别对应的字段值，所述多个字段包括：后台服务器的通讯地址、向所述后台服务器发送的报文携带的参数名称、所述报文的结构以及所述报文的请求方式；

控制模块，用于控制显示用户界面，所述用户界面用于指示用户选择接口代码模板，所述接口代码模板包括待填写字段值的多个字段；

第二获取模块，用于获取通过所述用户界面确定的所述接口对应的接口代码模板；

生成模块，用于从所述接口信息中查找所述接口代码模板包含的字段的字段值，并填入所述接口代码模板，以生成所述接口对应的目标接口代码。

6.根据权利要求5所述代码生成装置，其特征在于，还包括：

查找模块，用于基于预先设置的接口代码与文件位置的对应关系中，查找所述目标接口代码对应的目标文件位置；

***模块，用于将所述目标接口代码***预构建的前端客户端的代码文件的所述目标文件位置。

7.根据权利要求5或6所述代码生成装置，其特征在于，所述第一获取模块包括：

第一获取单元，用于获取所述接口对应的接口文档；

解析单元，用于解析所述接口文档，以获得所述接口信息。

8.一种电子设备，其特征在于，包括：

处理器；

用于存储所述处理器可执行指令的存储器；

其中，所述处理器被配置为执行所述指令，以实现如权利要求1至4任一所述的代码生成方法。

9.一种计算机可读存储介质，当所述存储介质中的指令由电子设备的处理器执行时，使得所述电子设备能够执行如权利要求1至4中任一项所述的代码生成方法。

10.一种计算机程序产品，可直接加载到计算机的内部存储器，所述存储器为上述权利要求8所述电子设备包含的存储器中，并含有软件代码，所述计算机程序经由计算机载入并执行后能够实现如权利要求1至4中任一项所述的代码生成方法。

Images