CN114968819A - 面向微服务持续集成的代码质量问题检测及修复方法 - Google Patents

Abstract

本发明公开了一种面向微服务持续集成的代码质量问题检测及修复方法，应用于信息处理技术领域。在微服务场景下，开发者提交代码后，会触发持续集成流水线，执行本发明方法。本方法包括以下步骤：对代码的多种质量问题进行自动检测，包括代码风格检测、代码安全性检测以及代码单元测试；对检测出的代码部分质量问题进行自动修复；修复完成后将代码质量问题的检测和修复结果统一反馈给开发者。本发明可以自动对代码质量问题进行排查和修复，从而大大提高微服务场景下持续集成开发过程的质量和效率。

Description

面向微服务持续集成的代码质量问题检测及修复方法

技术领域

本发明涉及信息处理技术领域，具体而言，本发明涉及一种面向微服务持续集成的代码质量问题检测及修复方法与系统。

背景技术

微服务是一些协同工作的小而自治的服务。它具有高内聚性和高自治性。微服务根据业务的边界来确定服务的边界。它既是一个独立的实体，也可以作为一个操作系统进程存在。服务之间均通过网络调用进行通信，从而加强服务之间的隔离性，避免紧耦合。微服务场景下，单一应用程序被划分成一组小的服务，服务之间相互协调、相互配合。每个服务运行在其独立的进程中，服务与服务间采用轻量级的通信机制相互沟通。每个服务都围绕着具体业务进行构建，并且能够被独立地部署到生产环境、类生产环境等。通过微服务架构可以将复杂应用进行切分，把一个大而复杂的问题化解为多个小而简单的问题，使用一套小服务来开发单个应用，服务之间采用轻量级的机制相互通信，以实现集中式服务管理。

持续集成是系统持续提供可交付版本软件并且保证软件质量的一种开发方法。随着微服务等新服务技术不断涌现，服务软件从简单同构系统发展为环境开放、场景跨域、业务复杂的服务生态。传统服务理论和技术已经难以实现海量异构服务之间的精准匹配、动态组合和耦合集成。持续集成主张开发成员尽可能早、尽可能快地将各自开发的代码集成起来，每次集成都通过自动化的构建(包括静态代码扫描、编译、自动化测试、发布等)来验证，从而尽早地发现集成错误，避免项目延期或者项目失败的风险。在需求不明确或是频繁性变更时，通过运用持续集成技术，软件产品能时刻处于可工作状态，在任意时间都可以发布和部署。持续集成系统的基本价值在于完全自动化构建和自动化测试。自动化能有利于减少重复过程，以节省时间、费用和工作量。自动化测试相对于传统手工测试效率高、成本低，解决了高重复性测试工作，改变了传统手工测试占用大量项目工程时间的现状，同时能更加充分的测试系统中的各个单元。持续集成系统通过自动化测试，创建了一个快速的质量反馈环，通过早测试、早反馈、早修复来保证软件产品质量。因此，对于微服务这种需要开发多个服务、需求频繁性变更的场景，持续集成是保证软件质量的非常重要的开发方式。

目前，持续集成过程中对代码质量问题检测的方式比较单一，比如只能进行代码风格检测或者代码安全性检测，有的则只能进行单元测试，除此之外很少有工具可以对持续集成过程中检测到的代码质量问题进行自动修复。如果开发者将微服务场景下的代码推送到代码仓库后，能够在持续集成的过程中收到本次更新的比较全面的代码质量问题检测和修复结果，将有利于开发者及时对代码质量问题进行排查和修复，从而大大提高微服务场景下持续集成过程的质量和效率。

发明内容

本发明的目的在于提供一种面向微服务持续集成的代码质量问题检测及修复方法与系统，以力图解决或至少缓解上面存在的问题。

根据本发明的第一个方面，提供一种面向微服务持续集成的代码质量问题检测及修复方法，包括步骤：

在微服务场景下，当开发者将代码推送到代码仓库时，在项目持续集成的过程中，获取该代码的相关信息；

对代码多种质量问题依据检测规范进行自动检测；

对检测到的部分代码质量问题依据修复规范进行自动修复；

将代码质量问题的检测和修复结果统一反馈给开发者。

进一步地，根据本发明的代码质量问题检测及修复方法，代码相关信息包括：项目名称、项目版本、分支名称、代码提交时间、开发者名称等信息。

进一步地，根据本发明的代码质量问题检测及修复方法，对代码质量问题依据检测规范进行自动检测的步骤包括：设置不同编程语言的代码检测规范；确定待检测代码的语言类型；根据待检测代码的语言类型，依据相应的检测规范对代码质量问题进行自动检测。

根据本发明的代码质量问题检测及修复方法，对代码质量问题依据检测规范进行自动检测，包括：代码风格检测；代码安全性检测；代码单元测试。

根据本发明的代码质量问题检测及修复方法，对代码风格进行检测，包括：代码的可靠性检测；代码的可维护性检测；代码的重复率检测。

根据本发明的代码质量问题检测及修复方法，对代码安全性进行检测，包括：代码漏洞的数量检测；代码安全热点的复审。

根据本发明的代码质量问题检测及修复方法，对代码进行单元测试，包括：设置对应代码的测试用例；对代码进行单元测试并记录覆盖率。

进一步地，根据本发明的代码质量问题检测及修复方法，对检测到的部分代码质量问题依据修复规范进行自动修复的步骤包括：设置不同代码质量问题的修复规范；依据对应的修复规范对检测到的部分代码质量问题进行自动修复。

根据本发明的代码质量问题检测及修复方法，对检测到的部分代码质量问题进行自动修复的步骤包括：对所述检测到质量问题的代码文件进行编辑读写操作，扫描到不符合规范的代码时，依据所述修复规范对产生质量问题的代码进行修改。

进一步地，根据本发明的代码质量问题检测及修复方法，将代码质量问题的检测和修复结果统一反馈给开发者的步骤包括：将本次代码质量问题的检测结果，包括所述代码风格检测、代码安全性检测和代码单元测试的结果，以及对代码质量问题自动修复的结果进行合并，统一反馈给开发者。

根据本发明的第二个方面，提供一种面向微服务持续集成的代码质量问题检测及修复系统，包括：代码风格检测模块，代码安全性检测模块，代码单元测试模块，代码自动纠错模块以及代码反馈总览模块。

通过代码风格检测模块，执行代码的风格检测，得到代码可靠性、代码可维护性以及代码重复率检测信息。

通过代码安全性检测模块，执行代码的安全性检测，得到代码漏洞的数量和代码安全热点的复审信息。

通过代码单元测试模块，设置代码的测试用例，并对代码进行单元测试，得到代码覆盖率信息。

通过代码自动纠错模块，对检测到的部分代码质量问题进行自动修复。

通过代码反馈总览模块，获取并合并代码质量问题的检测结果以及代码质量问题的修复结果，并统一反馈给开发者。

有益效果

根据本发明的技术方案，在微服务场景下，开发者提交代码后，在项目持续集成的过程中，系统会获取该代码的相关信息，对代码多种质量问题依据检测规范进行自动检测，并对检测到的部分代码质量问题依据修复规范进行自动修复，最后将代码质量问题的检测和修复结果统一反馈给开发者，从而大大提高微服务场景下持续集成过程的质量和效率。

附图说明

图1为本发明实施例的一种面向微服务持续集成的代码质量问题检测及修复方法的流程图；

图2为本发明实施例的一种面向微服务持续集成的代码质量问题检测及修复系统框图；

图3为本发明实施例的代码质量问题检测及修复结果的反馈样式。

具体实施方式

为使本申请的目的、技术方案和优点更加清楚，下面将结合附图对本申请实施方式作进一步地详细描述。

本发明实施例提供了一种面向微服务持续集成的代码质量问题检测及修复方法，该方法应用于代码质量问题检测及修复系统。代码质量问题检测及修复系统包括代码风格检测模块、代码安全性检测模块、代码单元测试模块、代码自动纠错模块以及代码反馈总览模块；

如图1所示，所述的一种面向微服务持续集成的代码质量问题检测及修复方法包括如下步骤：

步骤S101，在微服务场景下，当开发者将代码推送到代码仓库时，在项目持续集成的过程中，获取该代码的相关信息；

具体地，获取的代码信息包括项目名称、项目版本、分支名称、代码提交时间、开发者名称等信息。应当指出，以上仅列出了部分代码信息，本领域的技术人员可以理解，在实践中，也可以增加其他的信息。

步骤S102，获取到代码信息以后，对代码的多种质量问题依据检测规范进行自动检测。

具体地，获取到项目代码信息之后，需要确定代码的语言类型，然后根据语言类型对应的规范对代码的质量问题进行检测。这里需要调用代码风格检测模块，执行代码的风格检测，得到代码可靠性、代码可维护性以及代码重复率检测信息；还需要调用代码安全性检测模块，执行代码的安全性检测，得到代码漏洞的数量和代码安全热点的复审信息；最后需要调用代码单元测试模块，设置代码的测试用例，并对代码进行单元测试，得到代码覆盖率信息。

具体地，上述的质量问题检测是基于预先配置好的代码规则进行分析和检测。首先将需要进行质量问题检测的项目导入本发明的系统，即对项目名称、项目仓库的url等信息在本系统中进行配置，然后在项目仓库中配置好环境变量以及与持续集成流程相关的配置文件。具体地，该配置文件中需要包含与代码质量相关的一系列静态规则，这也是本系统后续执行质量检测的依据。

具体地，在质量检测的过程中，本发明的系统首先通过配置文件来获取源代码。获取源代码后，会根据指定的代码规则由构建服务器在持续集成的环境中进行分析。当分析完成后，分析结果将存储在数据库中，供将来参考和历史跟踪。最后，可以从web浏览器或仪表板来查看分析报告。

具体地，本发明的系统支持对常见的编程语言进行质量检测。在检测的过程中，会自动计算相关指标，比如代码行数，并验证代码指标是否符合预先配置的代码规则。如果分析的源代码违反了代码规则，或者规则超出了预定义的阈值，就会生成一个“问题”。具体地，本发明的系统检测的内容包括代码风格检测、代码安全性检测以及代码单元测试。其中，代码风格检测包括可靠性、可维护性和重复率检测。可靠性规则，也被命名为“bug”，它会产生问题，表示代码中有错误。可维护性与代码的可读性和可修改性问题相关。重复率表示项目中的重复代码所占的比重，程序中包含大量复制、粘贴的代码将导致代码臃肿。代码安全性检测包括代码漏洞数量检测和安全热点复审。代码漏洞指计算机系统安全方面的缺陷，使得系统或其应用数据的保密性、完整性、可用性、访问控制和监测机制等面临威胁。本发明的系统会根据项目漏洞的数量对其安全性进行评估。安全热点指的是开发人员需要审查的安全敏感代码段。最后，本发明的系统会对项目自动进行单元测试，统计并展示单元测试覆盖率，即覆盖到的代码所占的比重，并将测试代码的覆盖情况反馈给开发人员。

步骤S103，对代码的质量问题进行检测之后，如果检测出质量问题，将对检测到的部分质量问题依据修复规范进行自动修复。

具体地，持续集成流程中使用的配置文件包含与检测和修复两个阶段相关的具体配置。在步骤S102对代码中的质量问题进行检测之后，接下来依据配置好的环境变量以及与持续集成流程相关的配置文件，对检测到的代码问题进行自动修复。

具体地，本发明提供了一个统一的命令行界面来检查和修复项目代码，无论使用的是什么编程语言。检查规则存储在构建仓库中预先写好的配置文件里，允许用户根据特定的质量要求对代码问题进行修复。同时本系统支持以非交互模式运行，这种模式非常适合于持续集成的过程。开发者在提交一份项目代码时，如果代码错误，项目执行出错，则调用代码自动纠错模块，对检测到质量问题的代码文件进行编辑读写操作，扫描到不符合规范的代码时，依据相应的修复规范对产生质量问题的代码进行修改。

具体地，本发明的系统对代码错误进行修复的过程包含三个步骤：错误定位、修复生成和修复验证。首先会对代码故障进行定位，找到出错的文件，出错的代码行号等信息。然后依据配置文件里指定的项目代码需要遵循的规则，通过增加、删除、修改等操作，对错误的变量和语句进行修改，生成相应的修复结果。在得到初步修复后，接下来需要对修复结果进行验证。只有通过验证的修复，才可以反馈给开发者，进而帮助开发者修改完善。这样的过程就实现了智能化的代码自动修复，保障了项目的持续集成。

步骤S104，基于代码质量问题的检测结果以及代码质量问题的修复结果，生成相应的反馈返回给开发者。

具体地，通过代码反馈总览模块，获取并合并代码质量问题的检测结果以及代码质量问题的修复结果，并统一反馈给开发者。图3为本发明实施例的一种代码质量问题检测及修复结果的反馈样式。

本发明的实施例提供了一种面向微服务持续集成的代码质量问题检测及修复方法，在微服务场景下，开发者提交代码后，在项目持续集成的过程中，系统会获取该代码的相关信息，对代码多种质量问题依据检测规范进行自动检测，并对检测到的部分代码质量问题依据修复规范进行自动修复，最后将代码质量问题的检测和修复结果统一反馈给开发者。与现有的技术相比，本发明不仅可以自动检测代码的质量问题，还可以对检测到的部分质量问题进行自动修复，从而大大提高微服务场景下持续集成过程的质量和效率。

图2为本申请实施例提供的一种面向微服务持续集成的代码质量问题检测及修复系统，该系统20包括：代码风格检测模块201、代码安全性检测模块202、代码单元测试模块203、代码自动纠错模块204以及代码反馈总览模块205。

代码风格检测模块201，执行代码的风格检测，得到代码可靠性、代码可维护性以及代码重复率检测信息。

代码安全性检测模块202，执行代码的安全性检测，得到代码漏洞的数量和代码安全热点的复审信息。

代码单元测试模块203，设置代码的测试用例，并对代码进行单元测试，得到代码覆盖率信息。

代码自动纠错模块204，对检测到的部分代码质量问题进行自动修复。

代码反馈总览模块205，获取并合并代码质量问题的检测结果以及代码质量问题的修复结果，并统一反馈给开发者。

本发明的实施例提供了一种面向微服务持续集成的代码质量问题检测及修复系统，在微服务场景下，开发者提交代码后，在项目持续集成的过程中，系统会获取该代码的相关信息，对代码多种质量问题依据检测规范进行自动检测，并对检测到的部分代码质量问题依据修复规范进行自动修复，最后将代码质量问题的检测和修复结果统一反馈给开发者。与现有的技术相比，本发明不仅可以自动检测代码的质量问题，还可以对检测到的部分质量问题进行自动修复，从而大大提高微服务场景下持续集成过程的质量和效率。

尽管上面对本发明说明性的具体实施方式进行了描述，以便于本技术领域的技术人员理解本发明，且应该清楚，本发明不限于具体实施方式的范围，对本技术领域的普通技术人员来讲，只要各种变化在所附的权利要求限定和确定的本发明的精神和范围内，这些变化是显而易见的，一切利用本发明构思的发明创造均在保护之列。

Claims (10)

1.一种面向微服务持续集成的代码质量问题检测及修复方法，其特征在于，包括步骤：

在微服务场景下，当开发者将代码推送到代码仓库时，在项目持续集成的过程中，获取该代码的相关信息；

对代码的多种质量问题依据检测规范进行自动检测；

对检测到的部分代码质量问题依据修复规范进行自动修复；

将代码多种质量问题的检测和修复结果统一反馈给开发者。

2.如权利要求1所述的一种面向微服务持续集成的代码质量问题检测及修复方法，其中，所述的代码的相关信息包括：项目名称、项目版本、分支名称、代码提交时间、开发者名称信息。

3.如权利要求1所述的一种面向微服务持续集成的代码质量问题检测及修复方法，其中，所述对代码的多种质量问题依据检测规范进行自动检测的步骤包括：

设置不同编程语言的代码检测规范；

确定待检测代码的语言类型；

根据待检测代码的语言类型，依据相应的检测规范对代码多种质量问题进行自动检测。

4.如权利要求3所述的一种面向微服务持续集成的代码质量问题检测及修复方法，其特征在于，所述对代码多种质量问题依据检测规范进行自动检测，包括：

代码风格检测；

代码安全性检测；

代码单元测试。

5.如权利要求4所述的一种面向微服务持续集成的代码质量问题检测及修复方法，其特征在于，所述代码风格检测，包括：

代码的可靠性检测；

代码的可维护性检测；

代码的重复率检测。

6.如权利要求4所述的一种面向微服务持续集成的代码质量问题检测及修复方法，其特征在于，所述代码安全性检测，包括：

代码漏洞的数量检测；

代码安全热点的复审。

7.如权利要求4所述的一种面向微服务持续集成的代码质量问题检测及修复方法，其特征在于，所述代码单元测试，包括：

设置对应代码的测试用例；

对代码进行单元测试并记录覆盖率。

8.如权利要求1所述的一种面向微服务持续集成的代码质量问题检测及修复方法，其中，所述对检测到的部分代码质量问题依据修复规范进行自动修复的步骤包括：

设置不同代码质量问题的修复规范；

依据对应的修复规范对检测到的部分代码质量问题进行自动修复；

对检测到质量问题的代码文件进行编辑读写操作，扫描到不符合规范的代码时，依据修复规范对产生质量问题的代码进行修改。

9.如权利要求1所述的一种面向微服务持续集成的代码质量问题检测及修复方法，其中，所述将代码质量问题的检测和修复结果统一反馈给开发者的步骤包括：

将本次代码质量问题的检测结果，包括所述代码风格检测、代码安全性检测和代码单元测试的结果，以及对代码质量问题自动修复的结果进行合并，统一反馈给开发者。

10.一种面向微服务持续集成的代码质量问题检测及修复系统，其特征在于，该系统包括：

代码风格检测模块，用于执行所述代码风格检测，得到所述代码可靠性、代码可维护性以及代码重复率；

代码安全性检测模块，用于执行所述代码安全性检测，得到所述代码漏洞的数量和代码安全热点的复审信息；

代码单元测试模块，用于设置所述测试用例，并对代码进行单元测试，得到所述代码覆盖率；

代码自动纠错模块，用于对所述检测到的部分代码质量问题进行自动修复；

代码反馈总览模块，用于获取并合并所述代码质量问题的检测结果以及代码质量问题的修复结果，并统一反馈给开发者。

Images