对接口源代码进行白盒检查的方法和装置的制造方法
【专利摘要】本发明实施例涉及接口开发领域，公开了一种对接口源代码进行白盒检查的方法和装置。对接口源代码进行白盒检查的方法包括：获取将进行白盒检查的接口源代码；对所述接口源代码进行扫描并判断所述接口源代码中是否存在预设字符串；以及若所述预设字符串存在于所述接口源代码中，则确认所述接口源代码符合接口开发规范。根据本发明实施例的方法和装置能够增加白盒检查的效率和准确率。
【专利说明】
对接口源代码进行白盒检查的方法和装置
技术领域
[0001 ]本发明实施例涉及接口开发领域，具体地，涉及一种对接口源代码进行白盒检查的方法和装置。
【背景技术】
[0002]乐视智能云平台为乐视超级手机(电视)提供各种后端服务。换言之，乐视智能云平台拥有众多的上游产品。为此乐视智能云平台制定了统一的接口规范，以使上游产品能够方便地调用所开发的对外服务接口，并降低了接口维护成本，增加了接口使用的准确率。另外，统一的接口规范还可以在上游产品做字段匹配时不需要考虑后续兼容性的问题。
[0003]然而，在对接口源代码进行检查时，都是通过人眼的形式进行手动检查，这不仅繁琐，而且检查效率和检查准确率都非常低。
【发明内容】
[0004]本发明实施例的目的是提供一种对接口源代码进行白盒检查的方法和装置，其能够增加白盒检查的效率和准确率。
[0005]为了实现上述目的，本发明提供一种对接口源代码进行白盒检查的方法，该方法包括:获取将进行白盒检查的接口源代码;对所述接口源代码进行扫描并判断所述接口源代码中是否存在预设字符串；以及若所述预设字符串存在于所述接口源代码中，则确认所述接口源代码符合接口开发规范。
[0006]本发明实施例还提供一种对接口源代码进行白盒检查的装置，该装置包括:获取模块，用于获取将进行白盒检查的接口源代码；以及白盒检查模块，用于对所述接口源代码进行扫描并判断所述接口源代码中是否存在预设字符串，若所述预设字符串存在于所述接口源代码中，则确认所述接口源代码符合接口开发规范。
[0007]通过上述技术方案，由于根据本发明的方法和装置能够获取将进行白盒检查的接口源代码并对所述接口源代码进行扫描以判断所述接口源代码中是否存在预设字符串，因此其能够自动地进行接口源代码的白盒检查并提高白盒检查的效率和准确率。
[0008]本发明实施例的其它特征和优点将在随后的【具体实施方式】部分予以详细说明。
【附图说明】
[0009]附图是用来提供对本发明的进一步理解，并且构成说明书的一部分，与下面的【具体实施方式】一起用于解释本发明，但并不构成对本发明的限制。在附图中:
[0010]图1是根据本发明一种实施方式的对接口源代码进行白盒检查的方法的流程图；
[0011]图2是根据本发明一种实施方式的对接口源代码进行白盒检查的装置的示意框图；以及
[0012]图3是根据本发明一种实施方式的对接口源代码进行白盒检查的装置的另一示意框图。
【具体实施方式】
[0013]以下结合附图对本发明的【具体实施方式】进行详细说明。应当理解的是，此处所描述的【具体实施方式】仅用于说明和解释本发明，并不用于限制本发明。
[0014]如图1所示，根据本发明一种实施方式的对接口源代码进行白盒检查的方法可以包括以下步骤:
[0015]步骤S1、获取将进行白盒检查的接口源代码。
[0016]其中，将进行白盒检查的接口源代码可以通过以下步骤获取:确定将进行白盒检查的接口 ；获取针对所述接口编写的接口源代码的地址；以及从所述地址下载所述接口源代码。
[0017]以restapi接口为例。首先，确定需要进行白盒检查的对外服务接口是rest api接口；然后，获取针对rest api接口编写的接口源代码的地址，例如对外服务rest api接口的具体版本的svn(git)源码库地址;最后，从所获取的地址自动下载要进行白盒检查的接口源代码。其中，上面提到的SVN是Subvers1n(子版本)的简称，其是一个开放源代码的版本控制系统。SVN系统是本领域技术人员熟知的，此处不再赘述。
[0018]步骤S2、对所获取的接口源代码进行扫描并判断所获取的接口源代码中是否存在预设字符串。
[0019]其中，所述预设字符串可以至少包括以下中的一者或多者:与参数传入方式有关的字符串、与参数所包含信息有关的字符串、与参数加密方式有关的字符串、与返回结果的格式有关的字符串、与错误码返回有关的字符串和与HTTP代码返回有关的字符串。
[°02°] 仍然以rest api接口为例。在统一的接口开发规范中可以规定，针对rest api接口所编写的接口源代码中的代码应当满足以下要求:
[0021].参数都以urlencode(统一资源定位符编码)传入
[0022].参数必须包含用户令牌信息
[0023].参数需要进行签名加密
[0024].返回结果的格式应该为“{errno: 10000,errmsg: ’ok’ ,data: ’...’}”
[0025].若返回错误码正常则为10000，否则为>10000
[0026].若返回的http code(http代码)正常则为2**，非法则为4**，5**等
[0027]……
[0028]以上列举的这些要求在接口开发规范中用相应的预设字符串进行定义，在所编写的接口源代码中也是用不同的字符串来标示的，因此通过扫描所编写的接口源代码就可实现接口源代码的自动白盒检查，以确认所编写的接口源代码是否符合接口开发规范的要求。
[0029]另外，本领域技术人员应当理解的是，由于对外服务接口的种类多种多样，因此以上仅是针对rest api接口列举了其中一些预设字符串而非穷举针对所有对外服务接口的所有预设字符串，而且所给出的预设字符串也仅是示例。
[0030]而且，由于与不同对外服务接口相关联的预设字符串的数量也可能是不同的，因此根据本发明的方法还能够实现白盒检查的可配置化，即在对相应的对外服务接口进行白盒检查时，能够为该对外服务接口配置相应的预设字符串。
[0031]步骤S3、若所述预设字符串存在于所获取的接口源代码中，则确认所获取的接口源代码符合接口开发规范。
[0032]至此，根据本发明的对接口源代码进行白盒检查的方法就实现了接口源代码的自动白盒检查，避免了传统人眼检查情况下有可能遗漏的情况，并提高了白盒检查的效率和准确率。
[0033]优选地，根据本发明的方法还可以包括:生成白盒检查报表。这样就便于后续对白盒检查结果进行查阅。
[0034]优选地，根据本发明的方法还可以包括:将所述白盒检查报表发送给相应的开发工程师。这样就便于相应的开发工程师依据白盒检查结果对接口源代码进行修改。例如，可以将白盒检查报表发送给相应开发工程师的邮箱。
[0035]在根据本发明的又一实施方式中，本发明还提供一种对接口源代码进行白盒检查的装置，如图2所示，该装置包括获取模块201和白盒检查模块202。获取模块201用于获取将进行白盒检查的接口源代码，白盒检查模块202则用于对获取模块201所获取的接口源代码进行扫描并判断所述接口源代码中是否存在预设字符串，若所述预设字符串存在于所述接口源代码中，则确认所述接口源代码符合接口开发规范。
[0036]其中，所述获取模块201可以通过以下方式来获取将进行白盒检查的接口源代码:确定将进行白盒检查的接口 ；获取针对所述接口编写的接口源代码的地址；以及从所述地址下载所述接口源代码。
[0037]以restapi接口为例。首先，确定需要进行白盒检查的对外服务接口是rest api接口；然后，获取针对rest api接口编写的接口源代码的地址，例如对外服务rest api接口的具体版本的svn(git)源码库地址;最后，从所获取的地址自动下载要进行白盒检查的接口源代码。其中，上面提到的SVN是Subvers1n(子版本)的简称，其是一个开放源代码的版本控制系统。SVN系统是本领域技术人员熟知的，此处不再赘述。
[0038]优选地，所述预设字符串可以至少包括以下中的一者或多者:与参数传入方式有关的字符串、与参数所包含信息有关的字符串、与参数加密方式有关的字符串、与返回结果的格式有关的字符串、与错误码返回有关的字符串和与HTTP代码返回有关的字符串。
[0039]仍然以rest api接口为例。在接口开发规范中可以规定，针对rest api接口所编写的接口源代码中的代码应当满足以下要求:
[0040].参数都以urIencode(统一资源定位符编码)传入
[0041]?参数必须包含用户令牌信息
[0042].参数需要进行签名加密
[0043].返回结果的格式应该为“{errno: 10000,errmsg: ’ok’ ,data: ’...’}”
[0044].若返回错误码正常则为10000，否则为>10000
[0045].若返回的http code(http代码)正常则为2**，非法则为4**，5**等
[0046]……
[0047]以上列举的这些要求在接口开发规范中用相应的预设字符串进行定义，在所编写的接口源代码中也是用不同的字符串来标示的，因此通过扫描所编写的接口源代码就可实现接口源代码的自动白盒检查，以确认所编写的接口源代码是否符合接口开发规范的要求。
[0048]另外，本领域技术人员应当理解的是，由于对外服务接口的种类多种多样，因此以上仅是针对rest api接口列举了其中一些预设字符串而非穷举针对所有对外服务接口的所有预设字符串，而且所给出的预设字符串也仅是示例。
[0049]而且，由于与不同对外服务接口相关联的预设字符串的数量也可能是不同的，因此根据本发明的装置还能够实现白盒检查的可配置化，即在对相应的对外服务接口进行白盒检查时，能够为该对外服务接口配置相应的预设字符串。
[0050]优选地，如图3所示，根据本发明的装置还可以包括报表生成模块203，用于生成白盒检查报表。这样就便于后续对白盒检查结果进行查阅。
[0051]优选地，如图3所示，根据本发明的装置还可以包括发送模块204，用于将所述白盒检查报表发送给相应的开发工程师。这样就便于相应的开发工程师依据白盒检查结果对接口源代码进行修改。例如，可以将白盒检查报表发送给相应开发工程师的邮箱。
[0052]以上结合附图详细描述了本发明的优选实施方式，但是，本发明并不限于上述实施方式中的具体细节，在本发明的技术构思范围内，可以对本发明的技术方案进行多种简单变型，这些简单变型均属于本发明的保护范围。
[0053]另外需要说明的是，在上述【具体实施方式】中所描述的各个具体技术特征，在不矛盾的情况下，可以通过任何合适的方式进行组合。为了避免不必要的重复，本发明对各种可能的组合方式不再另行说明。
[0054]此外，本发明的各种不同的实施方式之间也可以进行任意组合，只要其不违背本发明的思想，其同样应当视为本发明所公开的内容。
【主权项】
1.一种对接口源代码进行白盒检查的方法，该方法包括: 获取将进行白盒检查的接口源代码； 对所述接口源代码进行扫描并判断所述接口源代码中是否存在预设字符串；以及 若所述预设字符串存在于所述接口源代码中，则确认所述接口源代码符合接口开发规范。2.根据权利要求1所述的方法，其中，将进行白盒检查的接口源代码通过以下步骤获取: 确定将进行白盒检查的接口； 获取针对所述接口编写的接口源代码的地址；以及 从所述地址下载所述接口源代码。3.根据权利要求1所述的方法，其中，所述预设字符串至少包括以下中的一者或多者:与参数传入方式有关的字符串、与参数所包含信息有关的字符串、与参数加密方式有关的字符串、与返回结果的格式有关的字符串、与错误码返回有关的字符串和与HTTP代码返回有关的字符串。4.根据权利要求1所述的方法，该方法还包括:生成白盒检查报表。5.根据权利要求4所述的方法，该方法还包括:将所述白盒检查报表发送给相应的开发工程师。6.一种对接口源代码进行白盒检查的装置，该装置包括: 获取模块，用于获取将进行白盒检查的接口源代码；以及 白盒检查模块，用于对所述接口源代码进行扫描并判断所述接口源代码中是否存在预设字符串，若所述预设字符串存在于所述接口源代码中，则确认所述接口源代码符合接口开发规范。7.根据权利要求6所述的装置，其中，所述获取模块通过以下方式来获取将进行白盒检查的接口源代码:确定将进行白盒检查的接口 ；获取针对所述接口编写的接口源代码的地址；以及从所述地址下载所述接口源代码。8.根据权利要求6所述的装置，其中，所述预设字符串至少包括以下中的一者或多者:与参数传入方式有关的字符串、与参数所包含信息有关的字符串、与参数加密方式有关的字符串、与返回结果的格式有关的字符串、与错误码返回有关的字符串和与HTTP代码返回有关的字符串。9.根据权利要求6所述的装置，该装置还包括报表生成模块，用于生成白盒检查报表。10.根据权利要求9所述的装置，该装置还包括发送模块，用于将所述白盒检查报表发送给相应的开发工程师。
【文档编号】G06F11/28GK105893204SQ201510925302
【公开日】2016年8月24日
【申请日】2015年12月10日
【发明人】彭亮, 杜熙
【申请人】乐视致新电子科技（天津）有限公司