CN110609854A - 字段名查询方法、系统、电子设备及计算机存储介质 - Google Patents

Abstract

本发明实施例公开了一种字段名查询方法、系统、电子设备及计算机存储介质。所述字段名查询方法包括：获取已有接口返回的字段名及与所述字段名对应的注释；以预设的规则，整理所述字段名并存储到一张数据表中；采集用户的搜索指令；在所述数据表中，搜索与所述搜索指令对应的字段名。该字段名查询方法及其系统，可以实现对于字段名的统一管理，实现了前后端字段名的一致，节省了向后台询问字段名的时间，有利于提升效率，并且能够达到统一和规范字段名的效果。

Description

字段名查询方法、系统、电子设备及计算机存储介质

技术领域

本发明涉及前后端联调技术领域，尤其涉及一种字段名查询方法、系统、电子设备及计算机存储介质。

背景技术

在现有的项目开发过程中，采用前端与后端分离架构，并线开发形式开始越来越广泛的被采用。

前后端分离的并线开发方式具有提升效率等的优点，但现在前端开发在未开始使用mock数据联调或者说未开始和后端真正联调时，假如一个前端页面很快的被搭建完成时，后端接口文档尚未及时提供，那么就会出现前后端开发的时间差，从而降低了真正的联调速度。

例如，现在前端可以通过mock来查看字段名，但是在未提供mock，或者mock并不详细的情况下，前端开发人员仍然需要向后端开发部门询问相应的字段名，造成时间上的损失。

如果协调过程不理想，容易造成前端的字段名与后端不一致，联调时还需要再去确认字段名。这样的方式不利于字段名的统一管理，在数量较多的情况下，非常耽误联调效率。

因此，迫切需要提供一种新的字段名查询方法来解决以上的一个或者多个问题。

发明内容

本发明的实施例提供了一种字段名查询方法、系统、电子设备及计算机存储介质，用于解决现有的字段名查询方法存在的一种或者多种问题。

本发明实施例的第一方面提供了一种字段名查询方法。所述字段名查询方法包括：

获取已有接口返回的字段名及与所述字段名对应的注释；以预设的规则，整理所述字段名并存储到一张数据表中；采集用户的搜索指令；在所述数据表中，搜索与所述搜索指令对应的字段名。

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

确定新开发接口所使用的字段名及对应的注释；整理所述新开发接口所使用的字段名及对应的注释，并增加至所述数据表。

可选地，在所述数据表中，搜索与所述搜索指令对应的字段名，具体包括：根据所述搜索指令，确定搜索条件和目标字段名的注解；在所述搜索条件下，搜索与所述目标字段名的注解相匹配的一个或者多个字段名作为搜索结果；返回所述搜索结果。

可选地，所述搜索条件包括基本数据类型以及引用类型；

所述基本数据类型包括：未定义、空值、布尔值、数字以及字符串；所述引用类型包括：对象、数组以及函数。

可选地，通过精确搜索工具或者模糊搜索工具，在所述数据表中，搜索与所述目标字段名的注解相匹配的一个或者多个字段名。

本发明实施例的第二方面提供了一种字段名查询系统。其中，所述字段名查询系统包括：

数据获取单元，用于获取已有接口返回的字段名及与所述字段名对应的注释；数据维护单元，用于以预设的规则，整理所述字段名并存储到一张数据表中；指令采集单元，用于采集用户的搜索指令；搜索单元，用于在所述数据表中，搜索与所述搜索指令对应的字段名。

可选地，所述系统还包括：数据更新单元，用于确定新开发接口所使用的字段名及对应的注释，并且整理所述新开发接口所使用的字段名及对应的注释，并增加至所述数据表。

可选地，所述搜索单元具体用于：根据所述搜索指令，确定搜索条件和目标字段名的注解；在所述搜索条件下，搜索与所述目标字段名的注解相匹配的一个或者多个字段名作为搜索结果；返回所述搜索结果；

其中，所述搜索条件包括基本数据类型以及引用类型；所述基本数据类型包括：未定义、空值、布尔值、数字以及字符串；所述引用类型包括：对象、数组以及函数。

本发明实施例的第三方面提供了一种电子设备。该电子设备包括处理器、存储器、通信接口和通信总线，所述处理器、所述存储器和所述通信接口通过所述通信总线完成相互间的通信；

所述存储器用于存放至少一可执行指令，所述可执行指令使所述处理器执行如上所述的字段名查询方法的步骤。

本发明实施例第四方面提供了一种计算机存储介质，所述计算机存储介质中存储有至少一计算机程序，所述计算机程序使处理器执行上所述的字段名查询方法的步骤。

本发明的实施例提供的字段名查询方法及其系统，可以实现对于字段名的统一管理，实现了前后端字段名的一致，节省了向后台询问字段名的时间，有利于提升效率，并且能够达到统一字段名规范，增加复用性的效果。

上述说明仅是本发明实施例技术方案的概述，为了能够更清楚了解本发明实施例的技术手段，而可依照说明书的内容予以实施，并且为了让本发明实施例的上述和其它目的、特征和优点能够更明显易懂，以下特举本发明的具体实施方式。

附图说明

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

图1是本发明实施例提供的字段名查询方法的流程图；

图2是本发明实施例提供的步骤140的方法流程图；

图3是本发明实施例提供的字段名查询系统的功能框图；

图4是本发明实施例提供的电子设备的结构框图。

具体实施方式

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

应当理解，当在本说明书和所附权利要求书中使用时，术语“包括”和“包含”指示所描述特征、整体、步骤、操作、元素和/或组件的存在，但并不排除一个或多个其它特征、整体、步骤、操作、元素、组件和/或其集合的存在或添加。

图1示出了本发明实施例提供的字段名查询方法的流程图。该方法可以应用于前后端联调，在mock联调或者真实数据联调中都能够保持前后端字段名一致。如图1所示，该方法可以包括如下步骤：

步骤110：获取已有接口返回的字段名及与所述字段名对应的注释。

已有接口所使用的字段名以及字段名对应的注释可以由后端提供。其可以通过任何合适的方式收集以获得全部的字段名及其注释作为基本数据。该字段名及其注释具体可以根据实际情况而确定，在此不作限定。

步骤120：以预设的规则，整理所述字段名并存储到一张数据表中。

基本数据采集完成以后，需要对其进行相应的整理和维护。具体可以使用任何合适的规则对已有的字段名进行整理或者归类，放置一张统一的表中进行维护。例如，可以按照字段名的注释或者类型进行相应的分类。

该数据表是一个数据集合，按照一定的规则，有序的记录字段名及其对应的注释以便于后续的搜索操作。具体整理的方式可以是按照字段名对应的数据类型或者引用类型来进行整理。当然，还可以采用其他合适的整理方式。

在一些实施例中，除了对已有接口的信息的收集以外，还可以对新增接口进行相应的更新，具体可以包括如下步骤：

首先，确定新开发接口所使用的字段名及对应的注释。然后，整理所述新开发接口所使用的字段名及对应的注释，并增加至所述数据表。

通过这样的方式，可以令数据表跟随新开发的接口进行更新，保持字段名的规范和一致。

步骤130：采集用户的搜索指令。

用户的搜索指令是指前端开发人员根据自身需求而在搜索页面中输入的一个或者多个匹配条件，以搜索找寻到符合自身需求的，想要使用的字段名。

步骤140：在所述数据表中，搜索与所述搜索指令对应的字段名。

以所述数据表为基础，通过任何合适的搜索工具或者搜索方式，找到那些符合搜索指令的字段名以提供给前端开发人员使用。

具体使用的搜索方式或者搜索工具可以根据实际情况的需要而设置，为本领域技术人员所熟知，在此不作赘述。

在一些实施例中，为了便于前端开发人员快速的找到想要的字段名，可以支持搜索条件以及注释两个不同层次的检索。亦即，搜索指令中包含了用户输入的搜索条件以及目标字段名的注释。

基于该包含了搜索条件和目标字段名的注释的搜索指令，图2为本发明实施例提供的步骤140的步骤流程图。如图2所示，该步骤140具体可以包括：

步骤141：根据所述搜索指令，确定搜索条件和目标字段名的注解。

具体的，该搜索条件可以分为前端数据的五种基本数据类型以及三种引用类型。该五种基本数据类型分别为未定义(undefined)、空值(null)、布尔值(Boolean)、数字(Number)以及字符串(String)。三大引用类型具体为对象(object)、数组(array)以及函数(function)。

前端开发人员可以根据实际情况的需要，选中其中的一种数据类型或者引用类型作为搜索条件，并相应的输入想要搜索的注释。

步骤142：在所述搜索条件下，搜索与所述目标字段名的注解相匹配的一个或者多个字段名作为搜索结果。

具体的，可以根据实际情况的需要，选择通过精确搜索工具或者模糊搜索工具，在所述数据表中，搜索与所述目标字段名的注解相匹配的一个或者多个字段名。

搜索时选用的是精确搜索还是模糊搜索可以由前端开发人员在进行搜索时选定。而在进行注释检索时，可以采用正则匹配的方式来检索确定与输入的目标注释相匹配的字段名。

步骤143：返回所述搜索结果。

在搜索结束以后，将搜索获得的一个或者多个字段名作为结果，以列表等的形式呈现给前端开发人员，使其能够快速的得到想要的目标字段名。

通过这样的字段名查询方法，可以起到统一命名，避免冗余字段，提高时间效率等的优点，可以有效避同时存在驼峰”userName”，下划线”phone_number”两种形式或者”userName”，”username”，”uName”多种同义字段的问题。

图3示出了本发明实施例提供的字段名查询系统的结构示意图。如图3所示，该业务数据自动生成系统可以包括：数据获取单元310、数据维护单元320、指令采集单元330以及搜索单元340。

其中，数据获取单元310用于获取已有接口返回的字段名及与所述字段名对应的注释。数据维护单元320用于以预设的规则，整理所述字段名并存储到一张数据表中。指令采集单元330用于采集用户的搜索指令。搜索单元340用于在所述数据表中，搜索与所述搜索指令对应的字段名。

在一些实施例中，请继续参阅图3，所述系统还包括：数据更新单元350。

该数据更新单元350用于确定新开发接口所使用的字段名及对应的注释，并且整理所述新开发接口所使用的字段名及对应的注释，并增加至所述数据表。

具体的，所述搜索单元340具体用于：根据所述搜索指令，确定搜索条件和目标字段名的注解；在所述搜索条件下，搜索与所述目标字段名的注解相匹配的一个或者多个字段名作为搜索结果；返回所述搜索结果；

其中，所述搜索条件包括基本数据类型以及引用类型；所述基本数据类型包括：未定义、空值、布尔值、数字以及字符串；所述引用类型包括：对象、数组以及函数。

通过本发明实施例提供的字段名查询系统，实现了字段名的统一整理和维护，可以令前端开发人员快速便捷的查询找到自己想要使用的字段名。同时，该数据表基于后端提供的基础数据进行整理和维护，可以保证前端和后端之间的字段名统一，也具备更好的复用性。

本发明实施例提供了一种非易失性计算机存储介质，所述非易失性计算机存储介质存储有至少一计算机程序，该计算机程序可执行上述任意方法实施例中的字段名查询方法。

计算机程序具体可以用于使得处理器执行以下操作：获取已有接口返回的字段名及与所述字段名对应的注释；以预设的规则，整理所述字段名并存储到一张数据表中；采集用户的搜索指令；在所述数据表中，搜索与所述搜索指令对应的字段名。

图4示出了本发明实施例提供的电子设备实施例的结构示意图，本发明具体实施例并不对电子设备的具体实现做限定。

如图4所示，该电子设备可以包括：处理器(processor)402、通信接口(Communications Interface)604、存储器(memory)406、以及通信总线408。

其中，处理器402、通信接口404、以及存储器406通过通信总线408完成相互间的通信。通信接口404，用于与其它设备比如客户端或其它服务器等的网元通信。处理器402，用于执行程序410，具体可以执行上述字段名查询方法实施例中的相关步骤。

具体地，程序410可以包括程序代码，该程序代码包括计算机操作指令。

处理器402可能是中央处理器CPU，或者是特定集成电路ASIC(ApplicationSpecific Integrated Circuit)，或者是被配置成实施本发明实施例的一个或多个集成电路。电子设备包括的一个或多个处理器，可以是同一类型的处理器，如一个或多个CPU；也可以是不同类型的处理器，如一个或多个CPU以及一个或多个ASIC。

存储器406，用于存放程序410。存储器606可能包含高速RAM存储器，也可能还包括非易失性存储器(non-volatile memory)，例如至少一个磁盘存储器。

程序410具体可以用于使得处理器402执行以下操作：获取已有接口返回的字段名及与所述字段名对应的注释；以预设的规则，整理所述字段名并存储到一张数据表中；采集用户的搜索指令；在所述数据表中，搜索与所述搜索指令对应的字段名。

在此提供的算法或显示不与任何特定计算机、虚拟系统或者其它设备固有相关。各种通用系统也可以与基于在此的示教一起使用。根据上面的描述，构造这类系统所要求的结构是显而易见的。此外，本发明实施例也不针对任何特定编程语言。应当明白，可以利用各种编程语言实现在此描述的本发明的内容，并且上面对特定语言所做的描述是为了披露本发明的最佳实施方式。

在此处所提供的说明书中，说明了大量具体细节。然而，能够理解，本发明的实施例可以在没有这些具体细节的情况下实践。在一些实例中，并未详细示出公知的方法、结构和技术，以便不模糊对本说明书的理解。

类似地，应当理解，为了精简本发明并帮助理解各个发明方面中的一个或多个，在上面对本发明的示例性实施例的描述中，本发明实施例的各个特征有时被一起分组到单个实施例、图、或者对其的描述中。然而，并不应将该公开的方法解释成反映如下意图：即所要求保护的本发明要求比在每个权利要求中所明确记载的特征更多的特征。更确切地说，如下面的权利要求书所反映的那样，发明方面在于少于前面公开的单个实施例的所有特征。因此，遵循具体实施方式的权利要求书由此明确地并入该具体实施方式，其中每个权利要求本身都作为本发明的单独实施例。

本领域那些技术人员可以理解，可以对实施例中的设备中的模块进行自适应性地改变并且把它们设置在与该实施例不同的一个或多个设备中。可以把实施例中的模块或单元或组件组合成一个模块或单元或组件，以及此外可以把它们分成多个子模块或子单元或子组件。除了这样的特征和/或过程或者单元中的至少一些是相互排斥之外，可以采用任何组合对本说明书(包括伴随的权利要求、摘要和附图)中公开的所有特征以及如此公开的任何方法或者设备的所有过程或单元进行组合。除非另外明确陈述，本说明书(包括伴随的权利要求、摘要和附图)中公开的每个特征可以由提供相同、等同或相似目的的替代特征来代替。

以上所述，仅为本发明的具体实施方式，但本发明的保护范围并不局限于此，任何熟悉本技术领域的技术人员在本发明揭露的技术范围内，可轻易想到各种等效的修改或替换，这些修改或替换都应涵盖在本发明的保护范围之内。因此，本发明的保护范围应以权利要求的保护范围为准。

Claims (10)

1.一种字段名查询方法，其特征在于，包括：

获取已有接口返回的字段名及与所述字段名对应的注释；

以预设的规则，整理所述字段名并存储到一张数据表中；

采集用户的搜索指令；

在所述数据表中，搜索与所述搜索指令对应的字段名。

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

确定新开发接口所使用的字段名及对应的注释；

整理所述新开发接口所使用的字段名及对应的注释，并增加至所述数据表。

3.根据权利要求1所述的方法，其特征在于，在所述数据表中，搜索与所述搜索指令对应的字段名，具体包括：

根据所述搜索指令，确定搜索条件和目标字段名的注解；

在所述搜索条件下，搜索与所述目标字段名的注解相匹配的一个或者多个字段名作为搜索结果；

返回所述搜索结果。

4.根据权利要求3所述的方法，其特征在于，所述搜索条件包括基本数据类型以及引用类型；

所述基本数据类型包括：未定义、空值、布尔值、数字以及字符串；所述引用类型包括：对象、数组以及函数。

5.根据权利要求3所述的方法，其特征在于，通过精确搜索工具或者模糊搜索工具，在所述数据表中，搜索与所述目标字段名的注解相匹配的一个或者多个字段名。

6.一种字段名查询系统，其特征在于，所述字段名查询系统包括：

数据获取单元，用于获取已有接口返回的字段名及与所述字段名对应的注释；

数据维护单元，用于以预设的规则，整理所述字段名并存储到一张数据表中；

指令采集单元，用于采集用户的搜索指令；

搜索单元，用于在所述数据表中，搜索与所述搜索指令对应的字段名。

7.根据权利要求6所述的系统，其特征在于，所述系统还包括：

数据更新单元，用于确定新开发接口所使用的字段名及对应的注释，并且整理所述新开发接口所使用的字段名及对应的注释，并增加至所述数据表。

8.根据权利要求6所述的系统，其特征在于，所述搜索单元具体用于：

根据所述搜索指令，确定搜索条件和目标字段名的注解；

在所述搜索条件下，搜索与所述目标字段名的注解相匹配的一个或者多个字段名作为搜索结果；

返回所述搜索结果；

其中，所述搜索条件包括基本数据类型以及引用类型；所述基本数据类型包括：未定义、空值、布尔值、数字以及字符串；所述引用类型包括：对象、数组以及函数。

9.一种电子设备，其特征在于，包括处理器、存储器、通信接口和通信总线，所述处理器、所述存储器和所述通信接口通过所述通信总线完成相互间的通信；

所述存储器用于存放至少一可执行指令，所述可执行指令使所述处理器执行根据权利要求1-5任一项所述的字段名查询方法的步骤。

10.一种计算机存储介质，其特征在于，所述计算机存储介质中存储有至少一计算机程序，所述计算机程序使处理器执行根据权利要求1-5任一项所述的字段名查询方法的步骤。