检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
CodeArts Check插件使用指南(IntelliJ IDEA版本) 本插件致力于守护开发人员代码质量,成为开发人员的助手和利器。秉承极简、极速、即时看护的理念,提供业界规范的检查、代码风格一键格式化及代码自动修复功能。 安装CodeArts Check插件 在IDEA IDE编辑器顶部菜单栏选择“File
使用预置规则检查GitCode代码仓中的代码质量 应用场景 如果您的代码存放在GitCode代码仓中,可参考本实践的操作指导完成检查代码质量。本实践为您介绍如何使用系统预置规则检查GitCode代码仓中的Java语言代码质量。 前提准备 已开通并授权使用代码检查服务授权使用代码检查服务。
约束与限制 购买须知 不同区域购买的资源不能跨区使用,需慎重选择。 如果已经购买了CodeArts套餐,则无需再单独购买CodeArts Check套餐。 命名限制 限制项 说明 检查任务名称 支持中英文,数字,点,下划线“_”和连接符“-”。 字符长度范围为1~128。 规则集名称
查询缺陷详情 功能介绍 根据检查任务ID分页查询缺陷结果详情。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-detail 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新
查询审计日志 云审计服务是安全解决方案中专业的日志审计服务,记录了CodeArts Check的相关操作事件,方便您日后的查询、审计和回溯。 支持审计日志的操作 表1 云审计服务支持CodeArts Check服务操作 操作名称 资源类型 事件名称 创建代码检查任务 task create
查询缺陷概要 功能介绍 根据检查任务ID查询缺陷结果的概要。包括问题概述、问题状态、圈复杂度、代码重复率等。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-summary 表1 路径参数 参数 是否必选 参数类型 描述 task_id
配置代码检查任务检查模式 您可以根据实际需求设置检查模式和检查目录,提高检查效率。 约束与限制 C#语言和secbrella引擎均不支持MR合入。 设置MR检查模式 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,在任务列表中,单击任务名称。 进入“代码检查详情”页面,选择“设置
旧版本开通/关闭按需计费方式说明 本章节仅供老用户参考。 CodeArts旧版计费包括包年/包月套餐购买及服务组合开通方式。 也可单独开通代码检查服务。单独开通的计费方式请参见旧版代码检查计费方式如何收费?。 前提条件 请先注册华为账号并开通华为云(如果华为云账号已注册并开通华为
产品优势 专业 提供9000条以上典型检查规则。 提供多维度质量统计报表,如质量门禁和代码健康度徽标等。 精准 精确定位缺陷,提供修复指导。 支持用户自定义检查规则集,精准检查用户关注缺陷。 全面 支持Java/C++/JavaScript/Go/Python/C#/TypeSc
计费项 资源扩展计费说明 代码检查支持资源并发扩展,计费项为代码检查并发数。 表1 并发数计费 计费项 计费项说明 适用资源扩展类型 计费公式 代码检查并发数 某一Region内,租户中所有代码检查任务的并发执行数量总和。 代码检查并发扩展 单价*并发数*购买时长
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
查询cmetrics缺陷概要 功能介绍 根据检查任务ID查询cmetrics缺陷概要。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/metrics-summary 表1 路径参数 参数 是否必选 参数类型 描述
配置代码检查任务 配置代码检查任务规则集 配置代码检查任务质量门禁 配置代码检查任务定时执行 配置代码检查任务消息通知 配置代码检查任务检查模式 查看徽标状态 配置代码检查任务集成服务 配置代码检查任务自定义环境 配置代码检查任务高级选项
配置代码检查任务消息通知 CodeArts Check的通知设置支持系统项目级、服务项目级和任务级,您可以根据实际需求,设置代码检查任务事件类型的通知方式。入口分别如下: 服务项目级:进入项目详情页面,选择“代码 > 代码检查 > 配置中心 > 通知管理”。 任务级:进入代码检查详情页面,选择“设置
数据保护技术 代码检查通过多种数据保护手段和特性,保障数据安全可靠。 数据保护手段 简要说明 详细介绍 传输加密(HTTPS) 为保证数据传输的安全性,代码检查使用HTTPS传输数据。 构造请求 个人数据保护 通过控制个人数据访问权限以及记录操作日志等方法防止个人数据泄露,保证您的个人数据安全。
历史扫描结果查询 功能介绍 提供每次扫描的问题数量统计 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/checkrecord 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
代码检查安全增强 CodeArts Check提供代码安全检查增强包的能力,其安全检查能力作为深度价值特性,能深度识别代码中安全风险和漏洞,提供了套餐包内规则不覆盖的安全类场景,比如数值错误、加密问题、数据验证问题等。针对业界的安全漏洞检测项提供了更深入的分析能力,如跨函数、跨文件、污点分析、语义分析等。
配置代码检查任务质量门禁 根据质量要求设置门禁阈值,即可了解您的项目是否已准备好投入生产。例如,实际的检查结果超出设置的门禁阈值,则表示当前项目还不具备生产条件。 门禁质量设置支持租户级、项目级以及任务级,优先级为租户级 > 项目级 > 任务级。入口分别如下: 租户级:进入代码检
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的管理员创建IAM用户接口为例说明如何调用API。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987 。 请求URI 尽管请求UR
状态码 状态码如表1所示。 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如,切换到HTTP的新版本协议。