CN107678957A - 一种网银代码自动化检查方法及装置 - Google Patents

Abstract

本发明提供了一种网银代码自动化检查方法及装置，所述方法包括：从网银代码的开发规范、设计规范及生产缺陷中提取目标规范语句；其中，所述目标规范语句包括具强制性命令的规范语句、建议性的规范语句、具因果推论关系的规范语句中的至少一种；获取所述目标规范语句中的条件变量和/或逻辑变量以生成检查规则；接收用户输入的待检代码，所述待检代码包括java代码、xml代码、sql代码、sh代码中的至少一种；获取待检代码中所含的条件变量和/或处理逻辑，判断所述待检代码中的条件变量和/或处理逻辑是否与所述检查规则中对应的条件变量和/或处理逻辑一致；如不一致，将与检查规则不一致的待检代码中的条件变量和/或处理逻辑进行记录并报警。

Description

一种网银代码自动化检查方法及装置

技术领域

本发明涉及代码开发技术领域，尤其涉及一种网银代码自动化检查方法及装置。

背景技术

随着软件产品功能的不断丰富，设计要点和开发规范越来越多，同时，新人和外援的加入，导致编码规范的学习成本提升，代码和规范检查的成本也相应增高。而人工进行代码走查凭借经验，存在遗漏风险，往往需要高职级、有经验的老员工才能发现较深层次的问题，但有经验的老员工时间也有限，不可能参加所有任务的走查。并且，现有代码检查技术主要是以人工检查为主，依赖检查人员的经验、走查效率低下，且容易出现遗漏。

为解决上述问题，帮助新人和外援快速掌握编码规范、降低代码开发难度，提高代码复查的效率，降低遗漏风险，有必要开发出一种新的代码检查方案。

发明内容

为解决上述技术问题，本发明实施例提供了一种网银代码自动化检查方法及装置。

一方面，本发明实施例提供了一种网银代码自动化检查方法，所述方法包括：

从网银代码的开发规范、设计规范及生产缺陷中提取目标规范语句；其中，所述目标规范语句包括具强制性命令的规范语句、建议性的规范语句、具因果推论关系的规范语句中的至少一种；

获取所述目标规范语句中的条件变量和/或逻辑变量以生成检查规则；

接收用户输入的待检代码，所述待检代码包括java代码、xml代码、sql代码、sh代码中的至少一种；

获取待检代码中所含的条件变量和/或处理逻辑，判断所述待检代码中的条件变量和/或处理逻辑是否与所述检查规则中对应的条件变量和/或处理逻辑一致；

如不一致，将与检查规则不一致的待检代码中的条件变量和/或处理逻辑进行记录并报警。

在一个实施例中，所述条件变量包括目标规范语句中的名词，所述逻辑变量包括目标规范语句中的处理逻辑。

在一个实施例中，所述开发规范及设计规范包括：命名规范、声明规范、注释规范、常量规范、bean定义规范、事务规范、脚本规范、日志规范、异常处理规范及Junit规范中的至少一种。

在一个实施例中，获取所述目标规范语句中的条件变量和/或逻辑变量以生成检查规则，包括：

根据所述目标规范语句的适用场景、前提条件及违反后的影响及规范种类，将所述目标规范语句中的条件变量和/或逻辑变量作为判断标准，生成检查规则；

其中，所述规范种类包括错误类规范、警告类规范及提示类规范，优先级依次降低。

在一个实施例中，所记录的内容包括：检查路径、待检代码名称、出错行数、错误描述中的至少一种。

另一方面，本发明实施例还提供了一种网银代码自动化检查装置，所述装置包括：

提取单元，用于从网银代码的开发规范、设计规范及生产缺陷中提取目标规范语句；其中，所述目标规范语句包括具强制性命令的规范语句、建议性的规范语句、具因果推论关系的规范语句中的至少一种；

检查规则生成单元，用于获取所述目标规范语句中的条件变量和/或逻辑变量以生成检查规则；

UI单元，用于接收用户输入的待检代码，所述待检代码包括java代码、xml代码、sql代码、sh代码中的至少一种；

代码检查单元，用于获取待检代码中所含的条件变量和/或处理逻辑，判断所述待检代码中的条件变量和/或处理逻辑是否与所述检查规则中对应的条件变量和/或处理逻辑一致；

报警记录单元，用于当所述待检代码中的条件变量和/或处理逻辑是否与所述检查规则中对应的条件变量和/或处理逻辑不一致时，将与检查规则不一致的待检代码中的条件变量和/或处理逻辑进行记录并报警。

在一个实施例中，所述条件变量包括目标规范语句中的名词，所述逻辑变量包括目标规范语句中的处理逻辑。

在一个实施例中，所述开发规范及设计规范包括：命名规范、声明规范、注释规范、常量规范、bean定义规范、事务规范、脚本规范、日志规范、异常处理规范及Junit规范中的至少一种。

在一个实施例中，检查规则生成单元具体用于：

根据所述目标规范语句的适用场景、前提条件及违反后的影响及规范种类，将所述目标规范语句中的条件变量和/或逻辑变量作为判断标准，生成检查规则；

其中，所述规范种类包括错误类规范、警告类规范及提示类规范，优先级依次降低。

在一个实施例中，所记录的内容包括：检查路径、待检代码名称、出错行数、错误描述中的至少一种。

本发明实施例为网银代码开发设计规范的执行和检查起到监督作用，同时降低编码成本；提升了开发效率，将原来检查效率由1000行代码/人时提高到2小时跑完整个批次的代码；并且，利用本发明实施例对网银代码进行检查，使网银产品的质量得到显著提升。

附图说明

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

图1为本发明实施例提供的网银代码自动化检查方法的流程示意图；

图2为本发明实施例提供的网银代码自动化检查装置的结构示意图；

图3为本发明实施例提供的选择工程项目的对话框示意图；

图4为本发明实施例提供的在侧边栏进行标记的示意图；

图5为本发明实施例提供的在标记组件面板中进行标记的示意图；

图6为本发明实施例提供的在控制台中进行标记的示意图。

具体实施方式

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

在代码开发完毕、进行测试之前，通常需要人工对代码进行规范检查，人工检查时全凭经验，存在遗漏风险。因此，为了提高代码复查效率，降低遗漏风险，本发明实施例提供了一种代码自动化检查的方法及装置，具体如下面实施例所述。

图1为本发明实施例提供的一种代码自动化检查方法的流程示意图，如图1所示，该方法主要包括以下步骤：

步骤101，从网银代码的开发规范、设计规范及生产缺陷中提取目标规范语句。其中，所述目标规范语句包括具强制性命令的规范语句、建议性的规范语句、具因果推论关系的规范语句。

在提取目标规范语句时，可以按照某一语句中是否存在一些特定词汇来判断当前语句是否为欲提取的规范语句(即，目标规范语句)，关于不同种类的规范语句，特定词汇的选取存在差别，具体如下面内容所述。

例如，具强制性命令的规范语句是指包含必须、禁止、不能、避免、务必等词汇的规范语句，此类规范要求必须严格遵循和执行，一旦违反这种规范，将导致运行该代码的程序发生重大问题，因此在检查上具有最高优先级。

建议性规范语句是指存在推荐、建议或者不推荐、不建议含义规范语句，例如包含需要、建议、推荐等词汇的语句，包含此类词汇的规范语句要求代表了最佳实践、最佳用法，如果被检代码违反了此类规范要求，不会对程序和系统造成功能性问题，但可能会有非功能性缺陷，在代码性能、运维、高可用、客户体验或者其他方面可能会造成不便。

具有明确的因果推论关系的规范语句是指包含例如“当…则…”、“如果…那么…”等及其他类似词语的规范语句，包含此类词汇的语句代表了设定了一定的因果关系，如果代码违反了此类规范要求，不会对程序和运行该程序的系统造成功能性影响，但可能会降低执行效率。比如：for循环一般不建议超过3层深度，如果超过4层，功能上可能没有影响，但从性能角度，可能会导致执行效率下降等问题。又比如：数据库连接的使用，连接在使用完成后必须在finnaly中关闭ResultSet、Statement、Connection对对象的引用，否则可能造成资源无法释放，极端情况是导致资源耗尽。还有各种文件流、Socket流，在读写完成后，必须把InputStream和outputStream关闭，否则会导致资源不能及时释放。

步骤102，获取所述目标规范语句中的条件变量和/或逻辑变量以生成检查规则。

在一个实施例中，上述的条件变量包括目标规范语句中的名词，逻辑变量包括目标规范语句中的处理逻辑。对所提取的目标规范语句进行分析时，可以将该规范语句中所包含的名词对应到程序的条件变量中，将其包含的动词对应到程序的处理逻辑中，例如条件判断，循环等。

例如：

规则：数据库连接池persistence.xml中，maxIdle的值和maxActive的值要相等。

我们可以提取出一下词汇：

动词：相等

名词1：persistence.xml

名词2：maxIdle的值

名词3：maxAcitve的值

这样我们的规则就是：

1、根据文件名“persistence.xml”找到文件

2、获取maxIdle的值

3、获取maxActive的值

4、进行判断：if(maxIdle！＝maxActive)

5、抛出异常，记录日志等动作

步骤103，接收用户输入的待检代码。所述待检代码包括java代码、xml代码、sql代码、sh代码中的至少一种。

步骤104，获取待检代码中所含的条件变量和/或处理逻辑，判断所述待检代码中的条件变量和/或处理逻辑是否与所述检查规则中对应的条件变量和/或处理逻辑一致。

在接收到待检代码后，扫描包括java、xml、sql、sh等所有可以执行和编译的代码，判断是否有违反检查规则之处，只有当待检代码中所有的条件变量、处理逻辑分别与检查规则中对应的条件变量、处理逻辑分别一致，才可判定待检代码符合网银代码的开发规范及设计规范，不存在生产缺陷，结束检查(步骤106)。

步骤105，如不一致，将与检查规则不一致的待检代码中的条件变量和/或处理逻辑进行记录并报警。

本发明实施例为网银代码开发设计规范的执行和检查起到监督作用，同时降低编码成本；提升了开发效率，将原来检查效率由1000行代码/人时提高到2小时跑完整个批次的代码；并且，利用本发明实施例对网银代码进行检查，使网银产品的质量得到显著提升。

在一个实施例中，上述的开发规范、设计规范包括：命名规范、声明规范、注释规范、常量规范、bean定义规范、事务规范、脚本规范、日志规范、异常处理规范及Junit规范中的至少一种。

在利用步骤101及步骤102生成检查规则后，如当前未更新生产设计规范，也未产生新的生产缺陷，检查规则可以多次重复使用。如果随着技术的发展，逐渐提出新的生产设计规范，产生了新的生产缺陷，可以根据这些新产生的生产设计规范、生产缺陷更新检查规则，以对网银代码进行更为全面的检查。

在一个实施例中，在获取目标规范语句后，生成检查规则时，通常需要明确以下内容：该规范适用的场景、使用的前提条件、违反该规范后的影响、是否可以规则化、规范种类等关键内容，在明确以上内容后，将目标规范语句中的条件变量和/或逻辑变量作为判断标准，生成检查规则。其中，上述规范种类包括错误类规范、警告类规范及提示类规范，此三种规范的优先级依次降低。具体实施时，通常将具强制性命令的规范语句划分为错误类规范，将建议性的规范语句划分为警告类规范，并将具因果推论关系的规范语句划分为提示类规范。

在一个实施例中，当待检代码中的条件变量和/或处理逻辑是否与上述检查规则中对应的条件变量和/或处理逻辑不一致时，需要将与检查规则不一致的待检代码中的条件变量和/或处理逻辑进行记录并报警，所记录的内容至少包括检查路径、待检代码名称、出错行数、错误描述中的一种或几种，以便于开发人员查看。

本发明实施例为网银代码开发设计规范的执行和检查起到监督作用，同时降低编码成本；提升了开发效率，将原来检查效率由1000行代码/人时提高到2小时跑完整个批次的代码；并且，利用本发明实施例对网银代码进行检查，使网银产品的质量得到显著提升。利用本发明实施例，解决了网银代码人工检查效率低下、容易遗漏的问题，同时提高了网银产品的质量。

基于与图1所示网银代码自动化检查方法相同的发明构思，本发明实施例还提供一种网银代码自动化检查装置，如下面实施例所示。由于该装置解决问题的原理与图1中网银代码自动化检查方法相似，因此该设备的实施可以参见图1网银代码自动化检查方法的实施，重复之处不再赘述。

在另一实施例中，本发明还提供了一种银代码自动化检查装置，该装置结构示意图如2所示，其主要包括：提取单元201、检查规则生成单元202、UI(用户界面)单元203、代码检查单元204及报警记录单元205。

其中，提取单元201用于从网银代码的开发规范、设计规范及生产缺陷中提取目标规范语句；其中，所述目标规范语句包括具强制性命令的规范语句、建议性的规范语句、具因果推论关系的规范语句中的至少一种。

检查规则生成单元202用于获取所述目标规范语句中的条件变量和/或逻辑变量以生成检查规则。

UI单元203用于接收用户输入的待检代码，所述待检代码包括java代码、xml代码、sql代码、sh代码中的至少一种。

代码检查单元204用于获取待检代码中所含的条件变量和/或处理逻辑，判断所述待检代码中的条件变量和/或处理逻辑是否与所述检查规则中对应的条件变量和/或处理逻辑一致。

报警记录单元205用于当所述待检代码中的条件变量和/或处理逻辑是否与所述检查规则中对应的条件变量和/或处理逻辑不一致时，将与检查规则不一致的待检代码中的条件变量和/或处理逻辑进行记录并报警。

在一个实施例中，所述条件变量包括目标规范语句中的名词，所述逻辑变量包括目标规范语句中的处理逻辑。

在一个实施例中，所述开发规范及设计规范包括：命名规范、声明规范、注释规范、常量规范、bean定义规范、事务规范、脚本规范、日志规范、异常处理规范及Junit规范中的至少一种。

在一个实施例中，检查规则生成单元202具体用于根据所述目标规范语句的适用场景、前提条件及违反后的影响及规范种类，将所述目标规范语句中的条件变量和/或逻辑变量作为判断标准，以生成检查规则。其中，所述规范种类包括错误类规范、警告类规范及提示类规范，优先级依次降低。

在一个实施例中，报警记录单元205所记录的内容包括：检查路径、待检代码名称、出错行数、错误描述中的至少一种。

利用本发明实施例提供的网银代码自动化检查方法，可以将上述装置设计成一可安装在终端上使用的APP应用，也可以设计成一Eclipse插件，以对网银产品的相关待检代码进行检查。为更好地对本发明技术方案进行说明，本发明实施例根据网银产品的代码特点及开发设计规范，将上述的网银代码自动化检查装置设计成一Eclipse插件。具体设计时，使用menu Action(菜单动作)在Eclipse的一级菜单上进行插件扩展；然后通过dialog(对话框组件)进行工程选择，支持单选和多选；使用progress(进度控制条)优化客户体验，使用marker(标记组件)进行检查结果的标记；通过编程控制，对于编程规范中不建议使用但不会报错的规范标记为warning(警告)类规范，对于编程规范中明确禁止的规范标记为error(错误)类规范，对于编程规范中具有因果推论关系的规范标记为info(提示)类规范；使用console(控制台)记录日志，记录内容包括检查时间、检查的程序路径及名称、出错行数及具体的错误等。

具体实施时，用户通过Eclipse的用户界面(包含菜单、按钮、选择对话框等)选择检查代码的范围及检查的一些选项等，例如，如用户想对某一工程项目中进行检查，需要先选中待检的工程项目、源码范围、检查方式、检查的条件参数等。如用户欲对AutoHandler中的代码进行检查，需要先选中AutoHandler这一工程项目，选择对话框可参见图3。在确定代码检查范围后，代码自动化检查插件根据用户选择的工程项目，扫描待检工程项目中的代码，结合预设的检查规则根据判断代码是否满足检查规则，检查完毕后进行提示和响应。

提示内容包括代码的标记等，可以通过标记组件提醒，以提示开发者被检代码发生了warning或者error问题，并提示开发者控制台是否输出了日志等。响应的方式包括以下几种：在IDE中对应错误代码行的侧边栏进行标记(如图4所示示例)；或者在maker面板(marker的汇总信息)中显示，显示内容大体上包括错误描述、文件名、路径、代码行、类型，详情参考图5；或者在控制台中打印错误代码的路径和行数，参考图6所示内容。

在利用本发明实施例对代码进行检查时，重点是走查阶段(开发完成，测试之前的阶段)。传统的代码走查采取集中式的人工走查方式为：召集开发人员、走查人员等在会议室里进行代码走查。这种方式耗时耗力，而且效果很差。使用本发明的走查方式为：1)选择走查的机器。直接在开发人员的本地电脑或者小组的专用走查电脑；2)从版本控制服务器上下载需要走查的代码(可以是批次的所有代码，也可以是选取部分关心的代码)；3)运行自动化代码检查工具(即上述的代码检测插件)；4)查看检查结果。

利用本发明实施例提供的技术方案，为网银代码的开发设计规范的执行和检查起到监督作用，同时降低编码成本；融入工程活动的各阶段，形成了“开发阶段自查-功能测试团队走查—投产前部门抽查”三级检查体系；开发效率提升，将代码检查效率由原来的1000行代码/人时提高到2小时跑完整个批次的代码，初步估算，每批次节省代码复查工作量约200人天，批次产能提高约15％；显著提升了网银产品的质量，自各批次应用以来，同类问题bug率降为0、行锁、^M等问题不再发生。

本领域内的技术人员应明白，本发明的实施例可提供为方法、系统、或计算机程序产品。因此，本发明可采用完全硬件实施例、完全软件实施例、或结合软件和硬件方面的实施例的形式。而且，本发明可采用在一个或多个其中包含有计算机可用程序代码的计算机可用存储介质(包括但不限于磁盘存储器、CD-ROM、光学存储器等)上实施的计算机程序产品的形式。

本发明是参照根据本发明实施例的方法、设备(系统)、和计算机程序产品的流程图和/或方框图来描述的。应理解可由计算机程序指令实现流程图和/或方框图中的每一流程和/或方框、以及流程图和/或方框图中的流程和/或方框的结合。可提供这些计算机程序指令到通用计算机、专用计算机、嵌入式处理机或其他可编程数据处理设备的处理器以产生一个机器，使得通过计算机或其他可编程数据处理设备的处理器执行的指令产生用于实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能的装置。

这些计算机程序指令也可存储在能引导计算机或其他可编程数据处理设备以特定方式工作的计算机可读存储器中，使得存储在该计算机可读存储器中的指令产生包括指令装置的制造品，该指令装置实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能。

这些计算机程序指令也可装载到计算机或其他可编程数据处理设备上，使得在计算机或其他可编程设备上执行一系列操作步骤以产生计算机实现的处理，从而在计算机或其他可编程设备上执行的指令提供用于实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能的步骤。

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

Claims (10)

1.一种网银代码自动化检查方法，其特征在于，所述方法包括：

从网银代码的开发规范、设计规范及生产缺陷中提取目标规范语句；其中，所述目标规范语句包括具强制性命令的规范语句、建议性的规范语句、具因果推论关系的规范语句中的至少一种；

获取所述目标规范语句中的条件变量和/或逻辑变量以生成检查规则；

接收用户输入的待检代码，所述待检代码包括java代码、xml代码、sql代码、sh代码中的至少一种；

获取待检代码中所含的条件变量和/或处理逻辑，判断所述待检代码中的条件变量和/或处理逻辑是否与所述检查规则中对应的条件变量和/或处理逻辑一致；

如不一致，将与检查规则不一致的待检代码中的条件变量和/或处理逻辑进行记录并报警。

2.根据权利要求1所述的网银代码自动化检查方法，其特征在于，所述条件变量包括目标规范语句中的名词，所述逻辑变量包括目标规范语句中的处理逻辑。

3.根据权利要求1所述的网银代码自动化检查方法，其特征在于，所述开发规范及设计规范包括：命名规范、声明规范、注释规范、常量规范、bean定义规范、事务规范、脚本规范、日志规范、异常处理规范及Junit规范中的至少一种。

4.根据权利要求1所述的网银代码自动化检查方法，其特征在于，获取所述目标规范语句中的条件变量和/或逻辑变量以生成检查规则，包括：

根据所述目标规范语句的适用场景、前提条件及违反后的影响及规范种类，将所述目标规范语句中的条件变量和/或逻辑变量作为判断标准，生成检查规则；

其中，所述规范种类包括错误类规范、警告类规范及提示类规范，优先级依次降低。

5.根据权利要求4所述的网银代码自动化检查方法，其特征在于，所记录的内容包括：检查路径、待检代码名称、出错行数、错误描述中的至少一种。

6.一种网银代码自动化检查装置，其特征在于，所述装置包括：

提取单元，用于从网银代码的开发规范、设计规范及生产缺陷中提取目标规范语句；其中，所述目标规范语句包括具强制性命令的规范语句、建议性的规范语句、具因果推论关系的规范语句中的至少一种；

检查规则生成单元，用于获取所述目标规范语句中的条件变量和/或逻辑变量以生成检查规则；

UI单元，用于接收用户输入的待检代码，所述待检代码包括java代码、xml代码、sql代码、sh代码中的至少一种；

代码检查单元，用于获取待检代码中所含的条件变量和/或处理逻辑，判断所述待检代码中的条件变量和/或处理逻辑是否与所述检查规则中对应的条件变量和/或处理逻辑一致；

报警记录单元，用于当所述待检代码中的条件变量和/或处理逻辑是否与所述检查规则中对应的条件变量和/或处理逻辑不一致时，将与检查规则不一致的待检代码中的条件变量和/或处理逻辑进行记录并报警。

7.根据权利要求6所述的网银代码自动化检查装置，其特征在于，所述条件变量包括目标规范语句中的名词，所述逻辑变量包括目标规范语句中的处理逻辑。

8.根据权利要求6所述的网银代码自动化检查装置，其特征在于，所述开发规范及设计规范包括：命名规范、声明规范、注释规范、常量规范、bean定义规范、事务规范、脚本规范、日志规范、异常处理规范及Junit规范中的至少一种。

9.根据权利要求6所述的网银代码自动化检查装置，其特征在于，检查规则生成单元具体用于：

根据所述目标规范语句的适用场景、前提条件及违反后的影响及规范种类，将所述目标规范语句中的条件变量和/或逻辑变量作为判断标准，生成检查规则；

其中，所述规范种类包括错误类规范、警告类规范及提示类规范，优先级依次降低。

10.根据权利要求9所述的网银代码自动化检查装置，其特征在于，所记录的内容包括：检查路径、待检代码名称、出错行数、错误描述中的至少一种。