CN117194264A - 一种代码诊断信息方法及其管理系统、存储介质 - Google Patents

Abstract

本发明涉及一种代码诊断信息方法及其管理系统、存储介质，属于软件开发测试领域，包括以下步骤：对诊断信息进行统计和展示；跟踪诊断信息的状态变更情况，并通知相关端口；配置诊断信息状态变更审核流程，并通过一定的配置来自动推进流程；根据诊断信息的类型和状态执行相应的自动化处理任务。本发明的管理系统包括项目配置模块、分析工具调用模块、诊断模块、流程审核模块、后续处理模块、开发者模块等，以实现对代码诊断信息的集中展示、跟踪、审核和处理。本发明可以提高代码质量和分析工具的易用性。

Description

一种代码诊断信息方法及其管理系统、存储介质

技术领域

本发明属于软件开发测试领域，特别是涉及一种代码诊断信息方法及其管理系统、存储介质。

背景技术

随着软件应用越来越广泛地应用于各个领域，软件应用的安全问题也越来越突出，给用户和开发方带来了巨大的风险和损失。为了提高软件应用的安全防护能力，软件开发方在开发过程中需要遵循一定的开发规范和质量要求，同时也需要对代码进行质量检查和评审，以发现并修复代码中的潜在问题。

代码分析工具是一种常用的代码质量检查和评审的手段，它可以从多个方面对代码进行静态或动态的分析，如可靠性、安全性、可维护性等，并将分析结果以诊断信息的形式呈现给开发者。诊断信息是代码分析工具对代码中存在的问题的描述和建议，它通常包含了问题的类型、位置、严重程度、影响范围等信息，开发者需要根据诊断信息对代码进行相应的修复或优化。

然而，并不是所有的诊断信息都是真实有效的，有些诊断信息可能是分析工具设计或实现上的缺陷导致的误报，有些诊断信息可能是开发者有意为之或者不值得处理的，因此，开发者还需要对诊断信息进行进一步的排查和确认，以决定诊断信息的后续处理方式。

为了规范和简化诊断信息的处理流程，本发明提出了一种诊断信息的方法和管理系统，能够对使用分析工具扫描代码生成的诊断信息进行集中展示、跟踪、审核和处理，以提高代码质量和分析工具的易用性。

发明内容

本发明的目的在于提供一种代码诊断信息方法及其管理系统、存储介质，解决了代码分析工具易用性差的问题。

为解决上述技术问题，本发明是通过以下技术方案实现的：

一种代码诊断信息方法，包括以下步骤：

对一个或者多个分析工具扫描代码得到的诊断信息进行统计，利用诊断信息相关的数据来评价项目代码质量；

通过输出端展示一个或者多个分析工具扫描代码得到的诊断信息，以及利用诊断信息相关的数据来评价项目代码质量；

跟踪诊断信息的状态变更情况，并通过数据库记录诊断信息的状态变更历史，以及通过邮件、短信、消息推送等方式通知相关端口诊断信息的状态变更情况；

配置诊断信息状态变更审核流程，并通过一定的配置来自动推进流程；

根据诊断信息的类型和状态执行相应的自动化处理任务。

一种代码诊断信息管理系统，包括以下模块：

项目配置模块：该模块由项目质量管理干系端口操作，用于配置诊断信息管理系统的项目、端口、人员角色等信息，同时可以配置诊断信息处理流程和自动触发条件，并可以参与到流程审核工作中；

分析工具调用模块：该模块由分析工具使用端口操作，用于调用一个或多个分析工具扫描代码生成诊断信息，并将诊断信息发送给展示模块和跟踪模块；

展示模块：该模块用于通过输出端展示一个或者多个分析工具扫描代码得到的诊断信息，以及利用诊断信息相关的数据来评价项目代码质量；

跟踪模块：该模块用于跟踪诊断信息的状态变更情况，并通过数据库记录诊断信息的状态变更历史，以及通过邮件、短信、消息推送等方式通知相关端口诊断信息的状态变更情况；

诊断模块：该模块由诊断信息初审人操作，用于对诊断信息做初步确认，对需要确认处理、误报或者不处理的诊断信息发起对应的审核流程；

流程审核模块：该模块由流程审核端口操作，用于在诊断信息管理系统中负责审批诊断信息状态变更审核流程的审批任务；

后续处理模块：该模块由流程后续处理端口操作，用于在诊断信息管理系统中基于诊断信息流程中的审批任务审批通过后确认最终状态，指定后续处理方式；

开发者模块：该模块由开发者操作，用于在开发代码，修复确认处理的诊断信息

有益效果：

1、本发明通过一定的配置来自动推进诊断信息状态变更的审核流程，包括确认处理、误报和不处理三种类型的流程，以及对应的自动化处理任务，如分配修复人员、更新分析工具规则；

2、本发明还提出了在诊断信息管理系统中持续跟踪诊断信息流程进度和最新状态，以及利用诊断信息相关的数据来评价项目代码质量的方法；

3、本发明还提出了对于一个流程环节有多个审批端口时，如何配置审批通过的条件和权重，以及如何区分不同层级和角色的审批端口；

4、本发明还提出了在诊断信息审核流程中，可以提出对诊断信息的建议和指出规则实现的缺陷，以优化分析工具的功能、性能和易用性。

当然，实施本发明的任一产品并不一定需要同时达到以上所述的所有优点。

附图说明

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

图1为本公开实施例诊断信息管理系统图；

图2为本公开实施例诊断信息状态变更审批流程图；

图3为本公开实例施诊断信息引入人确认方法图；

图4为本公开实施例诊断信息误报、不处理审核流程自动化配置流程图；

图5为本公开实例施误报审核通过后的自动化处理流程图；

图6为本公开实例施不处理审核通过后的自动化处理流程图。

具体实施方式

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

在本发明的描述中，需要理解的是，术语“开孔”、“上”、“下”、“厚度”、“顶”、“中”、“长度”、“内”、“四周”等指示方位或位置关系，仅是为了便于描述本发明和简化描述，而不是指示或暗示所指的组件或元件必须具有特定的方位，以特定的方位构造和操作，因此不能理解为对本发明的限制。

实施例1，本发明提出一种代码诊断信息方法。该方法包括以下步骤：

对一个或者多个分析工具扫描代码得到的诊断信息进行统计，利用诊断信息相关的数据来评价项目代码质量；

通过输出端展示一个或者多个分析工具扫描代码得到的诊断信息，以及利用诊断信息相关的数据来评价项目代码质量；

进一步地可以以图表或报告的形式展示给用户。可以通过网页、客户端或移动端等方式访问诊断信息管理系统的用户界面，查看、筛选、排序、搜索、导出等操作诊断信息，也可以查看项目代码质量的评级和趋势等信息。

跟踪诊断信息的状态变更情况；

进一步地，诊断信息的状态包括打开、确认处理审核中、确认处理、修复完成关闭、误报审核中、确认误报关闭、不处理审核中、确认不处理并关闭等。

通过数据库记录诊断信息的状态变更历史，以及通过邮件、短信、消息推送等方式通知相关端口诊断信息的状态变更情况。在诊断信息管理系统中持续跟踪诊断信息流程进度和最新状态，以便用户及时了解和处理诊断信息。

进一步地，所述诊断信息管理系统包括如下模块：

项目配置模块：该模块由项目质量管理干系端口操作，用于配置诊断信息管理系统的项目、端口、人员角色等信息，同时可以配置诊断信息处理流程和自动触发条件，并可以参与到流程审核工作中；

分析工具调用模块：该模块由分析工具使用端口操作，用于调用一个或多个分析工具扫描代码生成诊断信息，并将诊断信息发送给展示模块和跟踪模块；

诊断模块：该模块由诊断信息初审人操作，用于对诊断信息做初步确认，对需要确认处理、误报或者不处理的诊断信息发起对应的审核流程；

流程审核模块，该模块由流程审核端口操作，用于在诊断信息管理系统中负责审批诊断信息状态变更审核流程的审批任务；

后续处理模块，该模块由流程后续处理端口操作，用于在诊断信息管理系统中基于诊断信息流程中的审批任务审批通过后确认最终状态，指定后续处理方式；

开发者模块，该模块由开发者操作，用于在开发代码，修复确认处理的诊断信息。

配置诊断信息状态变更审核流程；

本公开实施例诊断信息状态变更审批流程图；

通过一定的配置来自动推进流程，如诊断信息认为是否确认修复、是否为误报、是否为不需要处理时通过审核流程来规范诊断信息状态的变更。

项目质量管理干系端口可以根据项目的特点和需求，自定义设置诊断信息状态变更审核流程的步骤、条件、触发器、审批端口、审批方式等参数，以及一个流程环节有多个审批端口时的审批通过条件和权重，以及不同层级和角色的审批端口。还可以根据分析工具提供的规则库，选择或定制适合自己项目的分析规则和规则配置，并根据用户对诊断信息的反馈，更新分析工具规则库及规则配置。

进一步地，诊断信息状态变更审核流程可以包括以下的一种或者多种；

确认处理审核流程：诊断信息认为需要修复时，发起确认处理审核流程；

误报审核流程：诊断信息认为误报时，发起误报审核流程；

确认不处理审核流程：诊断信息认为不需要处理时，发起确认不处理审核流程；

根据诊断信息的类型和状态执行相应的自动化处理任务，在诊断信息管理系统中持续跟踪诊断信息流程进度和最新状态

如分配修复端口员、更新分析工具规则等。根据配置模块设置的参数，自动触发相应的处理任务，并调用分析工具或其他外部系统完成任务。在诊断信息审核流程中接收对诊断信息的建议和指出规则实现的缺陷，以优化分析工具的功能、性能和易用性。

本发明提供了以下几种类型的诊断信息状态：

打开：通过分析工具扫描代码生成的诊断信息初始状态，或者没有通过诊断信息审核流程后，状态重置为打开状态；

确认处理审核中：诊断信息初审端口初步确认诊断信息需要修复，发起确认处理审核流程后，诊断信息状态变为确认处理审核中；

确认处理：通过诊断信息确认处理审核流程后，状态变为确认处理；

修复完成关闭：诊断信息认定为确认处理，开发者修复完成后，状态变为修复完成关闭；

误报审核中：诊断信息初审端口初步确认诊断信息为误报，发起误报审核流程后，诊断信息状态变为误报审核中；

确认误报关闭：通过诊断信息误报审核流程后，状态变为确认误报关闭；

不处理审核中：诊断信息初审端口初步确认诊断信息为不需要处理，发起不处理审核流程后，诊断信息状态变为不处理审核中；

确认不处理关闭：通过诊断信息不处理审核流程后，状态变为确认不处理关闭。

在一些公开中，所述的方法通过一定的配置来自动推进流程，在不同流程里面自动化的配置情况如下：

诊断信息确认处理流程中自动化配置示例1：审批通过后可以设置自动分配给诊断信息问题引入端口去做修复工作，诊断信息引入端口确认方法如图3所示：

诊断信息对应的问题代码区域，可能是单行或者多行，也可能存在关联的其他文件区域，基于这些代码区域，可以通过代码管理系统查询对应代码区域的最后变更端口。如果诊断信息相关的代码区域变更端口只有一个，可以把此端口直接认定为问题引入端口；如果诊断信息相关的代码区域变更端口不止一个，可以有如下两种方式来确认问题引入端口，一种是依据代码变更时间的先后来判断，把变更时候最新的变更端口认定为问题引入端口，一种是依据有效代码量的多少来判定，把有效代码量最多的变更端口认定为问题引入端口。问题引入端口确认后就可以分配修复工作。

诊断信息确认处理流程自动化配置示例2：可以设置依据诊断信息出现的代码所属模块，自动分配给模块开发负责端口，模块开发负责端口进一步分配给修复的开发者，可以依据代码目录分配各个模块的开发负责端口；

比如项目目录结构如下:

/root/path1

/root/path1/file1

/root/path2

/root/path2/file2

可以配置/root/path1的开发负责端口为user1，配置/root/path2的开发负责端口为user2；

/root/path1目录下包含子目录文件的诊断信息在确认处理审核流程中先分配给user1，user1再去具体分配给开发者developer1去修复；

/root/path2目录下包含子目录文件的诊断信息在确认处理审核流程中先分配给user2，user2再去具体分配给开发者developer2去修复。

诊断信息误报审核流程和不处理审核流程中自动化配置示例：依据代码所属模块自动分配给模块审核端口审核，模块审核端口的配置方式可以参照上述的模块开发负责端口的配置方法，或者依据诊断信息严重等级配置来判断是否自动审批通过。

诊断信息误报、不处理审核流程自动化配置的示例：

在认定诊断信息为误报或者不处理审核流程中，可以先依据诊断信息严重等级，确认是否需要进一步审核，严重等级低的诊断信息可以不需要进一步审核并直接认定为误报或者不处理，严重等级中、高的诊断信息可以依据诊断信息代码区域所属的模块，自动分配给对应的模块审批端口继续审批。

审核流程的单个任务节点可以有多个审批端口，任务审核的通过条件举例如下：

依次审批，全部同意通过，中间有一个不同意，审批不通过

不分顺序，可以同时审批，所有端口同意才审核通过；

不分顺序，有n端口同意，审核通过；

不分顺序，同意端口数达到一定比例后同意，审核通过；

有n端口不同意，流程打回；

以上条件可以组合配置，例如：达到一定比例后审核通过，但同时如果有一个端口不同意，流程打回。

审核流程的单个任务节点有多个审批端口时，还可以配置不同审批端口的审批权重，基于不同审批端口的权重，并结合上面多个审批端口通过的条件同时配置，审批任务通过条件举例如下：

user1权重n1，user2权重n2，user3权重n3，同时审批时，当审批权重达到n时，审批通过。

可以在误报审核流程中确认误报类型，来自动化配置误报审核通过后的自动化处理任务；

诊断信息误报类型有多种，这里列举常见的误报类型，对这些误报类型选择性配置审核通过后的自动化处理任务。在处理因为分析工具的规则本身的异常导致的误报，这种规则影响的范围较大且不易调整，可以选择把相同规则对应的诊断信息统一设置为误报，或者把当前规则从总的分析规则中过滤掉，后续的代码分析不再使用当前规则检查代码；在处理因为规则配置的问题导致的误报，可以重新配置规则，让规则符合开发质量的要求。

可以在不处理审核流程中确认不处理类型，来自动化配置不处理审核通过后的自动化处理任务，示例图：

诊断信息不处理类型有多种，这里列举常见的不处理类型，对这些不处理类型选择性配置审核通过后的自动化处理任务。在因为开发框架自身的问题选择不处理，主要是开发框架的选用比较重要且不易更换，可以把相同规则对应的诊断信息统一设置为不处理，或者把当前规则从总的分析规则中过滤掉，后续的代码分析不再使用当前规则检查代码；在因为修复难度大，在当前开发阶段不好修复的问题选择不处理，可以先认定不处理，后面有时间再去修复。

在诊断信息管理系统中可以持续跟踪诊断信息流程进度和最新状态，可以查询诊断信息的状态变更记录，可以查询诊断信息状态变更审批流程的进度。

本发明诊断信息中包含了除诊断信息的严重程度，可能还有诊断信息的类型，影响范围，性能影响等附加信息，这些都可以作为工作流审核自动化配置的依据，旨在区分不同的诊断信息自动化推进的方式；

现有的诊断信息管理系统对诊断信息状态变更的管理，集中在诊断信息状态的变更，以及流程的审核的自动化配置和推进，而这些诊断信息状态变更的记录数据、诊断信息修复的数据和流程处理的数据等都可以作为项目代码质量评价的依据；

现有的诊断信息审核流程的参与者，分为诊断信息初审端口，审批端口和后续处理端口，还可以依据各个项目团队的情况，进一步把审批端口和后续处理端口区分层级，从而实现先后的审核关系，多个层级的审核步骤中都可以有自动化推进的方式；

诊断信息误报、不处理审核流程后续步骤不仅限于依据误报和不处理类型做进一步处理，在诊断信息流程审核时，以及开发者在修复诊断信息的问题时，还可以提出对诊断信息的建议和指出规则实现的缺陷，以此来优化分析工具的功能、性能和易用性。

实施例2：如图1-图6所示，一种代码诊断信息的处理方法，包括以下几个步骤：

第一步，对一个或者多个分析工具扫描代码得到的诊断信息进行统计，利用诊断信息相关的数据来评价项目代码质量。

可以统计诊断信息的数量、类型、严重等级、分布、变化趋势等数据，并根据这些数据计算项目代码质量的评级和指标。

第二步，通过输出端展示一个或者多个分析工具扫描代码得到的诊断信息，以及利用诊断信息相关的数据来评价项目代码质量。

可以通过网页、客户端或移动端等方式访问诊断信息管理系统的用户界面，查看、筛选、排序、搜索、导出等操作诊断信息，也可以查看项目代码质量的评级和趋势等信息。还可以以图表或报告的形式展示给用户，方便用户直观地了解项目代码质量的状况和改进方向。

第三步，跟踪诊断信息的状态变更情况，并通过数据库记录诊断信息的状态变更历史，以及通过邮件、短信、消息推送等方式通知相关端口诊断信息的状态变更情况。在诊断信息管理系统中持续跟踪诊断信息流程进度和最新状态，以便用户及时了解和处理诊断信息。

进一步地,当诊断信息由打开状态变为确认处理审核中状态时，可以通知相应的流程审核端口进行审批；当诊断信息由确认处理状态变为修复完成关闭状态时，发送通知给相应的项目质量管理端口进行确认。

第四步，配置诊断信息状态变更审核流程，并通过一定的配置来自动推进流程。项目质量管理干系端口可以根据项目的特点和需求，自定义设置诊断信息状态变更审核流程的步骤、条件、触发器、审批端口、审批方式等参数，以及一个流程环节有多个审批端口时的审批通过条件和权重，以及不同层级和角色的审批端口。还可以根据分析工具提供的规则库，选择或定制适合自己项目的分析规则和规则配置，并根据用户对诊断信息的反馈，更新分析工具规则库及规则配置。

在确认处理审核流程中可以设置自动分配给诊断信息问题引入端口或者模块开发负责端口去做修复工作；在误报审核流程中可以设置自动把相同规则对应的诊断信息统一设置为误报，或者把当前规则从总的分析规则中过滤掉；在不处理审核流程中可以设置先认定不处理，后面有时间再去修复。

第五步，根据诊断信息的类型和状态执行相应的自动化处理任务，在诊断信息管理系统中持续跟踪诊断信息流程进度和最新状态。根据配置模块设置的参数，自动触发相应的处理任务，并调用分析工具或其他外部系统完成任务。在诊断信息审核流程中接收对诊断信息的建议和指出规则实现的缺陷，以优化分析工具的功能、性能和易用性。

当诊断信息被确认为误报时，可以调用分析工具的接口，将诊断信息的规则标记为无效，或者将诊断信息的规则从分析工具的规则库中删除；当诊断信息被确认为需要修复时，可以调用代码管理系统的接口，将诊断信息的问题代码区域标记为待修复，或者将诊断信息的问题代码区域提交给开发者进行修复。

该方法可以有效地管理和跟踪分析工具扫描代码得到的诊断信息，以及利用诊断信息相关的数据来评价项目代码质量。

实施例3：本发明的实施例提供了一种存储介质，该存储介质存储有代码诊断信息的处理程序，该处理程序在执行时实现以下功能：

对一个或者多个分析工具扫描代码得到的诊断信息进行统计，利用诊断信息相关的数据来评价项目代码质量；

通过输出端展示一个或者多个分析工具扫描代码得到的诊断信息，以及利用诊断信息相关的数据来评价项目代码质量；

跟踪诊断信息的状态变更情况，并通过数据库记录诊断信息的状态变更历史，以及通过邮件、短信、消息推送等方式通知相关端口诊断信息的状态变更情况；

配置诊断信息状态变更审核流程，并通过一定的配置来自动推进流程；

根据诊断信息的类型和状态执行相应的自动化处理任务。

本发明的实施例还提供了一种系统，该系统包括上述存储介质，以及与之连接的输入端、输出端、数据库、分析工具、代码管理系统等设备或模块，以实现对代码诊断信息的有效管理和跟踪。

在本说明书的描述中，参考术语“一个实施例”、“示例”、“具体示例”等的描述意指结合该实施例或示例描述的具体特征、结构、材料或者特点包含于本发明的至少一个实施例或示例中。在本说明书中，对上述术语的示意性表述不一定指的是相同的实施例或示例。而且，描述的具体特征、结构、材料或者特点可以在任何的一个或多个实施例或示例中以合适的方式结合。

以上公开的本发明优选实施例只是用于帮助阐述本发明。优选实施例并没有详尽叙述所有的细节，也不限制该发明仅为所述的具体实施方式。显然，根据本说明书的内容，可作很多的修改和变化。本说明书选取并具体描述这些实施例，是为了更好地解释本发明的原理和实际应用，从而使所属技术领域技术人员能很好地理解和利用本发明。本发明仅受权利要求书及其全部范围和等效物的限制。

Claims (10)

1.一种代码诊断信息方法，其特征在于，包括以下步骤：

对一个或者多个分析工具扫描代码得到的诊断信息进行统计；

跟踪诊断信息的状态变更情况，并通过数据库记录诊断信息的状态变更历史，通知相关端口诊断信息的状态变更情况；

配置诊断信息状态变更审核流程，自动推进流程推进；

根据诊断信息的类型和状态执行相应的自动化处理任务。

2.根据权利要求1所述的一种代码诊断信息方法，其特征在于，所述诊断信息相关的数据包括诊断信息的数量、类型、严重等级、分布、变化趋势，并根据这些数据计算项目代码质量的评级和指标。

3.根据权利要求1所述的一种代码诊断信息方法,其特征在于，所述诊断信息状态包括如下状态：打开、确认处理审核中、确认处理、修复完成关闭、误报审核中、确认误报关闭、不处理审核中、确认不处理并关闭。

4.根据权利要求1所述的一种代码诊断信息方法,其特征在于，所述配置诊断信息状态变更审核流程包括配置诊断信息状态变更审核流程的步骤、条件、触发器、审批端口、审批方式，以及一个流程环节有多个审批端口时的审批通过条件和权重，以及不同层级和角色的审批端口。

5.根据权利要求1所述的一种代码诊断信息方法,其特征在于，所述自动推进流程包括以下方式的一种或者多种：

确认处理审核流程：诊断信息认为需要修复时，发起确认处理审核流程；

误报审核流程：诊断信息认为误报时，发起误报审核流程；

确认不处理审核流程：诊断信息认为不需要处理时，发起确认不处理审核流程。

6.根据权利要求1所述的一种代码诊断信息方法,其特征在于，所述方法在确认处理审核流程中设置自动分配给诊断信息问题引入端口或者模块开发负责端口去进行修复；

误报审核流程中设置自动把相同规则对应的诊断信息统一设置为误报，或者把当前规则从总的分析规则中过滤掉；

在不处理审核流程中设置先认定不处理，过程中随时修复。

7.根据权利要求1所述的一种代码诊断信息方法,其特征在于，所述方法在诊断信息审核流程中接收对诊断信息的建议和指出规则实现的诊断信息的规则的实时优化。

8.根据权利要求1所述的一种代码诊断信息方法,其特征在于，所述输出端是网页、客户端或移动端其中的一种或多种。

9.一种存储介质，其特征在于，所述存储介质存储有代码诊断信息的处理程序，该处理程序在执行时实现权利要求1-8中任一项所述的方法。

10.一种代码诊断信息管理系统，其特征在于，所述系统包括如下模块：

分析工具调用模块：用于对一个或者多个分析工具扫描代码得到的诊断信息进行统计；

跟踪模块：用于跟踪诊断信息的状态变更情况，并通过数据库记录诊断信息的状态变更历史；

诊断模块：配置诊断信息状态变更审核流程，自动推进流程推进；

后续处理模块：用于根据诊断信息的类型和状态执行相应的自动化处理任务。