代码检查

代码检查能够在代码构建过程中帮助开发人员快速、有效的定位代码缺陷并及时纠正这些问题,高效检测软件缺陷和安全隐患,提供优秀的静态源代码分析解决方案。

菜单路径

“产品与服务”→“软件开发”→“代码检查”

创建检查

代码检查创建:选择一个构建关联对应的检查对象、检查语言、触发器类型,目前扫描类型为静态分析,选择检查策略实现代码检查。

操作步骤

1.登录控制台。

2.点击“产品与服务”选择“软件开发”>“代码检查”>“检查项目”,进入代码检查页面。

3.点击“+ 创建检查”,进入创建检查项目页面。

属性名称 填写规则
检查名称 1-50个字符,只能以字母开头,只可包含字母、数字、下划线及中横线。
构建 选择构建。
扫描路径 将对此路径下的源代码进行静态扫描,使用相对路径,且径路径名由字母、数字、点号、下划线、/组成,并以/结尾。

代码检查列表操作

操作名称 操作 详解
查询 支持模糊查询。
  • 检查名称
  • 构建
  • 流水线
检查结果 跳转到SonarQube,显示的是代码检查的结果
检查名称 检查名称超链接,查看基本信息及关联信息
编辑
编辑检查项目
删除
删除代码检查项目,删除数据不可恢复与访问,请谨慎操作!
刷新 刷新代码检查列表。

检查规则

代码审查能够在代码构建过程中帮助开发人员用来检查编译器无法发现的更复杂一点的错误,最大可能避免(可能出现的)运行错误。通过设置规则检测软件缺陷和安全隐患。

操作步骤

1.登录控制台。

2.点击“产品与服务”选择“软件开发”>“代码检查”>“规则”,进入代码检查规则展示页面。

检查规则列表操作

操作名称 操作 详解
查询 支持模糊查询。
刷新 刷新代码检查列表。
根据语言筛选 根据所选语言筛选显示规则列表
根据问题级别筛选 根据所选问题级别筛选显示规则列表
根据标签筛选 根据所选标签筛选显示规则列表

规则集操作

代码规则集:是一个或者一组用于不同开发语言的代码检查规则的集合,可识别影响开发效率的问题,代码中的关键问题和风险等

规则集展示

操作步骤

1.登录控制台。

2.点击“产品与服务”选择“软件开发”>“代码检查”>“规则集”,进入代码检查规则集展示页面。

创建规则集

新建规则集:可用于满足不同开发语言并定制化专项需求的检查规则集

操作步骤

1.登录控制台。

2.点击“产品与服务”选择“软件开发”>“代码检查”>“规则集”,进入规则集页面。

3.点击“+ 创建规则集”,进入创建规则集页面。

复制规则集

创建出与被复制对象包含完全一致规则的集和。

操作步骤

1.登录控制台。

2.点击“产品与服务”选择“软件开发”>“代码检查”>“规则集”,进入规则集页面。

3.点击“更多-复制”,进入复制规则集页面。

属性名称 属性说明
规则集名称 1-50个字符,只能以字母开头,只可包含字母、数字、点、下划线及中横线。
基于 根据用户点击的被复制规则集自动填充

删除规则集

操作步骤

1.登录控制台。

2.点击“产品与服务”选择“软件开发”>“代码检查”>“规则集”,进入规则集页面。

3.点击“更多-删除”,进入删除规则集页面。

激活规则

操作步骤

1.登录控制台。

2.点击“产品与服务”选择“软件开发”>“代码检查”>“规则集”,进入规则集页面。

3.点击“配置”,进入激活规则页面。

属性名称 属性说明
Active 激活单条检查规则,激活后自动刷新当前规则集
All Active 激活该语言下的全部检查规则,激活后自动刷新当前规则集

取消已应用的规则

1.登录控制台。

2.点击“产品与服务”选择“软件开发”>“代码检查”>“规则集”,进入规则集页面。

3.点击“规则数”,进入取消规则页面。

属性名称 属性说明
DeActive 取消单条检查规则,取消后自动刷新当前规则集
All DeActive 取消该语言下的全部检查规则,取消后自动刷新当前规则集

将检查任务与规则集绑定

配置规则集:是为一个代码项目指定一个或者一组代码检查规则的集合,可在编排部署发布过程中提升应用的质量和效率。

1.登录控制台。

2.点击“产品与服务”选择“软件开发”>“代码检查”>“任务”,进入检查任务页面。

3.点击“更多-->配置”,进入绑定规则集页面。

属性名称 属性说明
语言 选择当前项目存在的检查语言
规则集 根据用户所选语言自动加载当前语言的规则集列表

查看检查结果

1.登录控制台。

2.点击“产品与服务”选择“软件开发”>“代码检查”>“任务”,进入检查任务页面。

3.点击“检查结果”,进入总览页面。

3.点击上方导航栏“问题”,进入页面。

展示出该任务下应用的所有规则信息,可根据类型、严重程度、标签等信息筛选显示。