CN107357733A - 提高代码质量的方法及装置 - Google Patents

Abstract

本申请提供了提高代码质量的方法及装置，涉及软件开发技术领域，其中，该提高代码质量的方法包括：首先由集成开发环境将检查合格后的代码上传到服务器，之后，服务器按照预先设定的时间间隔并运用预先定义的复核模板复查代码，再次，服务器根据复查的结果生成核对报告，并将核对报告发送给代码维护端，通过上述提高代码质量的方法，不仅加强了对编写代码在本地的检查，还能通过服务器再次进行复核，并定期生成核对报告，从而规范了代码的编写格式，有效提升了代码的质量。

Description

提高代码质量的方法及装置

技术领域

本发明涉及软件开发技术领域，尤其涉及提高代码质量的方法及装置。

背景技术

在现有的软件开发过程中，通常是将整个软件按照实现功能分为几个部分，之后，由每个编码人员负责完成一部分功能的代码编写。但在实操过程中，由于，每个编码人员的想法不一致，代码风格因人而异，导致代码的呈现形式多种多样，可读性差。当公司出现***后更是难以维护现有版本的代码，最终结果就是导致代码可维护性低甚至不可维护，使代码的可利用程度降低。另外，由于编码人员水平参差不齐，编码人员经常在编写代码的过程中犯一些低级错误，特别是当整个软件的功能组成部分比较庞大时，代码的出错率更高，这样，导致后期在测试过程中测试代码的时间延长、测试的复杂度变大、严重时甚至导致上线风险。

针对上述问题，目前的做法通常是由有经验的人士整理总结编码规范文档，之后，定期开展关于代码编写的技术分享，然后，人为审核不同功能部分的代码进行规避，上述做法耗时耗力，不仅需要付出大量的时间，而且，要消耗的人力成本也非常大，致使很多公司难以实施，进而无法保证代码的可靠性。

综上，目前关于软件开发的过程中无法保障代码质量的问题，尚无有效的解决办法。

发明内容

有鉴于此，本发明实施例的目的在于提供了提高代码质量的方法及装置，通过设置代码模板、复核模板并生成核对报告等，提高了代码编写的质量。

第一方面，本发明实施例提供了提高代码质量的方法，包括：集成开发环境将检查合格后的代码上传到服务器；

服务器按照预先设定的时间间隔并运用预先定义的复核模板复查代码；

服务器根据复查的结果生成核对报告，并将核对报告发送给代码维护端。

结合第一方面，本发明实施例提供了第一方面的第一种可能的实施方式，其中，集成开发环境将检查合格后的代码上传到服务器包括：

集成开发环境运用预先定义的代码模板将代码进行格式化；

集成开发环境运用预先定义的检查模板检查格式化后的代码是否合格；

当代码检查为合格时，集成开发环境将检查合格后的代码上传到服务器。

结合第一方面的第一种可能的实施方式，本发明实施例提供了第一方面的第二种可能的实施方式，其中，服务器按照预先设定的时间间隔并运用预先定义的复核模板复查代码包括：

服务器配置持续集成工具的复核模板；

持续集成工具按照预先设定的时间间隔从服务器上下载代码；

持续集成工具运用预先定义的复核模板复查代码。

结合第一方面的第一种可能的实施方式，本发明实施例提供了第一方面的第三种可能的实施方式，其中，方法还包括：

当代码检查为不合格时，代码维护端修改代码；

集成开发环境运用预先定义的代码模板将修改过的代码进行格式化；

集成开发环境运用预先定义的检查模板再次检查修改过后的代码是否合格。

结合第一方面的第一种可能的实施方式，本发明实施例提供了第一方面的第四种可能的实施方式，其中，方法还包括：

集成开发环境按照代码维护端的需求定义代码模板；

集成开发环境导入代码模板。

结合第一方面的第一种可能的实施方式，本发明实施例提供了第一方面的第五种可能的实施方式，其中，方法还包括：

集成开发环境按照代码维护端的需求定义检查模板；

集成开发环境导入检查模板。

第二方面，本发明实施例提供了提高代码质量的装置，包括：上传模块，用于集成开发环境将检查合格后的代码上传到服务器；

复核模块，用于服务器按照预先设定的时间间隔并运用预先定义的复核模板复查代码；

报告生成模块，用于服务器根据复查的结果生成核对报告，并将核对报告发送给代码维护端。

结合第二方面，本发明实施例提供了第二方面的第一种可能的实施方式，其中，上传模块包括：

格式化单元，用于集成开发环境运用预先定义的代码模板将代码进行格式化；

检查单元，用于集成开发环境运用预先定义的检查模板检查格式化后的代码是否合格；

合格上传单元，用于当代码检查为合格时，集成开发环境将检查合格后的代码上传到服务器。

结合第二方面的第一种可能的实施方式，本发明实施例提供了第二方面的第二种可能的实施方式，其中，复核模块包括：

复核模板配置单元，用于服务器配置持续集成工具的复核模板；

代码下载单元，用于持续集成工具按照预先设定的时间间隔从服务器上下载代码；

代码复查单元，用于持续集成工具运用预先定义的复核模板复查代码。

结合第二方面的第一种可能的实施方式，本发明实施例提供了第二方面的第三种可能的实施方式，其中，上传模块还包括：

代码修改单元，用于当代码检查为不合格时，代码维护端修改代码；

再度格式化单元，用于集成开发环境运用预先定义的代码模板将修改过的代码进行格式化；

再次修改单元，用于集成开发环境运用预先定义的检查模板再次检查修改过后的代码是否合格。

本发明实施例提供的提高代码质量的方法及装置，其中，该提高代码质量的方法包括：首先，集成开发环境将检查合格后的代码上传到服务器，之后，服务器能够按照预先设定的时间间隔并运用预先定义的复核模板复查代码，并且，服务器根据复查的结果生成核对报告，并将核对报告发送给代码维护端，通过上述处理过程，使软件开发过程中的代码能够进行统一的核查，并且，无需人为干预，由服务器直接将核对报告发送给代码维护端，通过上述操作节省了软件开发过程中的人力消耗，有效保证了代码质量的可靠性。

本发明的其他特征和优点将在随后的说明书中阐述，并且，部分地从说明书中变得显而易见，或者通过实施本发明而了解。本发明的目的和其他优点在说明书、权利要求书以及附图中所特别指出的结构来实现和获得。

为使本发明的上述目的、特征和优点能更明显易懂，下文特举较佳实施例，并配合所附附图，作详细说明如下。

附图说明

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

图1示出了本发明实施例所提供的提高代码质量的方法的结构连接图；

图2示出了本发明实施例所提供的提高代码质量的装置的连接图；

图3示出了本发明实施例所提供的提高代码质量的装置的结构框架图；

图4示出了本发明实施例所提供的提高代码质量的装置的结构连接图。

图标：1-上传模块；2-复核模块；3-报告生成模块；11-格式化单元；12-检查单元；13-合格上传单元；21-复核模板配置单元；22-代码下载单元；23-代码复查单元。

具体实施方式

下面将结合本发明实施例中附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。通常在此处附图中描述和示出的本发明实施例的组件可以以各种不同的配置来布置和设计。因此，以下对在附图中提供的本发明的实施例的详细描述并非旨在限制要求保护的本发明的范围，而是仅仅表示本发明的选定实施例。基于本发明的实施例，本领域技术人员在没有做出创造性劳动的前提下所获得的所有其他实施例，都属于本发明保护的范围。

在目前的软件开发流程中，通常由每个编码人员负责完成一部分功能代码的编写。但每个编码人员的想法不一致，代码风格因人而异，导致代码的可读性差，使代码的可利用程度降低。另外，由于编码人员在编写代码的过程中会犯一些低级错误，这样，导致在测试过程中测试代码的时间延长、测试的复杂度变大、严重时甚至导致上线风险。鉴于上述问题，目前的做法通常是由有经验的人士整理总结编码规范文档，之后，定期开展关于代码编写的技术分享，然后，人为审核不同功能部分的代码进行规避，上述做法耗时耗力，不仅需要付出大量的时间，而且，要消耗的人力成本也非常大，无法有效保证代码的可靠性。

基于此，本发明实施例提供了提高代码质量的方法及装置，下面通过实施例进行描述。

实施例1

参见图1，本实施例提出的提高代码质量的方法具体包括以下步骤：

步骤S101：集成开发环境将检查合格后的代码上传到服务器，具体的，该步骤包括：

(1)集成开发环境运用预先定义的代码模板将代码进行格式化。

首先，可以根据操作***的不同在预先定义的代码模板中规范下列内容：用4个空格替换tab，类声明不缩进，类体包括方法、属性、内部类等都缩进4个字符，构造方法及方法体内再缩进4个字符，if块、while块、switch块继续缩进4个字符，定义大括号”{“的位置在任意情况下都不换行，跟在代码后面，定义空格的***方式：关键字、变量、操作符、标点符号之间各保留1个空格，定义空行的***方式：包名上方不***空行、包名下方***1个空行、第一个import前***1个空行、class前***1个空行、method前***1个空行、field前***1个空行，定义新行的***方式：空的class体、method体、block体、enum体、annotation体都***一个空行，定义换行的模式：一行超过140个字符换行。

其次，当定义好上述代码模板后，集成开发环境利用该代码模板对编写的代码进行格式化，从格式上规范和统一上述代码。

另外，需要说明的是，在实际操作过程中，通常将上述代码模板编写到.xml文件中，例如，codeformatter.xml。编写结束后将该codeformatter.xml导入到IDE(集成开发环境)中备用。而且，还可以在codetemplates.xml中定义类注释，例如，当在class上方打出/**按回车后自动出现注释，其中${user}取本地用户名即代码的编写者姓名，版本号需手动修改，${date}取本地当前时间，精确到日。

(2)集成开发环境运用预先定义的检查模板检查格式化后的代码是否合格。

当程序员在上述环境中编写好代码后，并且，编写好的代码经上述代码模板进行了格式化，统一了编写风格。之后，由集成开发环境定义检查模板，即在不同的操作***中预先定义检查模板，具体内容可规范如下：1.定义javadoc注释检查方法：保持和之前codetemplates.xml一致；2.定义命名规则检查方法：检查常量名必须是由大写的A-Z、0-9或下划线组成，属性名、方法名、参数名、变量名必须由小写字母开头并且由字母或数字组成，类名必须由大写字母开头并且由字母或数字组成，3.定义impot规则检查方法：检查是否没有import*的出现，检查是否有重复的import出现，检查是否有未使用的import的出现，4.定义大小限制：每行代码最大140个字符，方法参数数量不能超过5个，5.定义空格、block的检查方法：保持和codetemplates.xml一致，6.定义作用于关键字的顺序：public->protected->default->private，7.定义一些基本的代码检查方法：隐藏字段校验、魔鬼数字校验、多余的throw校验、String字段比较校验、不必要的括号校验、main函数校验。

其次，当定义好上述检查模板后，集成开发环境利用该检查模板检查编写的代码是否合格。

另外，需要说明的是，在实际操作过程中，通常将上述检查模板编写到.xml文件中，例如，checkstyle.xml。编写结束后将其导入到集成开发环境的IDE中备用，以对代码进行合格否的检查。

(3)当代码检查为合格时，集成开发环境将检查合格后的代码上传到服务器。

通过上述步骤(1)和(2)的操作，不仅规范了代码的格式，而且，在本地保证了代码的正确性，当代码检查合格后才将其上传到服务器，进一步减轻了服务器处理错误代码的压力。

当代码检查为不合格时，代码维护端修改代码，集成开发环境运用预先定义的代码模板将修改过的代码进行格式化，集成开发环境运用预先定义的检查模板再次检查修改过后的代码是否合格。即当通过上述步骤(1)和(2)的操作，发现代码有问题，则向代码维护端发出提示，使其进行修改，然后重复上述(1)和(2)两步，直到代码合格后，再将代码从本地上传至服务器。

步骤S102：服务器按照预先设定的时间间隔并运用预先定义的复核模板复查代码，具体的，该步骤包括：

1服务器配置持续集成工具的复核模板，为了保证代码的质量，在服务器端配置持续集成工具的复核模板，设定定时从服务器上下载最新代码并进行自动构建。

2持续集成工具按照预先设定的时间间隔从服务器上下载代码，配置好后，持续集成工具在定时到达后自动从服务器端下载最新代码，并进行编译。

3持续集成工具运用预先定义的复核模板复查代码。之后，运用复核模板复查代码。

步骤S103：服务器根据复查的结果生成核对报告，并将核对报告发送给代码维护端。

为了方便快捷的对代码的质量进行评价，并便于对外展示。在本实施例中，服务器根据复查的结果生成核对报告，这里需要说明的是，核对报告的格式包括：word、excel、ppt、html等，之后，将生成的核对报告发送给代码维护端。

此外，上述提高代码质量的方法还包括：集成开发环境按照代码维护端的需求定义代码模板，集成开发环境导入代码模板。并且，集成开发环境按照代码维护端的需求定义检查模板，集成开发环境导入检查模板。可见，无论是代码模板还是检查模板都需要先进行定义，之后，才能导入到集成开发环境中使用。通常，代码模板和检查模板的具体定义内容都按照代码维护端的需求，这里需要说明的是，常见的代码维护端包括本地、服务器或者第三方的检验端口等。

综上所述，本实施例提供的提高代码质量的方法包括：首先，集成开发环境将检查合格后的代码上传到服务器，之后，服务器按照预先设定的时间间隔并运用预先定义的复核模板复查代码，其次，服务器根据复查的结果生成核对报告，并将核对报告发送给代码维护端，通过上述提高代码质量的方法，有效保障了软件开发的过程中的代码质量，省时省力，方便快捷。

实施例2

参见图2、图3和图4，本实施例提供了提高代码质量的装置包括：依次相连的上传模块1、复核模块2和报告生成模块3，其中，上传模块1用于集成开发环境将检查合格后的代码上传到服务器，复核模块2用于服务器按照预先设定的时间间隔并运用预先定义的复核模板复查代码，报告生成模块3用于服务器根据复查的结果生成核对报告，并将核对报告发送给代码维护端。

其中，上传模块1包括：依次相连的格式化单元11、检查单元12和合格上传单元13，使用时，格式化单元11用于集成开发环境运用预先定义的代码模板将代码进行格式化，检查单元12用于集成开发环境运用预先定义的检查模板检查格式化后的代码是否合格，合格上传单元13用于当代码检查为合格时，集成开发环境将检查合格后的代码上传到服务器。

其中，复核模块2包括：依次相连的复核模板配置单元21、代码下载单元22和代码复查单元23，使用时，复核模板配置单元21用于服务器配置持续集成工具的复核模板，代码下载单元22用于持续集成工具按照预先设定的时间间隔从服务器上下载代码，代码复查单元23用于持续集成工具运用预先定义的复核模板复查代码。

其中，上传模块1还包括：依次相连的代码修改单元、再度格式化单元11和再次修改单元，使用时，代码修改单元用于当代码检查为不合格时，代码维护端修改代码，再度格式化单元11用于集成开发环境运用预先定义的代码模板将修改过的代码进行格式化，再次修改单元用于集成开发环境运用预先定义的检查模板再次检查修改过后的代码是否合格。

综上所述，本实施例提供的提高代码质量的装置包括：依次相连的上传模块1、复核模块2和报告生成模块3，使用时，上传模块1用于集成开发环境将检查合格后的代码上传到服务器，复核模块2用于服务器按照预先设定的时间间隔并运用预先定义的复核模板复查代码，报告生成模块3用于服务器根据复查的结果生成核对报告，并将核对报告发送给代码维护端，通过上述装置的设置，规范了代码编写的格式，加强了对代码的检查，从而有效提高了代码编写的质量。

最后应说明的是：以上所述实施例，仅为本发明的具体实施方式，用以说明本发明的技术方案，而非对其限制，本发明的保护范围并不局限于此，尽管参照前述实施例对本发明进行了详细的说明，本领域的普通技术人员应当理解：任何熟悉本技术领域的技术人员在本发明揭露的技术范围内，其依然可以对前述实施例所记载的技术方案进行修改或可轻易想到变化，或者对其中部分技术特征进行等同替换；而这些修改、变化或者替换，并不使相应技术方案的本质脱离本发明实施例技术方案的精神和范围，都应涵盖在本发明的保护范围之内。因此，本发明的保护范围应所述以权利要求的保护范围为准。

Claims (10)

1.提高代码质量的方法，其特征在于，包括：

集成开发环境将检查合格后的代码上传到服务器；

所述服务器按照预先设定的时间间隔并运用预先定义的复核模板复查所述代码；

所述服务器根据所述复查的结果生成核对报告，并将所述核对报告发送给代码维护端。

2.根据权利要求1所述的提高代码质量的方法，其特征在于，所述集成开发环境将检查合格后的代码上传到服务器包括：

集成开发环境运用预先定义的代码模板将代码进行格式化；

所述集成开发环境运用预先定义的检查模板检查格式化后的所述代码是否合格；

当所述代码检查为合格时，所述集成开发环境将检查合格后的所述代码上传到服务器。

3.根据权利要求2所述的提高代码质量的方法，其特征在于，所述服务器按照预先设定的时间间隔并运用预先定义的复核模板复查所述代码包括：

所述服务器配置持续集成工具的复核模板；

所述持续集成工具按照预先设定的时间间隔从所述服务器上下载所述代码；

所述持续集成工具运用预先定义的所述复核模板复查所述代码。

4.根据权利要求2所述的提高代码质量的方法，其特征在于，所述方法还包括：

当所述代码检查为不合格时，所述代码维护端修改所述代码；

所述集成开发环境运用预先定义的代码模板将修改过的所述代码进行格式化；

所述集成开发环境运用预先定义的检查模板再次检查修改过后的所述代码是否合格。

5.根据权利要求2所述的提高代码质量的方法，其特征在于，所述方法还包括：

所述集成开发环境按照所述代码维护端的需求定义所述代码模板；

所述集成开发环境导入所述代码模板。

6.根据权利要求2所述的提高代码质量的方法，其特征在于，所述方法还包括：

所述集成开发环境按照所述代码维护端的需求定义所述检查模板；

所述集成开发环境导入所述检查模板。

7.提高代码质量的装置，其特征在于，包括：

上传模块，用于集成开发环境将检查合格后的代码上传到服务器；

复核模块，用于所述服务器按照预先设定的时间间隔并运用预先定义的复核模板复查所述代码；

报告生成模块，用于所述服务器根据所述复查的结果生成核对报告，并将所述核对报告发送给代码维护端。

8.根据权利要求7所述的提高代码质量的装置，其特征在于，所述上传模块包括：

格式化单元，用于集成开发环境运用预先定义的代码模板将代码进行格式化；

检查单元，用于所述集成开发环境运用预先定义的检查模板检查格式化后的所述代码是否合格；

合格上传单元，用于当所述代码检查为合格时，所述集成开发环境将检查合格后的所述代码上传到服务器。

9.根据权利要求8所述的提高代码质量的装置，其特征在于，所述复核模块包括：

复核模板配置单元，用于所述服务器配置持续集成工具的复核模板；

代码下载单元，用于所述持续集成工具按照预先设定的时间间隔从所述服务器上下载所述代码；

代码复查单元，用于所述持续集成工具运用预先定义的所述复核模板复查所述代码。

10.根据权利要求8所述的提高代码质量的装置，其特征在于，所述上传模块还包括：

代码修改单元，用于当所述代码检查为不合格时，所述代码维护端修改所述代码；

再度格式化单元，用于所述集成开发环境运用预先定义的代码模板将修改过的所述代码进行格式化；

再次修改单元，用于所述集成开发环境运用预先定义的检查模板再次检查修改过后的所述代码是否合格。