DevCloud实践体验操作流程4-代码检查

上一篇内容DevCloud实践体验操作流程3-开发代码为大家介绍了代码开发-使用分支管理代码、使用CloudIDE修改和提交代码 以及 检视代码、合并分支。
本文内容关于：代码检查-预置代码检查任务简介、配置并执行代码检查任务、查看代码检查结果 以及 代码检查插件。

1. 代码检查CodeCheck 是基于云端实现代码质量管理的服务，软件开发者可在编码完成后执行多语言的代码静态检查（包括代码质量、代码风格等）和安全检查，获取全面的质量报告，并提供缺陷的改进建议和趋势分析，有效管控代码质量，帮助产品成功。概览链接：https://www.huaweicloud.com/product/codecheck.html
2. CodeCheck代码检查插件致力于守护开发人员代码质量，成为开发人员的助手和利器。秉承极简、极速、即时看护的理念，提供业界规范（含华为云）的检查、代码风格一键格式化及代码自动修复功能。当前支持在华为线上CloudIDE上直接安装使用，下载安装到本地VSCode IDE上（规划10月上线VSCode IDE插件市场）。
   2.1 CloudIDE插件链接：https://marketplace.ide.huaweicloud.com/plugin/f8d1b76e-0826-408a-8506-1f33f7f008e5/overview；
   华为云CodeCheck代码检查插件（CloudIDE版本）使用指南：https://bbs.huaweicloud.com/blogs/320842
   2.2 VSCodeIDE插件链接：https://marketplace.visualstudio.com/items?itemName=HuaweiCloud.codecheck
   或则可以直接在VSCode IDE编辑器里搜索“CodeCheck 代码检查”或则“CodeCheck”就可以看到我们华为云CodeCheck 代码检查插件。
   华为云CodeCheck代码检查插件（VSCode IDE版本）使用指南：https://bbs.huaweicloud.com/blogs/381498

4、代码检查

随着凤凰商城项目越来越庞大，线上出现的缺陷以及安全问题也越来越多，修复成本太大；且开发人员写代码也比较随性，没有统一的标准。因此项目经理Eva建议制定一些针对代码的标准，并对代码进行持续的静态代码扫描，一旦发现问题可以立即在代码层面迭代内修复。

通过本文，我们将了解开发人员Oliver如何使用代码检查服务来完成针对不同技术栈的代码静态扫描、问题收集与修复。

代码检查-预置代码检查任务简介

我们的项目中已经预置了4个代码检查任务：

点击页面侧边栏的代码检查，会显示预置的4个任务：

配置并执行代码检查任务

本小节以任务“phoenix-codecheck-worker”为例进行讲解；开发人员Oliver可以对样例项目中预置的代码检查任务做一些简单的配置，比如增加Python语言检查规则集，使检查更全面。

在列表中找到预置的任务“phoenix-codecheck-worker”：

单击任务名称进入详情页，选择“设置”页签；接着单击页面左侧导航“规则集”，规则集中默认包含的语言是“Java”；然后增加Python语言检查规则集（将Python语言对应的开关打开，在弹框中单击“确定”）：

接着，就可以执行代码检查任务了。单击页面右上角的“开始检查”按钮，启动代码检查任务（页面上方会显示进度条）；当页面提示“分支"master"最近一次检查成功！”，表示任务执行成功：

注：若任务执行失败，则页面右上角将弹出报错提示，请参考代码检查常见问题排查

查看代码检查结果

代码检查服务提供检查结果统计，并对检查出的问题会提供修改建议，用户可以根据修改建议优化项目代码。在代码检查任务中，我们可以选择“概览”页签，即可查看任务执行结果统计：

注：页面中，门禁检查结果显示为“Failed”的原因是 任务检查结果不符合门禁要求。代码检查任务的质量门禁默认配置为：致命问题数<=0且严重问题数<=0（可在“设置 > 质量门禁”中查看配置）；而当前代码检查任务的执行结果致命问题数与严重问题数均大于0。

接着，开发人员需要知道如何具体的修改代码。他可以单击“代码问题”页签，即可看到具体的问题列表，可根据需要对代码进行修改。例如下图中所示的问题，是在代码里Connection没有关闭可能会引起的资源泄漏问题，属于非常严重的问题，需要尽快修复。单击“修改建议”，即可查看系统对此问题的修改建议。在代码仓库中找到对应文件及代码位置，参考修改建议优化代码即可：

代码检查插件

当前CodeCheck插件支持在本地VSCodeIDE，线上CloudIDE运行。

在华为云CodeCheck代码检查插件（CloudIDE版本）使用指南、华为云CodeCheck代码检查插件（VSCode IDE版本）使用指南文里，详细介绍了插件的各个版本的更新内容、如何下载安装使用、如何配置、如何检查等。

参考链接

1. https://support.huaweicloud.com/bestpractice-devcloud/devcloud_practice_2005.html#section1