代码检查 CODEARTS CHECK-CodeArts Check最佳实践汇总

时间:2025-06-10 12:04:32

CodeArts Check最佳实践汇总

本文汇总了基于代码检查服务(CodeArts Check)常见应用场景的操作实践,为每个实践提供详细的方案描述和操作指导,帮助用户轻松检查代码。

表1 CodeArts Check最佳实践一览表

最佳实践

说明

使用预置规则检查GitCode代码仓中的代码质量

如果您的代码存放在GitCode代码仓中,可参考本实践的操作指导完成检查代码质量。本实践为您介绍如何使用系统预置规则检查GitCode代码仓中的Java语言代码质量。

使用预置规则检查通用Git代码仓中的代码质量

如果您的代码存放在通用Git代码仓中,可参考本实践的操作指导完成检查代码质量。本实践为您介绍如何使用系统预置规则检查通用Git代码仓中的Java语言代码质量。

使用自定义规则检查CodeArts Repo代码仓中的代码质量

随着现在项目的代码量越来越大,以及现有开发框架的增加,静态分析所需要覆盖的场景也日益增多,存在的问题如下:

  • 传统静态分析引擎靠工具提供通用规则来对常见安全,风格和质量场景下的编码问题进行扫描分析,难以实时覆盖不同用户特定场景下的代码问题。
  • 用户往往不熟悉工具提供的通用规则所能覆盖的全部场景。在为新开发的业务场景寻找适用的规则时需要耗费大量的时间,增加开发成本。
  • 不同用户之间的代码差异大,研发无法实时掌握不同用户的具体需求,在开发规则过程中难以针对不同用户的业务代码场景来制定全面有效的工具规则。

本示例为您介绍如何使用自定义规则检查代码中存在调试代码的问题。

不上传代码到云服务的情况下使用代码检查服务

部分用户的代码有严格的保密机制,不允许将代码上传到外部网络,用户希望仅在信任的自有执行机上完成代码扫描服务。华为云CodeArts Check为此提供本实践的扫描方案,在不上传代码到云服务的情况下使用代码检查服务检查代码问题。

使用自定义执行机执行代码检查任务

当CodeArts Check提供的内置执行机不满足业务要求时,您可接入自行提供的执行机,通过注册的方式托管到CodeArts Check服务中,委托CodeArts Check服务进行调度并执行代码检查任务。本实践我们通过检查CodeArts Repo代码仓的代码问题来演示使用自定义执行机执行代码检查任务。

CodeArts Check通过调用API执行MR增量检查

本示例介绍如何通过调用CodeArtsCheck API方式,执行MR增量代码检查并获取检查结果。通过调用CodeArtsCheck API可以不使用华为云前端,从而构建自己的全流程代码质量管控平台,同时也可以实现对非Codearts Repo代码仓的门禁级检查。本示例将以通用Git为例,进行方案介绍。

使用Jenkins插件集成CodeArts Check执行代码检查

利用Jenkins工具现有能力,实现代码检查服务的快速集成,包含执行检查、状态查询、报告输出等基本扫描流程。用户可根据基础方案进行自定义开发。

本文介绍如何通过Jenkins工具及CodeArtsCheck API,实现代码检查服务集成与调度。本示例将以通用Git为例,进行方案介绍。

HE2E DevOps实践之代码检查

本文以“DevOps全流程示例项目”为例,介绍如何在项目中进完成代码检查配置。

support.huaweicloud.com/bestpractice-codecheck/codeartscheck_14_0000.html