CN107885502B - 接口处理方法、处理装置、接口管理方法和管理装置 - Google Patents

Abstract

本发明提供了一种接口处理方法、处理装置、接口管理方法和管理装置，该接口处理方法包括：对全部Java文件进行模块化，得到多个由Java文件构成的功能模块；对于每一个功能模块，获取该功能模块内各个Java文件所包含的全部接口地址；建立各个接口地址与各个接口地址对应的预设wiki信息之间的wiki映射关系。基于此，可方便开发人员查找接口地址，并为后续快速获取接口地址所对应的wiki信息建立基础。

Description

接口处理方法、处理装置、接口管理方法和管理装置

技术领域

本发明涉及计算机网络通信技术领域，更具体地说，涉及一种接口处理方法、处理装置、接口管理方法和管理装置。

背景技术

接口定义在开发过程中十分常见。在团队开发时，由于各开发人员的开发风格并不相同，因此，接口定义也十分混乱，一个Java文件中可能定义多个接口。

在开发人员更新某一个接口时，首先会全局搜索所有Java文件来查找该接口；进而在了解该接口的相关信息，例如，接口参数、使用方法等的情况下，重新定义该接口。

但是，由于该接口很可能并非该开发人员预先定义的，因此该开发人员需要重新登录wiki站点，以从wiki站点中获取该接口的相关信息，也就是wiki信息，这就会增加开发工作量，从而降低开发效率。

发明内容

有鉴于此，本发明提供一种接口处理方法、处理装置、接口管理方法和管理装置，以解决开发人员需要重新登录wiki站点获取接口的wiki信息的问题。技术方案如下：

一种接口处理方法，包括：

对全部Java文件进行模块化，得到多个由Java文件构成的功能模块；

对于每一个所述功能模块，获取该功能模块内各个Java文件所包含的全部接口地址；

建立各个所述接口地址与各个所述接口地址对应的预设wiki信息之间的wiki映射关系。

优选的，还包括：

根据预设wiki信息生成各个所述接口地址的注释信息。

一种接口处理装置，包括：模块化单元、地址获取单元和映射建立单元；

所述模块化单元，用于对全部Java文件进行模块化，得到多个由Java文件构成的功能模块；

所述地址获取单元，用于对于每一个所述功能模块，获取该功能模块内各个Java文件所包含的全部接口地址；

所述映射建立单元，用于建立各个所述接口地址与各个所述接口地址对应的预设wiki信息之间的wiki映射关系。

优选的，还包括：注释生成模块；

所述注释生成模块，用于根据预设wiki信息生成各个所述接口地址的注释信息。

一种基于上述技术方案任意一项所述的接口处理方法的接口管理方法，其特征在于，包括：

显示多个功能模块；

在接收到针对目标功能模块的第一显示指令的情况下，显示所述目标功能模块内的全部接口地址；

在接收到针对目标接口地址的第二显示指令的情况下，基于wiki映射关系获取所述目标接口地址对应的目标预设wiki信息，并显示。

优选的，还包括：

在接收到针对所述目标预设wiki信息的编辑指令的情况下，响应所述编辑指令。

优选的，还包括：

在检测到存在目标工程的情况下，若接收到针对所述目标接口地址的功能生成指令，调取所述目标工程的预设功能定义模板；

按照所述预设功能定义模板和所述目标预设wiki信息，生成所述目标接口地址在所述目标工程中的功能信息，并添加至所述目标工程中。

优选的，所述目标预设wiki信息的显示方式为无模式对话框。

一种接口管理装置，包括：功能模块显示单元、地址显示单元、wiki信息显示单元；

所述功能模块显示单元，用于显示多个功能模块；

所述地址显示单元，用于在接收到针对目标功能模块的第一显示指令的情况下，显示所述目标功能模块内的全部接口地址；

所述wiki信息显示单元，用于在接收到针对目标接口地址的第二显示指令的情况下，基于wiki映射关系获取所述目标接口地址对应的目标预设wiki信息，并显示。

优选的，还包括：功能定义模板调取单元和功能信息生成单元；

所述功能定义模板调取单元，用于在检测到存在目标工程的情况下，若接收到针对所述目标接口地址的功能生成指令，调取所述目标工程的预设功能定义模板；

所述功能信息生成单元，用于按照所述预设功能定义模板和所述目标预设wiki信息，生成所述目标接口地址在所述目标工程中的功能信息，并添加至所述目标工程中。

相较于现有技术，本发明实现的有益效果为：

以上本发明提供的一种接口处理方法、处理装置、接口管理方法和管理装置，该接口处理方法可模块化全部Java文件，得到多个功能模块；进一步，为功能模块内各个Java文件所包含的接口地址建立wiki映射关系。基于此，可方便开发人员查找接口地址，并为后续快速获取接口地址所对应的wiki信息建立基础。

附图说明

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

图1为本发明提供的接口处理方法的方法流程图；

图2为本发明提供的接口处理装置的结构示意图；

图3为本发明提供的接口管理方法的方法流程图；

图4示出一个接口管理的显示界面；

图5示出另一个接口管理的显示界面；

图6示出另一个接口管理的显示界面；

图7为本发明提供的接口管理装置的结构示意图。

具体实施方式

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

wiki：一种在网络上开放且可供多人协同创作的超文本系统，由沃德·坎宁安于1995年首先开发，这种超文本系统支持面向社群的协作式写作，同时也包括一组支持这种写作。沃德·坎宁安将wiki定义为“一种允许一群用户用简单的描述来创建和连接一组网页的社会计算系统”。

模块化：是指解决一个复杂问题时自顶向下逐层把系统划分成若干模块的过程，有多种属性，分别反映其内部特性。

无模式对话框：当处于开启状态时，允许用户操作其他窗口的对话框。例如，Windows提供的记事本程序中的【查找】对话框。【查找】对话框不会垄断用户的输入，打开【查找】对话框后，仍可与其他用户界面对象进行交互。用户可以一边查找，一边修改文章，这样就大大方便了使用。

本发明实施例提供一种接口处理方法，其方法流程图如图1所示，包括如下步骤：

S10，对全部Java文件进行模块化，得到多个由Java文件构成的功能模块；

在执行步骤S10的过程中，进行模块化的Java文件可由用户预先指定，当然，还可从某一存储地址处调取进行模块化的Java文件，本实施例不做具体限定。

可按照预先设定的模块化规则对全部Java文件进行模块化，该模块化规则可为Java文件的文件功能，还可为Java文件的开发人员，本实施例不做具体限定。

例如，按照文件功能将100个Java文件分为了5个功能模块，其中第一功能模块内有10个Java文件，第二功能模块内有30个Java文件，第三功能模块内有20个Java文件，第四功能模块内有25个Java文件，第五功能模块内有15个Java文件。

本实施例中功能模块内各Java文件所包含的接口地址的地址类型可设置为public static final String，以实现公有化接口地址。

进一步的，本实施例中还可为各个功能模块生成一个Java总文件，该Java总文件内包含有功能模块内所包含的接口地址。

S20，对于每一个功能模块，获取该功能模块内各个Java文件所包含的全部接口地址；

在执行步骤S20的过程中，在未生成Java总文件的情况下，可从功能模块的各个Java文件中调取其所包含的全部接口地址；在生成Java总文件的情况下，可从Java总文件中直接调取功能模块所包含的全部接口地址。

S30，建立各个接口地址与各个接口地址对应的预设wiki信息之间的wiki映射关系；

在执行步骤S30的过程中，在接收到各个接口地址的预设wiki信息的情况下，为各个接口地址和相应预设wiki信息建立映射关系，此外，映射关系可存储于某一存储地址处，还可存储于MAP表中，本是实施例不做具体限定。

在其中一些实施例中，上述方法还可将预设wiki信息，例如该接口地址的参数、返回值和例子等使用注释的方式定义，从而生成接口地址的注释信息，其中，注释信息包括标题、接口请求参数以及请求方式等。

本发明实施例提供的接口处理方法，可方便开发人员查找接口地址，并为后续快速获取接口地址所对应的wiki信息建立基础。

基于上述实施例提供的接口处理方法，本发明实施例还提供一种执行上述接口处理方法的装置，其结构示意图如图2所示，包括：模块化单元10、地址获取单元20和映射建立单元30；

模块化单元10，用于对全部Java文件进行模块化，得到多个由Java文件构成的功能模块；

地址获取单元20，用于对于每一个功能模块，获取该功能模块内各个Java文件所包含的全部接口地址；

映射建立单元30，用于建立各个接口地址与各个接口地址对应的预设wiki信息之间的wiki映射关系。

在其中一些实施例中，上述接口处理装置还可包括注释生成模块；

注释生成模块，用于根据预设wiki信息生成各个接口地址的注释信息。

本发明实施例提供的接口处理装置，可方便开发人员查找接口地址，并为后续快速获取接口地址所对应的wiki信息建立基础。

基于上述实施例所提供的接口处理方法和接口处理装置，本发明实施例该提供一种接口管理方法，该接口管理方法可基于IntelliJ IDEA实现，在IntelliJ IDEA上的开发步骤如下：

1、下载安装IntelliJ IDEA，配置好IntelliJ IDEA插件开发环境。

2、通过配置plugin.xml文件，将入口放在build的菜单目录下。

3、扫描工程的配置，将有带有接口的Java文件读取到内存中。

上述带有接口的Java文件即为功能模块内的各个Java文件。而在读取Java文件的过程中，可读取地址类型为public static final String的接口地址以及该接口地址上方最近的一条注释信息，其中注释信息中存在各种特殊标记，以区分标题、接口请求参数等信息的入口。

需要说明的是，目前由于仅IntelliJ IDEA可以以插件的形式支持各种语言，因此，现阶段可基于IntelliJ IDEA实现本实施例所提供的接口管理方法，并不排除实现上述接口管理方法的其他平台，本实施例不做具体限定。

本实施例所提供的接口管理方法的方法流程图如图3所示，包括如下步骤：

S40，显示多个功能模块；

在执行步骤S40的过程中，在读取完成Java文件之后，可在显示界面上显示各个功能模块，在显示过程中，可基于模块化规则为各个功能模块添加标识，如图4示出一个接口管理的显示界面，在该显示界面上存在两个功能模块——登录注册功能模块和问答功能模块，标识分别为1.1登录注册和1.2问答。

S50，在接收到针对目标功能模块的第一显示指令的情况下，显示目标功能模块内的全部接口地址；

在执行步骤S50的过程中，可通过检测目标区域的触屏操作确定针对目标功能模块的第一显示指令，例如，可通过检测图4中问答功能模块所对应的箭头区域的点击事件确定用于显示问答功能模块内全部接口地址的第一显示指令。

在确定第一显示指令之后，可在显示界面上显示目标功能模块内的全部接口地址，在显示过程中，可基于接口内容为各个接口地址添加标识，如图5示出另一个接口管理的显示界面，在目标功能模块为问答功能模块的情况下，该显示界面上存在4个接口地址——提问接口地址、回答接口地址、问题列表接口地址和举报接口地址，标识分别为1.2.1提问接口、1.2.2回答接口、1.2.3问题列表接口和1.2.4举报接口。

S60，在接收到针对目标接口地址的第二显示指令的情况下，基于wiki映射关系获取目标接口地址对应的目标预设wiki信息，并显示；

在执行步骤S60的过程中，可通过检测目标区域的触屏操作确定针对目标接口地址的第二显示指令，例如，可通过检测图5中提问接口所对应的箭头区域的点击事件确定用于显示提问接口的预设wiki信息的第二显示指令。

在确定第二显示指令之后，可在显示界面上显示目标接口地址对应的目标预设wiki信息，在显示过程中，可以以接口详情页的方式显示目标预设wiki信息，如图6示出另一个接口管理的显示界面，该显示界面上显示有提问接口地址的预设wiki信息，具体包括接口地址内容、参数信息、状态信息以及举例返回信息等，可根据实际需要具体设置接口详情页的显示内容。

在其中一些实施例中，上述方法还可包括如下步骤：

在接收到针对目标预设wiki信息的编辑指令的情况下，响应编辑指令。具体的，在详情页的显示界面上检测到对于详情内容的编辑指令，例如，修改、删除时，进行响应。

在其中一些实施例中，上述方法还可包括如下步骤：

在检测到存在目标工程的情况下，若接收到针对目标接口地址的功能生成指令，调取目标工程的预设功能定义模板；按照预设功能定义模板和目标预设wiki信息，生成目标接口地址在目标工程中的功能信息，并添加至目标工程中。

具体的，在检测到存在用于显示目标工程的其他IED窗口的情况下，可通过检测用于显示目标预设wiki信息的显示界面上的触屏操作确定功能生成指令，例如，在图6示出的详情页上存在一个安卓图标，若检测到该安卓图标上存在点击事件并检测到从详情页到所述其他IED窗口的滑动轨迹，则调取目标工程的预设功能定义模板，该预设功能定义模板中存储于关于目标工程的使用方法，将目标预设wiki信息填充到预设功能定义模板以生成目标接口地址在目标工程的功能信息，并添加所述其他IED窗口中。

当然，为方便开发人员操作，可将用于显示目标预设wiki信息的显示界面设置为无模式对话框。

本发明实施例提供的接口管理方法，可方便开发人员实时查询接口地址的wiki信息，提高了开发效率，相应管理成本也大大降低。

基于上述实施例提供的接口管理方法，本发明实施例还提供一种执行上述接口管理方法的装置，其结构示意图如图7所示，包括：功能模块显示单元40、地址显示单元50、wiki信息显示单元60；

功能模块显示单元40，用于显示多个功能模块；

地址显示单元50，用于在接收到针对目标功能模块的第一显示指令的情况下，显示目标功能模块内的全部接口地址；

wiki信息显示单元60，用于在接收到针对目标接口地址的第二显示指令的情况下，基于wiki映射关系获取目标接口地址对应的目标预设wiki信息，并显示。

在其中一些实施例中，上述装置还可包括：功能定义模板调取单元和功能信息生成单元；

功能定义模板调取单元，用于在检测到存在目标工程的情况下，若接收到针对目标接口地址的功能生成指令，调取目标工程的预设功能定义模板；

功能信息生成单元，用于按照预设功能定义模板和目标预设wiki信息，生成目标接口地址在目标工程中的功能信息，并添加至目标工程中。

本发明实施例提供的接口管理装置，可方便开发人员实时查询接口地址的wiki信息，提高了开发效率，相应管理成本也大大降低。

以上对本发明所提供的一种接口处理方法、处理装置、接口管理方法和管理装置进行了详细介绍，本文中应用了具体个例对本发明的原理及实施方式进行了阐述，以上实施例的说明只是用于帮助理解本发明的方法及其核心思想；同时，对于本领域的一般技术人员，依据本发明的思想，在具体实施方式及应用范围上均会有改变之处，综上所述，本说明书内容不应理解为对本发明的限制。

需要说明的是，本说明书中的各个实施例均采用递进的方式描述，每个实施例重点说明的都是与其他实施例的不同之处，各个实施例之间相同相似的部分互相参见即可。对于实施例公开的装置而言，由于其与实施例公开的方法相对应，所以描述的比较简单，相关之处参见方法部分说明即可。

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

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

Claims (8)

1.一种接口处理方法，其特征在于，包括：

对全部 Java 文件进行模块化，得到多个由 Java 文件构成的功能模块；对于每一个所述功能模块，获取该功能模块内各个 Java 文件所包含的全部接口地址；

建立各个所述接口地址与各个所述接口地址对应的预设 wiki 信息之间的wiki 映射关系；

根据所述预设 wiki 信息生成各个所述接口地址的注释信息，所述注释信息包括：标题、接口请求参数以及请求方式。

2.一种接口处理装置，其特征在于，包括：模块化单元、地址获取单元、映射建立单元和注释生成模块；

所述模块化单元，用于对全部 Java 文件进行模块化，得到多个由 Java 文件构成的功能模块；

所述地址获取单元，用于对于每一个所述功能模块，获取该功能模块内各个 Java 文件所包含的全部接口地址；

所述映射建立单元，用于建立各个所述接口地址与各个所述接口地址对应的预设wiki 信息之间的 wiki 映射关系；

所述注释生成模块，用于根据所述预设 wiki 信息生成各个所述接口地址的注释信息，所述注释信息包括：标题、接口请求参数以及请求方式。

3.一种基于权利要求 1 所述的接口处理方法的接口管理方法，其特征在于，包括：

显示多个功能模块；

在接收到针对目标功能模块的第一显示指令的情况下，显示所述目标功能模块内的全部接口地址；

在接收到针对目标接口地址的第二显示指令的情况下，基于 wiki 映射关系获取所述目标接口地址对应的目标预设 wiki 信息，并显示。

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

在接收到针对所述目标预设 wiki 信息的编辑指令的情况下，响应所述编辑指令。

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

在检测到存在目标工程的情况下，若接收到针对所述目标接口地址的功能生成指令，调取所述目标工程的预设功能定义模板；

按照所述预设功能定义模板和所述目标预设 wiki 信息，生成所述目标接口地址在所述目标工程中的功能信息，并添加至所述目标工程中。

6.根据权利要求 3 所述的方法，其特征在于，所述目标预设 wiki 信息的显示方式为无模式对话框。

7.一种基于权利要求 1 所述的接口处理方法的接口管理装置，其特征在于，包括：功能模块显示单元、地址显示单元、wiki 信息显示单元；

所述功能模块显示单元，用于显示多个功能模块；

所述地址显示单元，用于在接收到针对目标功能模块的第一显示指令的情况下，显示所述目标功能模块内的全部接口地址；

所述 wiki 信息显示单元，用于在接收到针对目标接口地址的第二显示指令的情况下，基于 wiki 映射关系获取所述目标接口地址对应的目标预设 wiki信息，并显示。

8.根据权利要求 7 所述的装置，其特征在于，还包括：功能定义模板调取单元和功能信息生成单元；

所述功能定义模板调取单元，用于在检测到存在目标工程的情况下，若接收到针对所述目标接口地址的功能生成指令，调取所述目标工程的预设功能定义模板；

所述功能信息生成单元，用于按照所述预设功能定义模板和所述目标预设 wiki 信息，生成所述目标接口地址在所述目标工程中的功能信息，并添加至所述目标工程中。

Images