更新时间:2023-12-04 GMT+08:00

步骤四:检查代码

代码检查服务提供基于云端实现代码质量管理服务,支持代码静态检查(包括代码质量、代码风格等)和安全检查,并提供缺陷的改进建议和趋势分析。

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

通过本章节,您将了解开发人员Chris如何完成针对不同技术栈的代码静态扫描、问题收集与修复。

预置任务简介

样例项目中预置了以下4个代码检查任务。

表1 预置任务

预置任务

任务说明

phoenix-codecheck-worker

检查Worker功能对应代码的任务。

phoenix-codecheck-result

检查Result功能对应代码的任务。

phoenix-codecheck-vote

检查Vote功能对应代码的任务。

phoenix-sample-javas

检查整个代码仓库对应的JavaScript代码的任务。

关于Vote、Result、Worker的说明,请参见方案架构

本章节以任务“phoenix-codecheck-worker”为例进行讲解。

配置并执行任务

开发人员可以对样例项目中预置的任务做一些简单的配置,增加Python语言检查规则集,使检查更全面。

  1. 编辑任务。

    1. 进入“凤凰商城”项目,单击导航代码 > 代码检查,页面中显示样例项目内置的4个任务。
    2. 在列表中找到任务“phoenix-codecheck-worker”
    3. 单击任务名称进入详情页,选择“设置”页签。
    4. 单击导航规则集,规则集中默认包含的语言是“JAVA”
    5. 增加Python语言检查规则集。
      1. 单击“已包含语言”之后的图标,重新获取代码仓库语言,刷新后的列表新增了多种语言。

        若页面中已显示“PYTHON”,则忽略此步骤。

      2. 将PYTHON语言对应的开关打开
      3. 在弹框中单击“确定”

  2. 执行任务。

    1. 单击“开始检查”,启动任务。
    2. 当页面显示,表示任务执行成功。

      若任务执行失败,请根据页面弹出报错提示排查修改。

查看检查结果

代码检查服务提供检查结果统计,并对检查出的问题提供修改建议,可以根据修改建议优化项目代码。

  1. 在代码检查任务中,选择“概览”页签,即可查看任务执行结果统计。
  2. 单击“代码问题”页签,即可看到问题列表。

    单击问题框中的“问题帮助”,可以查看系统对此问题的修改建议。可以根据需要在代码仓库中找到对应文件及代码位置,参考修改建议优化代码。