代码评审的实现方法、装置、存储介质及电子设备与流程

文档序号:14554620阅读:179来源:国知局
代码评审的实现方法、装置、存储介质及电子设备与流程

本发明实施例涉及计算机技术领域,尤其涉及一种代码评审的实现方法、装置、存储介质及电子设备。



背景技术:

代码评审是指通过检查源代码与编码标准的符合性以及代码质量的活动。通过代码评审可以发现编码规范、代码结果、功能实现甚至性能调优等各方面的问题。因此,通过代码评审能够提高代码质量,而且能够在项目的早期发现缺陷,将损失降至最低。代码评审的过程也是重新梳理思路的过程,开发人员能够加深对系统的理解,促进团队沟通、促进知识共享、共同提高。

现有的代码评审过程一般通过如下方式实现:开发人员进行手动的代码走查,交叉评审,参与者可以是任意两个开发组员,或开发组长分别与每个开发组员结对进行。结对进行代码评审时,代码作者讲解代码实现原理、评审者提出问题和建议。每次代码评审的问题记录到代码评审文档里。最后,开发进行到某一阶段时,可以对共性问题进行总结,对好的做法进行提炼和推广。

因此,在上述过程当中,代码评审流程需要开发人员管理,非常耗时耗力。



技术实现要素:

本发明实施例提供一种代码评审的实现方法、装置、存储介质及电子设备,用于解决现有技术代码评审流程需要开发人员管理,非常耗时耗力的技术问题。

第一方面,本发明实施例提供一种代码评审的实现方法,包括:

根据版本管理服务器的代码提交日志,获取代码评审对象;

根据所述代码评审对象,创建在两个角色之间进行流转的代码评审工作流程;所述两个角色为代码作者和代码评审人员;

执行所述代码评审工作流程,直至满足预设条件,结束所述代码评审工作流程。

可选的,根据版本管理服务器的代码提交日志,获取代码评审对象,具体包括:

根据所述代码提交日志,解析所述代码提交日志的日志信息;所述日志信息包括:提交人、提交时间、以及提交内容;

根据所述日志信息获取所述代码评审对象。

可选的,执行所述代码评审工作流程,具体包括:

向所述代码评审人员发送评审通知;所述评审通知用于指示对所述代码评审对象进行评审;

获取所述代码评审人员提交的问题评论信息。

可选的,获取所述代码评审人员提交的问题评论信息之后,还包括:

向所述代码作者发送回复通知;所述回复通知用于指示对所述问题评论信息进行回复;

获取所述代码评审人员提交的回复信息。

可选的,获取所述代码评审人员提交的回复信息之后,还包括:

向所述代码评审人员发送确认通知;所述确认通知用于指示对所述回复信息进行确认;

获取所述代码评审人员提交的确认指示;所述确认指示用于指示是否结束所述代码评审工作流程。

可选的,向所述代码评审人员发送评审通知之后,还包括:

若在第一预设时间内没有获取到所述代码评审人员提交的问题评论信息,则对所述代码评审人员进行周期性的提醒。

可选的,向所述代码作者发送回复通知之后,还包括:

若在第二预设时间内没有获取到所述代码作者提交的回复信息,则对所述代码作者进行周期性的提醒。

可选的,还包括:

获取所述代码评审工作流程中的问题评论信息以及与所述问题评论信息对应的回复信息的提交日志;

将所述问题评论信息、所述回复信息、所述提交日志以及所述问题评论信息对应的代码行数信息进行存储。

可选的,将所述问题评论信息、所述回复信息、所述提交日志以及所述问题评论信息对应的代码行数信息进行存储,具体包括:

采用内存数据库redis的键值key-value存储方式,对所述问题评论信息、所述回复信息、所述提交日志以及所述问题评论信息对应的代码行数信息进行存储。

可选的,还包括:

根据所述问题评论信息、所述回复信息、所述提交日志以及所述问题评论信息对应的代码行数信息,计算预设的时间范围内的代码评审覆盖率,提交的问题评论信息的数量,以及被评审指出的问题数量;

根据所述代码提交日志,计算所述代码作者提交的代码量。

第二方面,本发明实施例提供一种代码评审的实现装置,包括:

代码解析模块,用于根据版本管理服务器的代码提交日志,获取代码评审对象;

代码评审工作流模块,用于根据所述代码评审对象,创建在两个角色之间进行流转的代码评审工作流程;所述两个角色为代码作者和代码评审人员;

所述代码评审工作流模块,还用于执行所述代码评审工作流程,直至满足预设条件,结束所述代码评审工作流程。

第三方面,本发明实施例提供一种计算机可读存储介质,其上存储有计算机程序,所述计算机程序被处理器执行时实现第一方面中任一项所述的方法。

第四方面,本发明实施例提供一种电子设备,包括:

处理器;以及

存储器,用于存储所述处理器的可执行指令;

其中,所述处理器配置为经由执行所述可执行指令来执行第一方面中任一项所述的方法。

本发明实施例提供的代码评审的实现方法、装置、存储介质及电子设备,根据版本管理服务器的代码提交日志,获取代码评审对象;根据所述代码评审对象,创建在两个角色之间进行流转的代码评审工作流程;所述两个角色为代码作者和代码评审人员;执行所述代码评审工作流程,直至满足预设条件,结束所述代码评审工作流程,通过将代码评审工作纳入工作流程进行实施,在代码评审工作流程中引入两个角色,并在该两个角色之间进行工作流转,实现了对代码评审的统一管理。

附图说明

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

图1为本发明提供的代码评审的实现方法一实施例的流程示意图;

图2a为本发明提供的代码评审的实现方法另一实施例的流程示意图;

图2b为本发明提供的代码评审的实现方法又一实施例的流程示意图;

图3为本发明提供的服务器实施例的结构图;

图4为本发明提供的电子设备实施例的结构图。

具体实施方式

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

首先,对本申请涉及到的名词进行解释:

代码评审是指通过检查源代码与编码标准的符合性以及代码质量的活动。

本发明实施例中涉及到的用户设备,例如包括计算机、平板电脑等。

下面以具体地实施例对本发明的技术方案进行详细说明。下面这几个具体的实施例可以相互结合,对于相同或相似的概念或过程可能在某些实施例不再赘述。

图1为本发明提供的代码评审的实现方法一实施例的流程示意图。如图1所示,本发明实施例的方法可以应用于基于角色的代码评审流程管理系统中,如应用在服务器上,所述方法可以包括:

步骤101、根据版本管理服务器的代码提交日志,获取代码评审对象。

本步骤中,代码开发人员利用第一用户设备在代码编写完成后可以将某一段源代码提交到版本管理服务器。

可以选中特定几次的提交的源代码作为代码评审对象,创建评审工作流程,默认评审工作流程中的代码作者为该代码开发人员。

其中,步骤101具体可以通过如下方式实现:

根据所述代码提交日志,解析所述代码提交日志的日志信息;所述日志信息包括:提交人、提交时间、以及提交内容;

根据所述日志信息获取所述代码评审对象。

可以通过版本控制系统svn(subversion,简称svn)或者分布式版本控制系统git获取版本管理服务器的提交日志,解析出提交人,提交时间,以及提交内容。

步骤102、根据所述代码评审对象,创建在两个角色之间进行流转的代码评审工作流程;所述两个角色为代码作者和代码评审人员。

具体的,可以选定至少一个代码评审人员。可以在代码开发人员中随机选择(可以除去代码评审对象的代码作者),或者按照一定顺序依次选择。

创建在两个角色之间进行流转的代码评审工作流程,即在代码作者和代码评审人员之间进行流转的代码评审工作流程。

具体可以通过工作流引擎(businessprocesssuite,简称bps),创建所述代码评审工作流程;

通过所述bps,执行所述代码评审工作流程,直至满足预设条件,结束所述代码评审工作流程。

步骤103、执行所述代码评审工作流程,直至满足预设条件,结束所述代码评审工作流程。

本步骤中,通过执行上述建立的代码评审工作流程,将代码评审工作纳入工作流程进行强制实施,实现了对代码评审工作的统一管理。

上述方案中,将查阅代码以及代码评审工作集中在一个系统上进行统一管理。

本发明实施例提供的方法中,根据版本管理服务器的代码提交日志,获取代码评审对象;根据所述代码评审对象,创建在两个角色之间进行流转的代码评审工作流程;所述两个角色为代码作者和代码评审人员;执行所述代码评审工作流程,直至满足预设条件,结束所述代码评审工作流程,通过将代码评审工作纳入工作流程进行实施,在代码评审工作流程中引入两个角色,并在该两个角色之间进行工作流转,实现了对代码评审的统一管理。

图2a为本发明提供的代码评审的实现方法另一实施例的流程示意图。上述实施例的基础上,如图2a所示,步骤103中的执行所述代码评审工作流程,具体包括:

步骤1031、向所述代码评审人员发送评审通知;所述评审通知用于指示对所述代码评审对象进行评审;

获取所述代码评审人员提交的问题评论信息。

步骤1032、向所述代码作者发送回复通知;所述回复通知用于指示对所述问题评论信息进行回复;

获取所述代码评审人员提交的回复信息。

步骤1033、向所述代码评审人员发送确认通知;所述确认通知用于指示对所述回复信息进行确认;

获取所述代码评审人员提交的确认指示;所述确认指示用于指示是否结束所述代码评审工作流程。

具体的,代码评审流程管理系统的服务器会向代码评审人员(代码评审人员可以对应一第二用户设备)发送需要代码评审的评审通知,代码评审人员接收到该评审通知后,对代码评审对象进行评审。

可选的,发送评审通知具体可以通过邮件通知方式或者通过发送待办事项消息方式。

代码评审人员进行代码评审时,对认为有问题的源代码直接在代码评审流程管理系统中给出评审意见。

服务器在获取到所述代码评审人员提交的问题评论信息后,可以对代码评审对象对应的评审意见,进行存储,以便于对源代码以及评审意见进行统一管理。

之后评审流程流转到代码作者。

服务器向代码作者发送回复通知,以使代码作者对评审意见进行回复。代码作者可以直接在代码评审流程管理系统中给出回复。

服务器可以存储代码作者的回复内容。

可选的,发送回复通知具体可以通过邮件通知方式或者通过发送待办事项消息方式。

服务器获取到回复内容之后,评审流程流转到代码评审人员。

服务器向代码评审人员发送确认通知,以使代码评审人员对回复内容进行确认。

代码评审人员向服务器提交确认指示,若确认指示包含指示关闭评审流程,则结束评审流程。服务器可以记录该代码评审对象对应的评审流程过程中的评审意见、回复内容,还可以记录代码评审对象对应的代码开发人员、提交时间、源代码信息等。

若确认指示包含待确认的评审意见,则重复执行步骤1031-1033,直至确认指示包含指示关闭评审流程,则结束评审流程。

本发明实施例中,通过在代码作者和代码评审人员之间发送评审通知、回复通知以及确认通知,将代码评审工作纳入工作流程进行实施,使得代码评审工作在代码评审工作流程的两个角色之间进行工作流转,实现了对评审流程的统一管理。

上述实施例的基础上,在步骤1031之后,本发明实施例的方法还可以进行如下操作:

若在第一预设时间内没有获取到所述代码评审人员提交的问题评论信息,则对所述代码评审人员进行周期性的提醒。

具体可以向所述代码评审人员周期性的发送第一提醒消息;所述第一提醒消息用于提醒所述代码评审人员对所述代码评审对象进行评审。

具体的,为了便于服务器及时获取到代码评审人员提交的问题评论信息,因此若在第一预设时间内没有获取到所述代码评审人员提交的问题评论信息,则对所述代码评审人员进行周期性的提醒,用于提醒代码评审人员对代码评审对象进行评审。

可选的,在步骤1032之后,本发明实施例的方法还可以进行如下操作:

若在第二预设时间内没有获取到所述代码作者提交的回复信息,则对所述代码作者进行周期性的提醒。

具体可以向代码作者周期性的发送第二提醒消息;所述第二提醒消息用于提醒所述代码作者对评审意见即问题评论信息进行回复。

具体的,为了便于服务器及时获取到代码作者提交的回复内容,因此若在第二预设时间内没有获取到代码作者提交的回复内容,则向代码作者周期性的发送第二提醒消息,用于提醒代码作者对评审意见进行回复。

可选的,在步骤101之后,本发明实施例的方法还可以进行如下操作:

获取所述代码评审工作流程中的问题评论信息以及与所述问题评论信息对应的回复信息的提交日志;

将所述问题评论信息、所述回复信息、所述提交日志以及所述问题评论信息对应的代码行数信息进行存储。

可选的,具体可以采用如下方式存储:

采用内存数据库(remotedictionaryserver,简称redis)的键值key-value存储方式,对所述问题评论信息、所述回复信息、所述提交日志以及所述问题评论信息对应的代码行数信息进行存储。

可选的,还包括:

根据所述问题评论信息、所述回复信息、所述提交日志以及所述问题评论信息对应的代码行数信息,计算预设的时间范围内的代码评审覆盖率,提交的问题评论信息的数量,以及被评审指出的问题数量;

根据所述代码提交日志,计算所述代码作者提交的代码量。

具体的,可以将评审流程中的问题评论以及回复等信息进行存储,存储时附加提交日志以及问题对应的代码行数等信息,具体可以采用内存数据库redis的key-value存储方式进行存储,存取效率高同时也便于查询。

进一步的,可以通过上述记录的详细信息,进行查询统计计算出预设的时间范围内的代码评审比例,也就是覆盖率。同时,也能统计出代码开发人员提交的代码量,提交的评审意见,被评审指出的问题数量等。

覆盖率即所述代码评审对象占代码作者提交的源代码的比例,从而可以便于查看代码作者提交的源代码是否均经过评审。

上述具体实施方式中,通过对代码作者和代码评审人员的提醒,保证能够及时的对源代码进行评审,以及对评审意见进行回复,避免遗漏。

如图2b所示,整个代码评审工作流程如下:

1、开发人员提交代码到版本管理服务器;

2、代码评审系统解析提交日志并将提交人、提交时间、提交内容呈现在画面上;

3、选中特定的几次提交作为评审对象,创建评审流程,默认评审流中的代码作者为代码提交人员;

4、指定代码评审人员,可以一个或多个,同时开启基于角色的代码评审流转;

5、代码评审人员会收到需要代码评审的通知,包括邮件以及在评审系统当中呈现待办两种方式。

6、代码评审人员进行代码评审,同时对有问题的代码直接在代码评审流程管理系统上给出评论;

7、代码评审人员评审完毕,结束评审。评审流程流转到代码作者;

8、代码作者收到代码已经被评审完毕的邮件通知,同时在评审系统中也收到待办;

9、代码作者确认评审人员给出的评论,并做出相应回复,代码评审再次流转到评审人员;

10、代码评审者收到通知,察看作者的回复,确认没有异议关闭评审流程。

图3为本发明提供的代码评审的实现装置结构图,如图3所示,本发明实施例的代码评审的实现装置可以包括:

代码解析模块,用于根据版本管理服务器的代码提交日志,获取代码评审对象;

代码评审工作流模块,用于根据所述代码评审对象,创建在两个角色之间进行流转的代码评审工作流程;所述两个角色为代码作者和代码评审人员;

所述代码评审工作流模块,还用于执行所述代码评审工作流程,直至满足预设条件,结束所述代码评审工作流程。

可选的,代码解析模块,具体用于:

根据所述代码提交日志,解析所述代码提交日志的日志信息;所述日志信息包括:提交人、提交时间、以及提交内容;

根据所述日志信息获取所述代码评审对象。

可选的,所述代码评审工作流模块,具体用于:

向所述代码评审人员发送评审通知;所述评审通知用于指示对所述代码评审对象进行评审;

获取所述代码评审人员提交的问题评论信息。

可选的,所述代码评审工作流模块,具体用于:

向所述代码作者发送回复通知;所述回复通知用于指示对所述问题评论信息进行回复;

获取所述代码评审人员提交的回复信息。

可选的,所述代码评审工作流模块,具体用于:

向所述代码评审人员发送确认通知;所述确认通知用于指示对所述回复信息进行确认;

获取所述代码评审人员提交的确认指示;所述确认指示用于指示是否结束所述代码评审工作流程。

可选的,所述代码评审工作流模块,具体用于:

若在第一预设时间内没有获取到所述代码评审人员提交的问题评论信息,则对所述代码评审人员进行周期性的提醒。

可选的,所述代码评审工作流模块,具体用于:

若在第二预设时间内没有获取到所述代码作者提交的回复信息,则对所述代码作者进行周期性的提醒。

可选的,还包括:

代码问题管理模块,用于:

获取所述代码评审工作流程中的问题评论信息以及与所述问题评论信息对应的回复信息的提交日志;

将所述问题评论信息、所述回复信息、所述提交日志以及所述问题评论信息对应的代码行数信息进行存储。

可选的,代码问题管理模块,具体用于:

采用内存数据库redis的键值key-value存储方式,对所述问题评论信息、所述回复信息、所述提交日志以及所述问题评论信息对应的代码行数信息进行存储。

可选的,还包括:

代码评审统计模块,用于根据所述问题评论信息、所述回复信息、所述提交日志以及所述问题评论信息对应的代码行数信息,计算预设的时间范围内的代码评审覆盖率,提交的问题评论信息的数量,以及被评审指出的问题数量;

根据所述代码提交日志,计算所述代码作者提交的代码量。

本发明实施例的代码评审的实现装置,可以用于执行上述方法实施例的技术方案,其实现原理和技术效果类似,此处不再赘述。

本发明实施例中还提供一种计算机可读存储介质,其上存储有计算机程序,所述计算机程序被处理器执行时实现前述方法实施例中对应的方法,其具体实施过程可以参见前述方法实施例,其实现原理和技术效果类似,此处不再赘述。

图4为本发明提供的电子设备实施例的结构图,如图4所示,该电子设备包括:

处理器401,以及,用于存储可执行指令的存储器402。

其中,所述处理器配置为经由执行所述可执行指令来执行前述方法实施例中对应的方法,其具体实施过程可以参见前述方法实施例,其实现原理和技术效果类似,此处不再赘述。

在本申请所提供的几个实施例中,应该理解到,所揭露的设备和方法,可以通过其它的方式实现。例如,以上所描述的设备实施例仅仅是示意性的,例如,所述单元或模块的划分,仅仅为一种逻辑功能划分,实际实现时可以有另外的划分方式,例如多个单元或模块可以结合或者可以集成到另一个系统,或一些特征可以忽略,或不执行。另一点,所显示或讨论的相互之间的耦合或直接耦合或通信连接可以是通过一些接口,设备或模块的间接耦合或通信连接,可以是电性,机械或其它的形式。

所述作为分离部件说明的模块可以是或者也可以不是物理上分开的,作为模块显示的部件可以是或者也可以不是物理模块,即可以位于一个地方,或者也可以分布到多个网络单元上。可以根据实际的需要选择其中的部分或者全部模块来实现本发明实施例方案的目的。

本领域普通技术人员可以理解:实现上述各方法实施例的全部或部分步骤可以通过程序指令相关的硬件来完成。前述的程序可以存储于一计算机可读取存储介质中。该程序在执行时,执行包括上述各方法实施例的步骤;而前述的存储介质包括:rom、ram、磁碟或者光盘等各种可以存储程序代码的介质。

最后应说明的是:以上各实施例仅用以说明本发明的技术方案,而非对其限制;尽管参照前述各实施例对本发明进行了详细的说明,本领域的普通技术人员应当理解:其依然可以对前述各实施例所记载的技术方案进行修改,或者对其中部分或者全部技术特征进行等同替换;而这些修改或者替换,并不使相应技术方案的本质脱离本发明各实施例技术方案的范围。

当前第1页1 2 
网友询问留言 已有0条留言
  • 还没有人留言评论。精彩留言会获得点赞!
1