检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
CodeArts Check最佳实践汇总 本文汇总了基于代码检查服务（CodeArts Check）常见应用场景的操作实践，为每个实践提供详细的方案描述和操作指导，帮助用户轻松检查代码。 表1 CodeArts Check最佳实践一览表 最佳实践 说明 使用预置规则检查GitCode代码仓中的代码质量
一站式问题闭环修复，问题修复效率倍增 开发团队实施代码检查活动时通常遇到问题分析和修复成本高（工具问题不易理解、问题分到具体开发人员费时费力、多版本情况下重复处理同一告警令开发人员厌倦工具）导致落地困难，这些原因很大程度影响了开发人员对检查工具的使用积极性。 代码检查服务提供问题分析处理三大能力，帮助开发团队高效、顺畅使用代码检查：
表2 自定义规则参数说明 参数 说明 规则名称 创建的规则名称，可自定义。例如：检查调试代码。 工具规则名称 默认填充为规则源码文件名，不可手动修改。 检查工具 该检查规则使用的检查工具，当前仅支持SecBrella。 语言 该规则检查的编译语言，当前仅支持Java。 规则源码 该
程中，您需要用到账号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region。 通用Region指面向公共租户提供通用云服务的Region。
Shell/KOTLIN/SCALA/ArkTS等10+常见开发语言，满足嵌入式、WEB应用、移动应用等多种开发场景所需。 内置多款的开源工具与自研引擎一起提供丰富的检查规则（9000+）。 梳理各类场景需要，内置全面检查规则集、关键检查规则集、移动领域规则集、华为编程规范规则集
配置代码检查任务自定义环境 当使用代码检查服务时，若常用的编译构建环境缺少您需要的依赖包、工具，无法满足您的使用需求时，您可通过自定义构建环境提供的基础镜像执行代码检查任务。 前提条件 已将自定义环境推送到镜像仓中，具体操作请参见制作镜像并推送到SWR仓库。 配置自定义镜像 基于项目入口访问CodeArts
Development Life Cycle）。 问题展示 准确定位到问题所在代码行，用户可以在线查看并分析代码问题。 延迟上线 在工具版本升级后，由于代码检查服务检查引擎的能力提升，可能会出现新的缺陷。但新检查出来的缺陷，不会计算到正式缺陷中，开发者拥有60天的缓冲周期对代码进行修改，
Check窗口，选择“Defects”页签，在检查结果区域左侧工具栏，单击（分类），选择“按文件分类进行查看”。 按严重级别后告警类型查看：打开CodeArts Check窗口，选择“Defects”页签，在检查结果区域左侧工具栏，单击，根据需要选择显示问题的类别。 根据告警指导修改后，插件将实时自动检查，自动更新告警信息
应用：在交付过程中实时根据代码复杂度、重复率、质量得分控制风险。 场景特点：项目经理的共识“从前端保证质量，把质量做在日常交付”，但经常没有有效的工具平台，目前大部分的质量工作还是依赖后端测试。 适用场景：项目经理迭代交付质量控制。
创建的规则名称，可自定义。 支持中英文，数字，点，下划线“_”和连接符“-” 字符长度范围为1~128 是 工具规则名称 默认填充为规则源码文件名，不可手动修改。 是 检查工具 该检查规则使用的检查工具，当前仅支持SecBrella。 是 语言 该规则检查的编译语言，当前仅支持Java。 是 规则源码
基于项目入口访问CodeArts Check服务首页。 单击“规则集”页签，进入检查规则集列表页面。 单击规则集名称，进入到该规则集的规则详情页面可在线查看规则详情。 您也可以单击“导出”，导出该规则集中已启用的规则到本地查看规则详情。 修改默认规则集 初次使用代码检查服务时，每种编程语言都设置一个
Content-Type 否 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 响应参数 状态码： 200 表4 响应Body参数 参数 参数类型
Request succeeded! 表5 TaskCheckParamters 参数 参数类型 描述 check_id Integer 检查工具ID name String 编译参数名称 checker_configs Array of CheckConfigInfo objects
服务韧性 代码检查通过多活无状态的跨AZ部署、AZ之间数据容灾等技术方案，保证业务进程故障时快速启动并修复，以保障服务的持久性和可靠性。 父主题： 安全
规则配置参数阈值相关信息 表6 RuleConfig 参数 参数类型 描述 id Integer 规则配置ID rule_id String 工具规则ID，即可配置阈值规则的各种阈值对应的ID，当前无便利手段获取，请联系客服咨询 default_value String 默认值 option_value
是 String 设置媒体类型和编码格式 表3 请求Body参数 参数 是否必选 参数类型 描述 check_id 是 Integer 检查工具ID，参数已废弃 ruleset_id 是 String 规则集ID，可以通过查询任务的已选规则集列表接口获取 language 是 String
代码检查服务入门实践 表1 代码检查服务常用最佳实践 实践 描述 使用系统预置规则检查通用Git代码仓中的代码质量 以通用Git代码源为例，介绍如何创建通用Git代码检查任务。
管到CodeArts Check服务中，委托CodeArts Check服务进行调度并执行代码检查任务。本实践我们通过检查CodeArts Repo代码仓的代码问题来演示使用自定义执行机执行代码检查任务。 本实践需要依赖使用的其他服务：代码托管服务，用于存储实践中项目所使用的代码。
配置代码检查任务集成服务 当代码托管中有分支合并时，在代码检查服务中可以设置自动检查代码检查任务，并生成一个子任务，即代码仓库中有分支合并，就会重新生成一个代码检查子任务。 配置MR检查状态 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面，在任务列表中，单击任务名称。
审计与日志 审计 云审计服务（Cloud Trace Service，CTS），是华为云安全解决方案中专业的日志审计服务，提供对各种云资源操作记录的收集、存储和查询功能，可用于支撑安全分析、合规审计、资源跟踪和问题定位等常见应用场景。 用户开通云审计服务并创建和配置追踪器后，CT
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
