CN105159831A - 一种软件代码质量自动监控方法 - Google Patents

Abstract

本发明公开一种软件代码质量自动监控方法,属于计算机软件技术领域；本发明采用与SVN代码服务器直连的方式，可以保证捕获代码所有变动信息，提高了代码质量分析的效率；使用Checkstyle、FindBugs、Sonar代码检测工具对变动代码进行检测，避免了人为代码质量分析的片面性、局限性；通过更新代码监控人员信息，作为通过代码变动信息获取监控人员名单及变动代码质量信息接收用户名单的基础，使监管人员只需要专注监控自己所负责的部分，提高了代码质量监控的持续性、可追溯性，同时也避免了由于监管人员对***整体认知不够导致的代码监控的片面性、局限性。

Description

一种软件代码质量自动监控方法

技术领域

本发明公开一种软件代码质量自动监控方法，属于计算机软件技术领域。

背景技术

软件代码就是程序员用开发工具所支持的语言写出来的源文件。它是一组有序的数字或字母的排列，是代表客观实体及其属性的符号。

软件代码质量就是代码编写的一种统一规范，让代码具有可读行，思路清晰。高质量的代码都具备可读性，可维护性和可变更性这三个特征。可读性：简洁又有详细注解的代码。可维护性：一个软件生命周期中，80%的时间和精力花费在维护阶段。对于代码的可维护性，灵活的代码便于以后代码的变更。可变更性：可以根据客户的要求进行改变，即所编写的代码可以相应的改变达到客户的要求。目前信息化建设的浪潮中，面向对象的大型***应用越来越广泛，逐渐被应用到教育、交通、医疗、政府等各个行业，在当今社会中发挥的作用也越来越重要，与此同时，***本身也变得越来越庞大，越来越复杂。这些大型***应用的质量由***软件代码的质量直接决定。当前的软件行业，外包开发和维护也正逐渐演变成新趋势，导致***源代码在地理上的分散，并且独立的开发人员对整个***的开发中，只有独立有限的认知。当复杂而庞大的源代码发生变化时，依赖原始的个别开发人员通过代码Review等方式来进行代码质量的控制已变得力不从心，日积月累会给***带来不良影响，进而导致***整体代码质量的下降。本发明提供一种软件代码质量自动监控方法，通过直连SVN服务器自动化获取代码变更，自动化进行代码质量检测，通过这种方式解决了代码质量监管人员精力不足的窘境，进而保证代码的质量得到了进一步提升。

发明内容

本发明针对当复杂而庞大的源代码发生变化时，依赖原始的个别开发人员通过代码Review等方式来进行代码质量的控制已变得力不从心，日积月累会给***带来不良影响，进而导致***整体代码质量的下降的问题，提供一种软件代码质量自动监控方法，通过直连SVN服务器自动化获取代码变更，自动化进行代码质量检测，通过这种方式在很大程度上解决了代码质量监管人员精力不足的窘境，进而为代码的质量得到提高提供了保证。

本发明提出的具体方案是：

一种软件代码质量自动监控方法，通过对软件源代码SVN服务器进行监控，定时对软件源代码进行变动扫描和质量分析，及时地将代码质量数据整合发送给监控人员，具体为：

代码变动扫描和质量分析：监控服务器直接连接软件源代码SVN服务器，获取SVN源代码的目录结构，周期性对SVN服务器内SVN库进行变动信息扫描，获取检测周期内的代码变动信息，对变动的代码进行代码质量分析，获取代码的变动信息和其对应的质量数据；

代码质量信息整合与发送：将代码变动信息数据进行解析，更新源代码结构数据，并保存变动代码的质量数据，将其与更新后的源代码数据按照源代码在SVN服务器上的目录结构整合为变动代码质量信息并发送给设定的用户；

数据库存储：将SVN服务器中软件源代码的相关信息保存在数据库中，作为数据基础。其中代码变动扫描和质量分析针对源码变动信息进行分析时，可以判断源码变动类型，根据源码变动类型可以得到源码结构的变化，根据这些变化同步维护源码结构信息。

所述对变动的代码进行代码质量分析采用依次使用Checkstyle、FindBugs、Sonar代码质量检测工具进行检测。使用业内统一的标准对代码进行质量分析。

所述更新源代码结构数据的同时，更新代码监控人员信息，作为通过代码变动信息获取监控人员名单及变动代码质量信息接收用户名单的基础。

所述代码质量信息整合与发送中将更新后的源代码数据和变动代码的质量数据按照源代码在SVN服务器上的目录结构整合为HTML格式发送给设定的用户。

数据库存储SVN服务器中软件源代码的相关信息数据表，包括监控人员列表，保存人员id、名称以及email信息；源码结构信息表，保存源码的全路径、源码的父路径id；监控信息表，表中保存了代码目录id与监控人员id的关系；源码变动信息表，保存源码变动时间、变动类型、变动内容和源码目录id；源码质量信息表，保存质量数据，包括质量类型、具体数据、数据产生时间及对应的变动信息id。还存在其他信息表，比如可能存在邮件发送信息表。

本发明的有益之处是：本发明采用与SVN代码服务器直连的方式，可以保证捕获代码所有变动信息，并且进一步缩小了代码检测的范围，提高了代码质量分析的效率；使用Checkstyle、FindBugs、Sonar等代码检测工具对变动代码进行检测，使用业内统一的标准对代码进行质量分析，提高了代码质量分析的全面性、权威性，避免了人为代码质量分析的片面性、局限性；通过更新代码监控人员信息，作为通过代码变动信息获取监控人员名单及变动代码质量信息接收用户名单的基础，使监管人员只需要专注监控自己所负责的部分，提高了代码质量监控的持续性、可追溯性，同时也避免了由于监管人员对***整体认知不够导致的代码监控的片面性、局限性。

附图说明

图1本发明的框架示意图；

图2本发明中代码质量信息整合与发送流程图。

具体实施方式

一种软件代码质量自动监控方法，通过对软件源代码SVN服务器进行监控，定时对软件源代码进行变动扫描和质量分析，及时地将代码质量数据整合发送给监控人员，具体为：

代码变动扫描和质量分析：监控服务器直接连接软件源代码SVN服务器，获取SVN源代码的目录结构，周期性对SVN服务器内SVN库进行变动信息扫描，获取检测周期内的代码变动信息，对变动的代码进行代码质量分析，获取代码的变动信息和其对应的质量数据；

代码质量信息整合与发送：将代码变动信息数据进行解析，更新源代码结构数据，并保存变动代码的质量数据，将其与更新后的源代码数据按照源代码在SVN服务器上的目录结构整合为变动代码质量信息并发送给设定的用户；

数据库存储：将SVN服务器中软件源代码的相关信息保存在数据库中，作为数据基础。

利用上述方法，结合附图对本发明做进一步说明。

如发明内容中所述，本发明主要过程为：代码变动扫描和质量分析，代码质量信息整合与发送，数据库存储。

代码变动扫描和质量分析是通过直接连接软件工程源代码SVN库，周期性对使用SVN命令行工具对SVN服务器进行变动信息扫描，获取检测周期内的代码变动信息，针对变动的代码使用成熟的代码质量分析工具进行代码质量分析，从而获取代码的变动信息和其对应的质量数据。如附图1和附图2中所表示，后台代码质量监控会按照一定的周期，使用SVN命令行工具获取SVN服务器上源码的变动信息。

并且针对源码变动信息进行分析时，可以判断源码变动类型，根据源码变动类型可以得到源码结构的变化，根据这些变化同步维护源码结构信息。

对变动的源码，依次使用Checkstyle、FindBugs、Sonar这些成熟的代码质量检测工具进行检测，使用业内统一的标准对代码进行质量分析，并将检测后的质量数据保存到代码质量信息表中，存储在数据库中。

代码质量信息整合与发送主要过程如附图2中所示，当完成代码变动扫描和质量分析后，要针对代码的变动信息获取对应的质量数据，对源码变动信息和对应的质量数据进行数据整合，可以整合为HTML格式，并对变动的代码与上一版本的代码对比显示，对变化部分进行高亮显示以便用户查看。对代码的质量数据，可以按照质量分析的类别进行分类展示。

对于整理后的数据，根据代码变动信息对应的源码结构信息，获取对应的代码变动信息关系人列表，将数据使用邮件的方式发送给关系人员。

数据库为本发明的实现提供了数据基础。数据库存储SVN服务器中软件源代码的相关信息数据表，包括存储SVN服务器中源代码的目录结构信息，及各目录关注人员设置信息；源代码的变动信息和对应的质量信息；邮件发送信息等。

在监控人员列表中需要保存人员id、名称以及email信息，如下界面：

在源码结构信息表中保存源码的全路径、源码的父路径id,如下界面：

监控信息表中保存了代码目录id与监控人员id的关系，如下界面：

获取源代码不仅要获取当前路径的监控人员id，还要获取父路径监控人员id；源码变动信息表中保存源码变动时间、变动类型、变动内容和源码目录id，如下界面：

源码质量信息表中保存质量数据，包括质量类型、具体数据、数据产生时间及对应的变动信息id，如下界面：

邮件发送信息表中保存邮件发送信息，包含邮件id、邮件内容、收件人、主题、发送状态、创建时间和发送时间，完整保存邮件发送记录，如下界面：

以上数据库内数据表，存储SVN服务器中源代码的目录结构信息，及各目录关注人员设置信息；源代码的变动信息和对应的质量信息；邮件发送信息等。

Claims (5)

1.一种软件代码质量自动监控方法，其特征是通过对软件源代码SVN服务器进行监控，定时对软件源代码进行变动扫描和质量分析，及时地将代码质量数据整合发送给监控人员，具体为：

代码变动扫描和质量分析：监控服务器直接连接软件源代码SVN服务器，获取SVN源代码的目录结构，周期性对SVN服务器内SVN库进行变动信息扫描，获取检测周期内的代码变动信息，对变动的代码进行代码质量分析，获取代码的变动信息和其对应的质量数据；

代码质量信息整合与发送：将代码变动信息数据进行解析，更新源代码结构数据，并保存变动代码的质量数据，将其与更新后的源代码数据按照源代码在SVN服务器上的目录结构整合为变动代码质量信息并发送给设定的用户；

数据库存储：将SVN服务器中软件源代码的相关信息保存在数据库中，作为数据基础。

2.根据权利要求1所述的一种软件代码质量自动监控方法，其特征是所述对变动的代码进行代码质量分析采用依次使用Checkstyle、FindBugs、Sonar代码质量检测工具进行检测。

3.根据权利要求1或2所述的一种软件代码质量自动监控方法，其特征是所述更新源代码结构数据的同时，更新代码监控人员信息，作为通过代码变动信息获取监控人员名单及变动代码质量信息接收用户名单的基础。

4.据权利要求3所述的一种软件代码质量自动监控方法，其特征是所述代码质量信息整合与发送中将更新后的源代码数据和变动代码的质量数据按照源代码在SVN服务器上的目录结构整合为HTML格式发送给设定的用户。

5.根据权利要求4所述的一种软件代码质量自动监控方法，其特征是数据库存储SVN服务器中软件源代码的相关信息数据表，包括监控人员列表，保存人员id、名称以及email信息；源码结构信息表，保存源码的全路径、源码的父路径id；监控信息表，表中保存了代码目录id与监控人员id的关系；源码变动信息表，保存源码变动时间、变动类型、变动内容和源码目录id；源码质量信息表，保存质量数据，包括质量类型、具体数据、数据产生时间及对应的变动信息id。