基于场景式快速检测接口方法、系统、设备及存储介质

技术领域

本申请涉及接口测试技术领域，具体涉及一种基于场景式快速检测接口方法、系统、设备及存储介质。

背景技术

随着移动互联网的不断发展，无论是使用手机端还是网页端的软件，用户对于页面访问，除了受限本地网路要求外，对接口响应时间也很关注，这直接影响用户的体验感。研究表明，对于迟迟不加载信息或者页面直接报错的页面，用户很是抵触、使用体验感不佳。因此，快速检测接口的需求越来越强烈，以便第一时间发现问题所在，提升用户体验感。若使用自动化测试，工程比较复杂，需要大量编码，编写脚本时间比较长，维护脚本的周期长，实施难度比较大，且需要有一定技术能力的人才可以完成该项工作。

页面访问普遍使用，但未必每个系统软件都做了接口监测。有部分系统，虽然做了接口监测，但其只是传统的检测接口，只有在服务器瘫痪或者网络中断等客观原因，才会监测出接口异常并做预警处理。这只能做到最基本的监测，用户体验感极差，需要重启服务器或重启网络才可以恢复。

总之，现有的接口测试至少存在如下问题：

(1)用户访问网页，若无接口监测，可能页面报错，也无人知晓，用户体验感极差；

(2)传统的接口监测，未基于实际使用场景，有的接口可能这个场景调用并无问题，换个场景，调用就报错了；

(3)高频接口，牵一发动全身，若不加以监测，影响比较大；

(4)接口响应时间太长，直接会影响用户访问页面，用户体验不佳。

鉴于此，本申请提出了一种基于场景式快速检测接口方法、系统、设备及存储介质，更符合用户真实访问操作，能够快速响应，且便于实践。

发明内容

为了解决现有检测接口难度大，自动化检测编码耗时长，编码复杂等问题，本申请提供一种基于场景式快速检测接口方法、系统、设备及存储介质，以解决上述技术缺陷问题。

根据本发明的一个方面提出了一种基于场景式快速检测接口方法，该方法包括以下步骤：

S1、通过fiddler工具获取待访问页面的接口信息，并保存接口信息；

S2、使用jmeter测试工具将接口信息打开，对接口信息进行接口改造，其中接口改造包括：改写接口公共信息头参数和公共自定义变量，按页面访问顺序重新定义接口名称，将接口请求参数化以及设置接口断言；

S3、自动化搭建测试环境，具体包括：利用Apache Ant在jmeter测试工具的extras目录下编辑构建文件和设置测试报告模板，访问Jenkins系统进行全局配置ant并定时调度发送包含有测试报告的邮件至用户端；

S4、用户端自动接收由Jenkins系统定时调度发送的邮件。

通过上述技术方案，本申请能够实现快读抓取接口、快速检测接口，快速发送邮件报告。

在具体的实施例中，在步骤S3中，自动化搭建测试环境还包括以下子步骤：

S31、下载Apache Ant，Apache Ant用于脚本编译、测试、部署步骤的自动化集成；

S32、在jmeter测试工具的extras目录下编辑构建文件，将生成的.jtl数据文件转换为.html格式的报告；

S33、设置测试报告模板，报告模板包括：获取报告时间、用例数、失败数、成功率、平均时间、最小时间以及最大时间；

S34、访问Jenkins系统进行全局配置ant，创建项目并在项目中构建触发器，构建ant以及jmeter的构建文件存放目录，设置测试报告的格式为HTML，以及HTML Report存放位置、邮件通知设置；

S35、Jenkins系统访问全局配置系统，设置系统管理员邮件地址、扩展电子邮件通知。

通过上述技术方案，基于Jenkins+ant技术能够自动化搭建测试环境。

在具体的实施例中，在步骤S2中，改写接口公共信息头参数和公共自定义变量包括以下子步骤：

S211、提取公共信息头参数和公共自定义变量；

S212、填写公共信息头参数和公共自定义变量；

S213、接口参数根据提取公共参数进行改写，字段值使用引用变量。

通过上述技术方案，可以根据实际需要填写公共信息头和自定义变量以便完成公共参数提取改造。

在具体的实施例中，在步骤S2中，接口请求参数化包括以下子步骤：

S221、使用时间函数构造年月日时分秒格式或者时间戳格式；

S222、在用户自定义变量中使用时间函数，并在接口中进行引用。

上述技术方案中，利用jmeter函数助手提供的时间函数有助于完成接口变量的参数化。

在具体的实施例中，在步骤S2中，设置接口断言具体包括以下子步骤：

S231、设置响应断言，响应断言的方式包括响应文本断言、响应代码断言、响应信息断言；

S232、获取服务器根据访问请求返回的响应数据，并将响应数据与断言的内容进行比较；

S233、当响应数据与断言内容相符时，判定待测接口的测试结果为通过；否则，待测接口的测试结果为不通过。

通过上述技术方案，添加响应断言以便判断测试结果是否成功。

在具体的实施例中，在步骤S1中，通过fiddler工具获取待访问页面的接口信息，并保存接口信息，包括以下子步骤：

S11、打开fiddler工具进行抓包设置，在fiddler工具的过滤器中输入待访问页面的域名，并且安装支持jmx文件导出的插件；

S12、打开浏览器按顺序访问待访问页面，利用fiddler工具查看抓取接口信息，并且剔除不需要检测的接口信息；

S13、保存剔除后剩下的接口信息，接口信息为jmx脚本格式，接口信息包括：接口名称，接口URL，请求方法，请求参数，响应部分。

通过上述技术方案，剔除不需要检测的接口信息以进一步提高测试效率。

在具体的实施例中，在步骤S3中，邮件的模板包括：项目名称、构建编号、触发原因、构建状态、构建日志、构建url和测试报告。

第二方面，本申请提供了一种基于场景式快速检测接口系统，该系统包括：

接口信息获取模块，配置于通过fiddler工具获取待访问页面的接口信息，并保存接口信息；

接口改造模块，配置于使用jmeter测试工具将接口信息打开，对接口信息进行接口改造，其中接口改造包括：改写接口公共信息头参数和公共自定义变量，按页面访问顺序重新定义接口名称，将接口请求参数化以及设置接口断言；

测试环境搭建模块，配置于自动化搭建测试环境，具体包括：利用Apache Ant在jmeter测试工具的extras目录下编辑构建文件和设置测试报告模板，访问Jenkins系统进行全局配置ant并定时调度发送包含有测试报告的邮件至用户端；

邮件收取模块，配置于用户端自动接收由Jenkins系统定时调度发送的邮件。

第三方面，本申请提供了一种终端设备，包括存储器、处理器以及存储在所述存储器中并可在所述处理器上运行的计算机程序，其特征在于，所述处理器执行所述计算机程序时实现如上述任一项所述基于场景式快速检测接口方法的步骤。

第四方面，本申请提供了一种计算机可读存储介质，所述计算机可读存储介质存储有计算机程序，其特征在于，所述计算机程序被处理器执行时实现如上述任一项所述基于场景式快速检测接口方法的步骤。

与现有技术相比，本发明的有益成果在于：

(1)基于场景式快读检测接口，更符合用户真实访问操作；

(2)能够快速响应，且便于实践，并且可以大规模应用于不同场景；

(3)灵活性强，实用性高、可行性强，效果好、便捷高效、维护工程脚本工作量很低。

附图说明

通过阅读参照以下附图，所作的对非限制性实施例所作的详细描述，本申请的其它特征、目的和优点将会变得更明显：

图1是根据本申请的基于场景式快速检测接口方法的流程图；

图2是根据本申请的基于场景式快速检测接口系统的结构图；

图3是适于用来实现本申请实施例的电子设备的计算机系统的结构示意图。

具体实施方式

下面结合附图和实施例对本申请作进一步的详细说明。可以理解的是，此处所描述的具体实施例仅仅用于解释相关发明，而非对该发明的限定。另外还需要说明的是，为了便于描述，附图中仅示出了与有关发明相关的部分。

需要说明的是，在不冲突的情况下，本申请中的实施例及实施例中的特征可以相互组合。下面将参考附图并结合实施例来详细说明本申请。

图1示出了本申请的基于场景式快速检测接口方法的流程图，请参考图1，该方法包括以下步骤：

S1、通过fiddler工具获取待访问页面的接口信息，并保存接口信息。

在本实施例中，通过fiddler工具获取待访问页面的接口信息，并保存接口信息，包括以下子步骤：

S11、打开fiddler工具进行抓包设置，在fiddler工具的过滤器中输入待访问页面的域名，并且安装支持jmx文件导出的插件；

S12、打开浏览器按顺序访问待访问页面，利用fiddler工具查看抓取接口信息，并且剔除不需要检测的接口信息；

S13、保存剔除后剩下的接口信息，该接口信息为jmx脚本格式，接口信息包括：接口名称，接口URL，请求方法，请求参数，响应部分。

继续参考图1，本申请提供的一种基于场景式快速检测接口方法还包括：

S2、使用jmeter测试工具将接口信息打开，对接口信息进行接口改造，其中接口改造包括：改写接口公共信息头参数和公共自定义变量，按页面访问顺序重新定义接口名称，将接口请求参数化以及设置接口断言。

在本实施例中，接口改造具体包括以下内容：

(1)改写接口公共信息头参数和公共自定义变量，具体包括以下子步骤：

S211、提取公共信息头参数和公共自定义变量。

例如本案中所提及的http信息头管理器，提取content-type、Authorization、compId、Cookie等公共信息头参数；提取ip、iotIp、fieldId、userId等公共自定义变量。

S212、填写公共信息头参数和公共自定义变量，其中，信息头和自定义变量根据实际需要填写即可。

S213、接口参数根据提取公共参数进行改写，字段值使用引用变量。例如本案把企业id的值替换成${compId}，这样就完成公共参数提取改造。

(2)按页面访问顺序重新定义接口名称。接口名称默认是一串url，将接口名称按页面访问顺序，定义接口名称。

例如，AI巡检系统--高危设备预警二级页-数据预警，其中AI巡检系统为接口工程名称，高危设备预警二级页-数据预警是接口名称。其含义指的页面进入AI巡检系统，点击预警模块的二级页面，点击数据预警页签，所请求的接口。使用该接口命名规则主要是因为该接口高频接口，多次运用在不同系统的不同界面，客户访问频率不一致。当该接口报错时，就能够快速定位接口出错的对应的页面位置，这样就能很快定位是前端错误，还是后端错误。

(3)接口请求参数化，具体包括以下子步骤：

S221、使用时间函数构造年月日时分秒格式或者时间戳格式；

S222、在用户自定义变量中使用时间函数，并在接口中进行引用。

具体的，请求内容分固定字段和变量字段。例如变量字段是时间戳，Jmeter函数助手提供了三种时间函数，分别是：time、timeShift、RandomDate；本申请只使用time函数。构造年月日时分秒格式&{_time(yyyy-mm-dd HH:mm:ss,)}或者时间戳格式&&{_time(,)}，在用户自定义变量中使用设置好的时间函数，并在接口中进行引用。如此便完成接口变量的参数化。

(4)设置接口断言，具体包括以下子步骤：

S231、设置响应断言，响应断言的方式包括响应文本断言、响应代码断言、响应信息断言；

S232、获取服务器根据访问请求返回的响应数据，并将响应数据与断言的内容进行比较；

S233、当响应数据与断言内容相符时，判定待测接口的测试结果为通过；否则，待测接口的测试结果为不通过。

通过测试得知，接口返回状态成功，使用比较多的code：200或code：0；故优先的，本申请的接口请求服务器响应文本成功使用code：200；所以设置响应文本断言"code":200。而添加时间断言，接口响应超过2秒，用户普遍感知响应慢，断言持续时间设置2000ms。

继续参考图1，本申请提供的一种基于场景式快速检测接口方法还包括：

S3、自动化搭建测试环境，具体包括：利用Apache Ant在jmeter测试工具的extras目录下编辑构建文件和设置测试报告模板，访问Jenkins系统进行全局配置ant并定时调度发送包含有测试报告的邮件至用户端。

在本实施例中，自动化搭建测试环境还包括以下子步骤：

S31、下载Apache Ant，Apache Ant用于脚本编译、测试、部署步骤的自动化集成；

S32、在jmeter测试工具的extras目录下编辑构建文件(build.xml)，将生成的.jtl数据文件转换为.html格式的报告；

S33、设置测试报告模板，报告模板包括：获取报告时间、用例数、失败数、成功率、平均时间、最小时间以及最大时间。常见报告模板有jmeter-results-detail-report_21.xsl模板，该模板是默认配置，能够更加直观查看结果。还有另外一种模板jmeter.results.shanhe.me.xsl，该模板可以获取接口详情信息，包括接口请求参数以及返回结果，该模板定位问题也比较方便直观。

S34、访问Jenkins系统进行全局配置ant，创建项目并在项目中构建触发器，按日程表定时构建，日程表填写格式遵循cron的语法；构建ant以及jmeter的文件Build File填写构建文件(build.xml)存放目录；构建后操作，测试报告的格式为HTML，以及HTML Report存放位置、邮件通知设置。其中邮件的模板主要涉及项目名称、构建编号、触发原因、构建状态、构建日志、构建url和测试报告。

S35、Jenkins系统访问全局配置系统(configure system)，设置系统管理员邮件地址、扩展电子邮件通知。

继续参考图1，本申请提供的一种基于场景式快速检测接口方法还包括：

S4、用户端自动接收由Jenkins系统定时调度发送的邮件。用户点击任意一项，即可查看详情。

通过上述四个大步骤，本申请的快读抓取接口、快速检测接口，快速发送邮件报告的方法，能够在页面访问中可以广泛应用，从而解决了背景技术中提到的检测接口难度大，自动化检测耗时长，编码复杂等问题。

进一步参考图2，作为对上述方法的实现，第二方面，本申请提供了基于场景式快速检测接口系统200的一个实施例，该系统具体可以应用于各种电子设备中。该系统200包括以下模块：

接口信息获取模块210，配置于通过fiddler工具获取待访问页面的接口信息，并保存接口信息；

接口改造模块220，配置于使用jmeter测试工具将接口信息打开，对接口信息进行接口改造，其中接口改造包括：改写接口公共信息头参数和公共自定义变量，按页面访问顺序重新定义接口名称，将接口请求参数化以及设置接口断言；

测试环境搭建模块230，配置于自动化搭建测试环境，具体包括：利用Apache Ant在jmeter测试工具的extras目录下编辑构建文件和设置测试报告模板，访问Jenkins系统进行全局配置ant并定时调度发送包含有测试报告的邮件至用户端；

邮件收取模块240，配置于用户端自动接收由Jenkins系统定时调度发送的邮件。

第三方面，本申请提供了一种终端设备，包括存储器、处理器以及存储在所述存储器中并可在所述处理器上运行的计算机程序，其特征在于，所述处理器执行所述计算机程序时实现如上述任一项所述基于场景式快速检测接口方法的步骤。

第四方面，本申请提供了一种计算机可读存储介质，所述计算机可读存储介质存储有计算机程序，其特征在于，所述计算机程序被处理器执行时实现如上述任一项所述基于场景式快速检测接口方法的步骤。

下面参考图3，其示出了适于用来实现本申请实施例的终端设备或服务器的计算机系统300的结构示意图。图3示出的终端设备或服务器仅仅是一个示例，不应对本申请实施例的功能和使用范围带来任何限制。

如图3所示，计算机系统300包括中央处理单元(CPU)301，其可以根据存储在只读存储器(ROM)302中的程序或者从存储部分308加载到随机访问存储器(RAM)303中的程序而执行各种适当的动作和处理。在RAM 303中，还存储有系统300操作所需的各种程序和数据。CPU 301、ROM302以及RAM 303通过总线304彼此相连。输入/输出(I/O)接口305也连接至总线304。

以下部件连接至I/O接口305：包括键盘、鼠标等的输入部分303；包括液晶显示器(LCD)等以及扬声器等的输出部分307；包括硬盘等的存储部分308；以及包括诸如LAN卡、调制解调器等的网络接口卡的通信部分309。通信部分309经由诸如因特网的网络执行通信处理。驱动器310也根据需要连接至I/O接口305。可拆卸介质311，诸如磁盘、光盘、磁光盘、半导体存储器等等，根据需要安装在驱动器310上，以便于从其上读出的计算机程序根据需要被安装入存储部分308。

特别地，根据本公开的实施例，上文参考流程图描述的过程可以被实现为计算机软件程序。例如，本公开的实施例包括一种计算机程序产品，其包括承载在计算机可读介质上的计算机程序，该计算机程序包含用于执行流程图所示的方法的程序代码。在这样的实施例中，该计算机程序可以通过通信部分309从网络上被下载和安装，和/或从可拆卸介质311被安装。在该计算机程序被中央处理单元(CPU)301执行时，执行本申请的方法中限定的上述功能。需要说明的是，本申请所述的计算机可读介质可以是计算机可读信号介质或者计算机可读介质或者是上述两者的任意组合。计算机可读介质例如可以是——但不限于——电、磁、光、电磁、红外线、或半导体的系统、装置或器件，或者任意以上的组合。计算机可读介质的更具体的例子可以包括但不限于：具有一个或多个导线的电连接、便携式计算机磁盘、硬盘、随机访问存储器(RAM)、只读存储器(ROM)、可擦式可编程只读存储器(EPROM或闪存)、光纤、便携式紧凑磁盘只读存储器(CD-ROM)、光存储器件、磁存储器件、或者上述的任意合适的组合。在本申请中，计算机可读介质可以是任何包含或存储程序的有形介质，该程序可以被指令执行系统、装置或者器件使用或者与其结合使用。而在本申请中，计算机可读的信号介质可以包括在基带中或者作为载波一部分传播的数据信号，其中承载了计算机可读的程序代码。这种传播的数据信号可以采用多种形式，包括但不限于电磁信号、光信号或上述的任意合适的组合。计算机可读的信号介质还可以是计算机可读介质以外的任何计算机可读介质，该计算机可读介质可以发送、传播或者传输用于由指令执行系统、装置或者器件使用或者与其结合使用的程序。计算机可读介质上包含的程序代码可以用任何适当的介质传输，包括但不限于：无线、电线、光缆、RF等等，或者上述的任意合适的组合。

可以以一种或多种程序设计语言或其组合来编写用于执行本申请的操作的计算机程序代码，所述程序设计语言包括面向对象的程序设计语言—诸如Java、Smalltalk、C++，还包括常规的过程式程序设计语言—诸如“C”语言或类似的程序设计语言。程序代码可以完全地在用户计算机上执行、部分地在用户计算机上执行、作为一个独立的软件包执行、部分在用户计算机上部分在远程计算机上执行、或者完全在远程计算机或服务器上执行。在涉及远程计算机的情形中，远程计算机可以通过任意种类的网络——包括局域网(LAN)或广域网(WAN)—连接到用户计算机，或者，可以连接到外部计算机(例如利用因特网服务提供商来通过因特网连接)。

附图中的流程图和框图，图示了按照本申请各种实施例的系统、方法和计算机程序产品的可能实现的体系架构、功能和操作。在这点上，流程图或框图中的每个方框可以代表一个模块、程序段、或代码的一部分，该模块、程序段、或代码的一部分包含一个或多个用于实现规定的逻辑功能的可执行指令。也应当注意，在有些作为替换的实现中，方框中所标注的功能也可以以不同于附图中所标注的顺序发生。例如，两个接连地表示的方框实际上可以基本并行地执行，它们有时也可以按相反的顺序执行，这依所涉及的功能而定。也要注意的是，框图和/或流程图中的每个方框、以及框图和/或流程图中的方框的组合，可以用执行规定的功能或操作的专用的基于硬件的系统来实现，或者可以用专用硬件与计算机指令的组合来实现。

以上描述仅为本申请的较佳实施例以及对所运用技术原理的说明。本领域技术人员应当理解，本申请中所涉及的发明范围，并不限于上述技术特征的特定组合而成的技术方案，同时也应涵盖在不脱离上述发明构思的情况下，由上述技术特征或其等同特征进行任意组合而形成的其它技术方案。例如上述特征与本申请中公开的(但不限于)具有类似功能的技术特征进行互相替换而形成的技术方案。