CN104572451A - 一种代码效率检查方法及系统 - Google Patents

Abstract

本发明公开一种代码效率检查方法及系统，方法包括：获取一个未检查的代码文件作为当前代码文件，将所述代码文件的第一条代码作为当前代码；对当前代码进行检查：如果当前代码为循环段落的起始标识，则向预设队列中加入循环标识；如果当前代码满足预设的效率规则，且所述队列中还保存有循环标识，则进行告警记录；如果当前代码为循环段落的结束标识，则从所述队列中移除循环标识；如果所述代码文件还有下一条代码，则将下一条代码作为当前代码，否则将所述当前代码文件设为已检查的代码文件，如果还有未检查的代码文件，则获取代码文件，否则结束。本发明能够通过扫描代码，从中找出严重影响效率的代码。

Description

一种代码效率检查方法及系统

技术领域

本发明涉及代码检查相关技术领域，特别是一种代码效率检查方法及系统。

背景技术

现有的大型的电商平台，并发量非常大，所以对代码质量和效率要求很高。对代码进行检查的可以采用代码检查工具，例如：PMD、checkstyle、jalopy等。它们的共同特点如下为对代码的以下情况进行检查，包括：代码规范、空的catch块、未使用参数、空if语句、重复的import语句、未使用的私有方法、Import语句、体积大小、空白、修饰符。

然而，现有的代码检查工具，其只是对代码和语法方面做了严格的检查，但是对于偏向代码的效率并未能进行检查，即现有技术未能检查代码中是否有影响效率的地方。

发明内容

基于此，有必要针对现有技术未能对代码中是否有影响效率的地方进行检查的技术问题，提供一种代码效率检查方法及系统。

一种代码效率检查方法，包括：

代码文件获取步骤，包括：获取一个未检查的代码文件作为当前代码文件，所述代码文件包括至少一条代码，将所述代码文件的第一条代码作为当前代码，执行代码检查步骤；

代码检查步骤，包括：对当前代码进行检查：如果当前代码为循环段落的起始标识，则向预设队列中加入循环标识，执行代码结束判断步骤；如果当前代码满足预设的效率规则，且所述队列中还保存有循环标识，则进行告警记录，执行代码结束判断步骤；如果当前代码为循环段落的结束标识，则从所述队列中移除循环标识，执行代码结束判断步骤；

代码结束判断步骤，包括：如果所述代码文件还有下一条代码，则将下一条代码作为当前代码，执行代码检查步骤，否则执行工程结束判断步骤；

工程结束判断步骤，包括：将所述当前代码文件设为已检查的代码文件，如果还有未检查的代码文件，则执行获取代码文件获取步骤，否则结束。

一种代码效率检查系统，包括：

代码文件获取模块，用于：获取一个未检查的代码文件作为当前代码文件，所述代码文件包括至少一条代码，将所述代码文件的第一条代码作为当前代码，执行代码检查模块；

代码检查模块，用于：对当前代码进行检查：如果当前代码为循环段落的起始标识，则向预设队列中加入循环标识，执行代码结束判断模块；如果当前代码满足预设的效率规则，且所述队列中还保存有循环标识，则进行告警记录，执行代码结束判断模块；如果当前代码为循环段落的结束标识，则从所述队列中移除循环标识，执行代码结束判断模块；

代码结束判断模块，用于：如果所述代码文件还有下一条代码，则将下一条代码作为当前代码，执行代码检查模块，否则执行工程结束判断模块；

工程结束判断模块，用于：将所述当前代码文件设为已检查的代码文件，如果还有未检查的代码文件，则执行获取代码文件获取模块，否则结束。

本发明通过对循环段落的起始标识和结束标识进行判断，确定循环段落所包括的代码，如果循环段落所包括的代码中存在有满足预设的效率规则的代码，则进行告警操作。由于循环段落需要对代码进行多次循环，在循环段落中出现足预设的效率规则的代码，会大大影响代码效率。本发明能够通过扫描代码，从中找出严重影响效率的代码。

附图说明

图1为本发明一种代码效率检查方法的工作流程图；

图2为本发明最佳实施例的工作流程图；

图3为本发明最佳实施例的SRB检查模块工作流程图；

图4为本发明一种代码效率检查系统的结构模块图。

具体实施方式

下面结合附图和具体实施例对本发明做进一步详细的说明。

如图1所述为本发明一种代码效率检查方法的工作流程图，包括：

步骤S101，包括：获取一个未检查的代码文件作为当前代码文件，所述代码文件包括至少一条代码，将所述代码文件的第一条代码作为当前代码，执行步骤S102；

步骤S102，包括：对当前代码进行检查：如果当前代码为循环段落的起始标识，则向预设队列中加入循环标识，执行步骤S103；如果当前代码满足预设的效率规则，且所述队列中还保存有循环标识，则进行告警记录，执行步骤S103；如果当前代码为循环段落的结束标识，则从所述队列中移除循环标识，执行步骤S103；

步骤S103，包括：如果所述代码文件还有下一条代码，则将下一条代码作为当前代码，执行步骤S102，否则执行步骤S104；

步骤S104，包括：将所述当前代码文件设为已检查的代码文件，如果还有未检查的代码文件，则执行获取步骤S101，否则结束。

循环段落的起始标识对于c语言或java语言可以包括：for或while等标识。循环段落的结束标识则一般为符号“}”。对于其他编程语言可以采用其他标识。

预设的效率规则可以通过配置文件进行描述。效率规则指的是代码为各种容易影响系统效率的操作，包括各种需要较长时间完成的操作，例如各种I/O读写操作或者与远程系统通信等。效率规则可以由用户通过配置文件预先设置。由于循环段落会多次执行其所包括的代码所指定的操作，因此，如果在循环段落内的操作是需要较长时间完成的，则会大大影响系统的效率。本发明通过识别循环段落，并判断循环段落中是否包括有需要长时间执行的代码，从而判断该代码的效率。

其中，步骤S102中的队列，可以是FIFO(FIFO先进先出)形式的队列，也可是堆栈形式的队列。一般较为常用的是堆栈形式的队列。如果当前代码为循环段落的起始标识，则向堆栈中压入循环标识，如果当前代码为循环段落的结束标识，则从堆栈中移除循环标识。循环标识可以是一个标记、字母或符号等。优选地可以直接将起始标识作为循环标识，例如对于java语言，则可以将for或者while作为循环标识。如果是多重循环嵌套，则只有在最外层的循环结束时，队列中才会不存在循环标识。

在其中一个实施例中，还包括：

初始化步骤，包括：初始化统计参数；

告警步骤，包括：当所述统计参数超过预设告警阈值则进行告警操作；

所述步骤S102中，所述告警记录包括对所述统计参数加一。

本实施例，当对影响系统效率的代码进行高频调用时，进行告警操作。告警操作可以为通过声光告警器进行告警，或者是通过屏幕闪烁或者显示提示操作等方式进行告警。

优选地，所述效率规则为：

所述代码为预设的数据库操作语句；或者

所述代码为预设的远程过程调用语句；或者

所述代码为预设的事务操作启动语句，且在预设的事务操作启动语句和预设的事务操作结束语句之间包括超过预设操作阈值数量的事务操作语句。

数据库操作语句，例如结构化查询语言(Structured QueryLanguage，SQL)，由于涉及到I/O读写操作容易影响系统效率，而远程过程调用语句(RPC)则由于涉及到远程过程调用，由于网络不稳定或者远端系统不稳定等情况，通常会设置较为长的等待时间，从而导致影响系统效率。

事务操作会在事务操作语句结束后，将事务操作启动语句和事务操作结束语句之间的事务操作统一提交进行处理，当事务操作启动语句和事务操作结束语句之间的事务操作数量较多时，即成为大事务(bigtransaction)，也非常容易影响系统效率。其中，事务操作可以是数据库操作。

对于哪些数据库操作语句或者那些远程过程调用语句要进行检查，其由用户根据所采用的数据库或者所调用的远程系统的不同自行决定。

在其中一个实施例中，所述步骤S102，还包括：

如果所述代码为非系统或非第三方的函数调用，或者所述代码为非系统或非第三方的类方法，则执行调用检查步骤；

调用检查步骤包括：

调用文件获取子步骤，包括：获取所述函数调用或所述类方法的代码文件作为调用文件，所述调用文件包括至少一条代码，将所述调用文件的第一条代码作为调用代码，执行调用代码检查子步骤；

调用代码检查子步骤，包括：对调用代码进行检查：如果调用代码为循环段落的起始标识，则向预设队列中加入循环标识，执行调用代码结束判断子步骤；如果调用代码满足预设的效率规则，且所述队列中还保存有循环标识，则进行告警记录，执行调用代码结束判断子步骤；如果调用代码为循环段落的结束标识，则从所述队列中移除循环标识，执行调用代码结束判断子步骤；

调用代码结束判断子步骤，包括：如果所述调用文件还有下一条代码，则将下一条代码作为调用代码，执行调用代码检查子步骤，否则退出所述调用文件，执行步骤S103。

对于系统的函数调用或者类方法，以及第三方的函数调用或者类方法，其代码效率，一般由系统或者第三方负责，因此本实施例仅对非系统或非第三方的函数调用，或者所述代码为非系统或非第三方的类方法进行代码效率检查。

代码是否是非系统、非第三方的函数调用或其它类的方法，一个简单的判断标准是该函数调用文件或者类文件是否在本工程中，若不在，则表明是系统的，或者是第三方的，否则就是自行编写的函数调用或者类方法。

在其中一个实施例中，所述步骤S102，还包括：

当向预设队列加入循环标识时，将所述循环段落的起始标识所在的文件名、路径和/或行号与所述循环标识关联保存，并初始化统计参数；

所述告警记录包括：获取最新加入队列的循环标识所关联的所述循环段落的起始标识所在的文件名、路径和/或行号作为循环参数，将所述统计参数加一，并向预设的告警文件中写入所述统计参数和所述循环参数。

将文件名、路径和/或行号与所述循环标识关联保存，则能够在告警文件中也同时显示或提示是在哪个文件的循环段落出现对影响系统效率的代码的高频调用。

如图2所示为本发明最佳实施例的工作流程图，包括：

步骤S201，读取规则配置文件，这个配置文件包含的是要检查的各种规则。如对数据库操作进行检查，例如sql操作，会检查其中是否有继承于BaseDao；对大事务(Big Transaction)检查，会检查是否有Transaction的注解、或含有继承于transaction的类等。

步骤S202，进入要检查的指定目录，for循环遍历其中的每个文件。

步骤S203，打开文件，检查代码；

步骤S204，先判断是否遇到诸如for、while之类的关键词，若是执行步骤S205，否则执行步骤S206；

步骤S205，先把for、while压入队列，同时记下该for、while所在的文件名、路径及行号，便于未来提示是在哪个文件的for可能出现高频调用，继续检查下面的语句；

步骤S206，如果队列中有for或while，则执行步骤S207，否则执行步骤S204；

步骤S207，判断该语句是否是非系统、非第三方的函数调用或其它类的方法。对于函数调用或者类方法，一个简单的判断是该类文件是否在本工程中，若不在，则表明是系统的，或者是第三方的，若是非系统、非第三方的，则调用SRB检查模块，进入函数或类方法中进行检查，具体流程见图3的“SRB检查模块工作流程图”，然后执行步骤S208，对于其他调用，执行步骤S209；

步骤S208，从SRB模块返回，执行步骤S211；

步骤S209，根据规则库，判断该语句是否是数据库sql操作、或者是远程rpc调用，若是，则记入告警文件中，执行步骤S211，若否，执行步骤S210；

步骤S210，判断该语句是否是transcation(事务操作)，若是，还需要往下检查在commit之前有多少个事务操作，是否超过指定的数量，若是，则判定为大事物，记入告警文件中，执行步骤S211；

步骤S211，是否该for、while循环结束？若是未结束则继续检查for、while的下一行代码，执行步骤S204，若是循环结束，则执行步骤S212；

步骤S212，退出该循环检查，同时从上面的for队列出移除该for标记；

步骤S213，判断是否检查完该文件；若是完成，则执行步骤S214，否则执行步骤S203继续下一行代码的检查；

步骤S214，判断整个工程检查完毕，如果是则结束，否则执行步骤S202选择下一个文件。

如图3所示为本发明最佳实施例的SRB检查模块工作流程图，SRB是sql、rpc、bigtransaction的首字母缩写，具体包括：

步骤S301，检查每行代码；

步骤S302，根据规则库，判断该语句是否是数据库sql操作、或者是远程rpc调用，若是，则记入告警文件中，执行步骤S305，若否，执行步骤S303；

步骤S303，判断该语句是否是transcation(事务操作)，若是，还需要往下检查在commit之前有多少个事务操作，如果超过指定的数量，则判定为大事务，记入告警文件中，执行步骤S305，若不是事务操作或者不是大事务，在执行步骤S304；

步骤S304，若是还遇到函数、或类方法，则递归调用SRB模块；

步骤S305，是否到了该函数或类方法末尾，若是，则退出该函数或类方法，返回上面调用SRB模块的下一行代码，否则执行步骤S301继续检查下一行代码。

如图4所示为本发明一种代码效率检查系统的结构模块图，包括：

代码文件获取模块401，用于：获取一个未检查的代码文件作为当前代码文件，所述代码文件包括至少一条代码，将所述代码文件的第一条代码作为当前代码，执行代码检查模块402；

代码检查模块402，用于：对当前代码进行检查：如果当前代码为循环段落的起始标识，则向预设队列中加入循环标识，执行代码结束判断模块403；如果当前代码满足预设的效率规则，且所述队列中还保存有循环标识，则进行告警记录，执行代码结束判断模块403；如果当前代码为循环段落的结束标识，则从所述队列中移除循环标识，执行代码结束判断模块403；

代码结束判断模块403，用于：如果所述代码文件还有下一条代码，则将下一条代码作为当前代码，执行代码检查模块402，否则执行工程结束判断模块404；

工程结束判断模块404，用于：将所述当前代码文件设为已检查的代码文件，如果还有未检查的代码文件，则执行获取代码文件获取模块401，否则结束。

在其中一个实施例中，还包括：

初始化模块，用于：初始化统计参数；

告警模块，用于：当所述统计参数超过预设告警阈值则进行告警操作；

所述代码检查模块中，所述告警记录包括对所述统计参数加一。

在其中一个实施例中，所述效率规则为：

所述代码为预设的数据库操作语句；或者

所述代码为预设的远程过程调用语句；或者

所述代码为预设的事务操作启动语句，且在预设的事务操作启动语句和预设的事务操作结束语句之间包括超过预设操作阈值数量的事务操作语句。

在其中一个实施例中，所述代码检查模块，还用于：

如果所述代码为非系统或非第三方的函数调用，或者所述代码为非系统或非第三方的类方法，则执行调用检查模块；

调用检查模块包括：

调用文件获取子模块，用于：获取所述函数调用或所述类方法的代码文件作为调用文件，所述调用文件包括至少一条代码，将所述调用文件的第一条代码作为调用代码，执行调用代码检查子模块；

调用代码检查子模块，用于：对调用代码进行检查：如果调用代码为循环段落的起始标识，则向预设队列中加入循环标识，执行调用代码结束判断子模块；如果调用代码满足预设的效率规则，且所述队列中还保存有循环标识，则进行告警记录，执行调用代码结束判断子模块；如果调用代码为循环段落的结束标识，则从所述队列中移除循环标识，执行调用代码结束判断子模块；

调用代码结束判断子模块，用于：如果所述调用文件还有下一条代码，则将下一条代码作为调用代码，执行调用代码检查子模块，否则退出所述调用文件，执行代码结束判断模块。

在其中一个实施例中，所述代码检查模块，还用于：

当向预设队列加入循环标识时，将所述循环段落的起始标识所在的文件名、路径和/或行号与所述循环标识关联保存，并初始化统计参数；

所述告警记录包括：获取最新加入队列的循环标识所关联的所述循环段落的起始标识所在的文件名、路径和/或行号作为循环参数，将所述统计参数加一，并向预设的告警文件中写入所述统计参数和所述循环参数。

以上所述实施例仅表达了本发明的几种实施方式，其描述较为具体和详细，但并不能因此而理解为对本发明专利范围的限制。应当指出的是，对于本领域的普通技术人员来说，在不脱离本发明构思的前提下，还可以做出若干变形和改进，这些都属于本发明的保护范围。因此，本发明专利的保护范围应以所附权利要求为准。

Claims (10)

1.一种代码效率检查方法，其特征在于，包括：

代码文件获取步骤，包括：获取一个未检查的代码文件作为当前代码文件，所述代码文件包括至少一条代码，将所述代码文件的第一条代码作为当前代码，执行代码检查步骤；

代码检查步骤，包括：对当前代码进行检查：如果当前代码为循环段落的起始标识，则向预设队列中加入循环标识，执行代码结束判断步骤；如果当前代码满足预设的效率规则，且所述队列中还保存有循环标识，则进行告警记录，执行代码结束判断步骤；如果当前代码为循环段落的结束标识，则从所述队列中移除循环标识，执行代码结束判断步骤；

代码结束判断步骤，包括：如果所述代码文件还有下一条代码，则将下一条代码作为当前代码，执行代码检查步骤，否则执行工程结束判断步骤；

工程结束判断步骤，包括：将所述当前代码文件设为已检查的代码文件，如果还有未检查的代码文件，则执行获取代码文件获取步骤，否则结束。

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

初始化步骤，包括：初始化统计参数；

告警步骤，包括：当所述统计参数超过预设告警阈值则进行告警操作；

所述代码检查步骤中，所述告警记录包括对所述统计参数加一。

3.根据权利要求1所述的代码效率检查方法，其特征在于，所述效率规则为：

所述代码为预设的数据库操作语句；或者

所述代码为预设的远程过程调用语句；或者

所述代码为预设的事务操作启动语句，且在预设的事务操作启动语句和预设的事务操作结束语句之间包括超过预设操作阈值数量的事务操作语句。

4.根据权利要求1所述的代码效率检查方法，其特征在于，所述代码检查步骤，还包括：

如果所述代码为非系统或非第三方的函数调用，或者所述代码为非系统或非第三方的类方法，则执行调用检查步骤；

调用检查步骤包括：

调用文件获取子步骤，包括：获取所述函数调用或所述类方法的代码文件作为调用文件，所述调用文件包括至少一条代码，将所述调用文件的第一条代码作为调用代码，执行调用代码检查子步骤；

调用代码检查子步骤，包括：对调用代码进行检查：如果调用代码为循环段落的起始标识，则向预设队列中加入循环标识，执行调用代码结束判断子步骤；如果调用代码满足预设的效率规则，且所述队列中还保存有循环标识，则进行告警记录，执行调用代码结束判断子步骤；如果调用代码为循环段落的结束标识，则从所述队列中移除循环标识，执行调用代码结束判断子步骤；

调用代码结束判断子步骤，包括：如果所述调用文件还有下一条代码，则将下一条代码作为调用代码，执行调用代码检查子步骤，否则退出所述调用文件，执行代码结束判断步骤。

5.根据权利要求1所述的代码效率检查方法，其特征在于，所述代码检查步骤，还包括：

当向预设队列加入循环标识时，将所述循环段落的起始标识所在的文件名、路径和/或行号与所述循环标识关联保存，并初始化统计参数；

所述告警记录包括：获取最新加入队列的循环标识所关联的所述循环段落的起始标识所在的文件名、路径和/或行号作为循环参数，将所述统计参数加一，并向预设的告警文件中写入所述统计参数和所述循环参数。

6.一种代码效率检查系统，其特征在于，包括：

代码文件获取模块，用于：获取一个未检查的代码文件作为当前代码文件，所述代码文件包括至少一条代码，将所述代码文件的第一条代码作为当前代码，执行代码检查模块；

代码检查模块，用于：对当前代码进行检查：如果当前代码为循环段落的起始标识，则向预设队列中加入循环标识，执行代码结束判断模块；如果当前代码满足预设的效率规则，且所述队列中还保存有循环标识，则进行告警记录，执行代码结束判断模块；如果当前代码为循环段落的结束标识，则从所述队列中移除循环标识，执行代码结束判断模块；

代码结束判断模块，用于：如果所述代码文件还有下一条代码，则将下一条代码作为当前代码，执行代码检查模块，否则执行工程结束判断模块；

工程结束判断模块，用于：将所述当前代码文件设为已检查的代码文件，如果还有未检查的代码文件，则执行获取代码文件获取模块，否则结束。

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

初始化模块，用于：初始化统计参数；

告警模块，用于：当所述统计参数超过预设告警阈值则进行告警操作；

所述代码检查模块中，所述告警记录包括对所述统计参数加一。

8.根据权利要求6所述的代码效率检查系统，其特征在于，所述效率规则为：

所述代码为预设的数据库操作语句；或者

所述代码为预设的远程过程调用语句；或者

所述代码为预设的事务操作启动语句，且在预设的事务操作启动语句和预设的事务操作结束语句之间包括超过预设操作阈值数量的事务操作语句。

9.根据权利要求6所述的代码效率检查系统，其特征在于，所述代码检查模块，还用于：

如果所述代码为非系统或非第三方的函数调用，或者所述代码为非系统或非第三方的类方法，则执行调用检查模块；

调用检查模块包括：

调用文件获取子模块，用于：获取所述函数调用或所述类方法的代码文件作为调用文件，所述调用文件包括至少一条代码，将所述调用文件的第一条代码作为调用代码，执行调用代码检查子模块；

调用代码检查子模块，用于：对调用代码进行检查：如果调用代码为循环段落的起始标识，则向预设队列中加入循环标识，执行调用代码结束判断子模块；如果调用代码满足预设的效率规则，且所述队列中还保存有循环标识，则进行告警记录，执行调用代码结束判断子模块；如果调用代码为循环段落的结束标识，则从所述队列中移除循环标识，执行调用代码结束判断子模块；

调用代码结束判断子模块，用于：如果所述调用文件还有下一条代码，则将下一条代码作为调用代码，执行调用代码检查子模块，否则退出所述调用文件，执行代码结束判断模块。

10.根据权利要求6所述的代码效率检查系统，其特征在于，所述代码检查模块，还用于：

当向预设队列加入循环标识时，将所述循环段落的起始标识所在的文件名、路径和/或行号与所述循环标识关联保存，并初始化统计参数；

所述告警记录包括：获取最新加入队列的循环标识所关联的所述循环段落的起始标识所在的文件名、路径和/或行号作为循环参数，将所述统计参数加一，并向预设的告警文件中写入所述统计参数和所述循环参数。