云服务器内容精选

  • 自定义规则 最多支持创建10条自定义规则。 使用自定义规则扫描代码最多支持扫描10万行。仅适用于使用的规则集中只包含自定义规则。 使用自定义规则扫描10万行代码行最多时长1.5小时。仅适用于使用的规则集中只包含自定义规则。 如果需要支持扫描更多行数的代码或需要创建更多数量的规则,可咨询华为技术支持。 单击“规则”页签。 单击“新建规则”,参考表1配置参数。 表1 自定义规则参数配置说明 参数名称 参数说明 是否必填 规则名称 创建的规则名称,可自定义。 支持中英文,数字,点,下划线“_”和连接符“-” 字符长度范围为1~128 是 工具规则名称 默认填充为规则源码文件名,不可手动修改。 是 检查工具 该检查规则使用的检查工具,当前仅支持SecBrella。 是 语言 该规则检查的编译语言,当前仅支持Java。 是 规则源码 该规则的源码文件。 由用户创建“.kirin”文件编写dsl规则,然后通过运行本地插件在“OutputReport”目录下生成“SecH_自定义规则名.json”的源码文件,上传json文件即可。使用插件生成规则文件可参考插件使用指南。 是 严重级别 该规则检查出的代码问题的严重级别,分为致命、严重、一般和提示。 是 标签 为该规则设置标签,便于使用时区分该规则使用场景。 添加多个标签时,需使用英文逗号分隔。 否 描述 对该规则的使用描述。如果描述的内容需要粘贴代码,代码内容支持MarkDown格式。字符数限制为0~10000。 是 正确示例 该规则对应的正确代码示例。代码内容支持使用MarkDown格式呈现。字符数限制为0~10000。 否 错误示例 不满足该规则的错误代码示例。代码内容支持使用MarkDown格式呈现。字符数限制为0~10000。 否 修复建议 对于该规则检查出的问题修改建议。如果修复建议中需要粘贴代码,代码内容支持MarkDown格式。字符数限制为0~10000。 否 单击“新建规则”,完成创建。
  • 创建自定义检查规则集 基于项目入口访问CodeArts Check服务首页。 单击“规则集”页签,进入规则集列表页面。 单击“新建规则集”,在弹出的“新建规则集”窗口设置规则集名称、描述以及检查语言。 您也可以单击“复制于”下拉框选择复制于已有的规则集,基于复制的规则集配置使用的规则。 单击“确定”。 根据需要勾选规则名称、设置规则级别,单击右上角“保存”。 如果系统预置的规则不满足用户的使用要求,可自定义规则使用。 单击规则集名称,进入规则集详情页面可在线查看规则集中使用的规则详情。 单击规则集名称,进入规则集详情页面,单击“导出”按钮可导出该规则集中已启用的规则到本地查看规则详情。 单击规则集名称,进入规则集详情页面,单击“修改基本信息”,可修改规则集名称或描述信息。 “检查语言”不支持修改。 系统预置规则集无法修改。 只有创建者可以修改自定义规则集。 单击规则集所在行的,选择“删除”即可删除检查规则集。 只有创建者可以删除自定义规则集。 系统规则集和已被使用的自定义规则集无法删除。 如果需要删除已被使用的规则集,需将关联使用该规则集的代码检查任务删除或将代码检查任务关联到其它规则集。
  • CodeArts Check插件检查功能介绍 扫描检查单文件、多文件、整个项目并查看扫描结果 单文件扫描检查:在当前打开的文件代码编辑区,单击鼠标右键,选择“CodeArts Check文件检查”。或者在项目的资源管理器界面里,鼠标移动到需要扫描的文件,单击鼠标右键,选择“CodeArts Check文件检查”。 多文件扫描检查:在项目的资源管理器里,按住Ctrl键,鼠标左键选择需要扫描的几个文件,单击鼠标右键,选择“CodeArts Check文件检查”。 整个项目扫描检查:在当前打开的文件代码编辑区,单击鼠标右键,选择“CodeArts Check项目检查”。或者在项目的资源管理器界面里,单击鼠标右键,选择“CodeArts Check项目检查”。 告警帮助提供告警详细描述、严重级别、告警类型、正确示例、错误示例及修复建议,您可以根据”严重程度/文件分类/规则分类”筛选查看告警。 按文件分类查看:打开CodeArts Check窗口,选择“Defects”页签,在检查结果区域左侧工具栏,单击(分类),选择“按文件分类进行查看”。 按严重级别后告警类型查看:打开CodeArts Check窗口,选择“Defects”页签,在检查结果区域左侧工具栏,单击,根据需要选择显示问题的类别。 根据告警指导修改后,插件将实时自动检查,自动更新告警信息 用户根据插件告警指导修改后,插件将实时自动进行检查,自动更新告警信息。
  • CodeArts Check规则配置功能介绍 打开CodeArts Check窗口,选择“Setting”页签,查看配置。 “CodeArts Check配置”界面功能说明请参见图1和表1。 图1 CodeArts Check配置界面 表1 CodeArts Check配置界面功能说明 序号 功能项 功能描述 1 开启/关闭无感扫描和git提交自动扫描 配置无感扫描:即勾选“代码编辑后保存,是否自动触发代码检查”。扫描完成不影响用户当前作业窗口,修改保存自动扫描、结果自动刷新在CodeArts Check窗口“Defects”页签下区域;取消勾选“代码编辑后保存,是否自动触发代码检查”则关闭该功能。 配置git代码提交时自动扫描:即勾选“代码提交前,是否自动触发代码检查”;取消勾选“代码提交前,是否自动触发代码检查”则关闭该功能。 2 检查模式 无需配置,默认为本地扫描模式。 3 配置扫描排除目录 支持填写相对代码仓的相对目录,例如:一级目录写 目录名,二级目录写 目录1名/目录2名;多个指定目录扫描,可用;号隔开。 不填写目录默认扫描整个项目的所有内容(仅在项目检查时生效)。 4 分类检索 支持规则的搜索或过滤。 5 快速设置规则 支持规则的快速勾选/取消勾选。 6 导入/导出配置规则 将规则详情信息以xlsx格式的文件导出至本地。或将本地准备好的xlsx格式的规则文件导入至工具。
  • CodeArts Check一键格式化及自动修复功能介绍 一键格式化:支持对单文件/多文件/文件夹/整个项目进行一键格式化。一键格式化可帮助您自动解决项目里基础的代码规范问题,如:多余的空格或空行。操作方法如下: 在当前打开的文件代码编辑区或在项目的资源管理器界面里,单击鼠标右键,选择“CodeArts Check一键格式化”。 自动修复:针对插件扫描出来的单个问题,插件提供建议如何修复的预览界面及自动修复。
  • 配置CodeArts Check插件 编辑器下方切换到“CodeArts Check”窗口,在底部工具栏单击“Setting”,弹出配置窗口。 单击配置窗口中“规则”左侧的图标可以查看规则详细信息。 根据实际需要确定勾选是否自动触发代码检查,然后输入检查的屏蔽目录和指定的扫描目录。 可以查看当前被激活/应用到的规则(包括状态、危险级别、编程语言、引擎标签、规则类型)或者根据规则集筛选规则(所有规则集/推荐规则集)。 配置后,单击“应用”。
  • 配置代码检查服务企业微信通知 在企业微信群群里添加群机器人。(以手机客户端为例,详细指导请参考如何设置群关系机器人。) 运行企业微信客户端,选中需要接受消息推送的群聊,单击右上角三个点按钮。 单击“群机器人”。 单击“添加”。 单击“新建”。 填写机器人名字,单击“添加”。 单击Webhook文本框旁的“复制”获取企业微信Webhook地址。 在代码检查任务中配置企业微信群通知服务。 将“企业微信通知”开关设置为状态。 设置通知场景,并填写1中获取的“Webhook URL”。 单击“测试”,验证Webhook地址是否正确可用。确认Webhook URL正确后,单击“保存”。 当代码检查任务完成时,代码检查服务会发送检查结果到指定的企业微信群。
  • 设置忽略的文件集合 代码检查服务支持用户以任务为单元,设置代码检查的文件范围。 不勾选文件路径时,则检查所选仓库分支的所有代码。 勾选指定文件路径时,则该指定路径下的文件将排除检查。 在“忽略的文件集合”区域,勾选无需进行检查的文件路径。设置完成后,执行代码检查任务,将按照设置排除选中的文件路径执行检查。 勾选的忽略文件对需要编译的文件和不需要编译的文件均生效。 不需要编译的文件:勾选忽略文件后,被忽略的文件不参与检查。 需要编译的文件:例如A文件与B文件互为依赖,即使把A文件忽略,但A文件依然会参与检查前的编译过程,编译完成后不参与检查。
  • 设置检查目录 支持检查代码仓指定目录。 不配置检查目录时,检查代码仓中所有目录下的代码文件。 配置检查目录时,只检查配置目录中的文件。 支持配置多个检查目录,多个目录需要用英文逗号分隔。例如: 如果要检查dir1和dir2,检查目录配置为“dir1,dir2”。 如果要检查dir1目录下的dir3,检查目录配置为“dir1/dir3”。 配置项为目录且不支持文件,默认检查代码仓中所有代码。 配置的目录层级中不能包含"."开头的目录。 如果检查目录输入框路径为空,则默认全部检查。如果有指定检查目录,则只检查检查目录中的文件,如果指定的检查目录中有勾选设置忽略文件,则被忽略的文件不参与检查。 检查目录只生效于不需要编译的文件。例如,A文件编译后产生了B文件,则不会输出B文件上的告警。
  • 支持审计日志的操作 表1 云审计 服务支持CodeArts Check服务操作 操作名称 资源类型 事件名称 创建代码检查任务 task create 修改代码检查任务 task modify 删除代码检查任务 task delete 执行代码检查任务 job create 取消执行代码检查任务 job modify_job 关注代码检查任务 followingTask create_followingTask 取消关注代码检查任务 followingTask delete_followingTask 修改规则集信息 ruleset modify_ruleset 修改规则集的规则 ruleset modify_ruleset 删除规则集 ruleset delete_ruleset 配置默认规则集 ruleset set_default_ruleset 导出规则集表格 ruleset export_ruleset 导出问题表格 defectExcel export_defectExcel 下载问题表格 defectExcel downloadAndExport_defectExcel 修改问题状态 issueStatus update_issueStatus 修改问题责任人 issueOwner update_issueOwner 修改问题评论 issueComment update_issueComment
  • 查看代码检查详情 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,搜索目标任务。在任务列表页,可以查看检查任务的状态。 新问题:表示本次代码检查任务执行后新增的问题。 未解决:表示该代码检查任务未解决的问题。 已解决:表示该代码检查任务已解决的问题。 单击检查任务名称,进入代码检查详情概览页,可查看的信息如下: 原始代码行数。 门禁结果:检查结果分为“通过”和“不通过”,同时会展示“致命问题数”和“严重问题数”。 代码检查是否通过是由设置的质量门禁值判断,门禁值设置请参考配置代码检查任务质量门禁。 问题数:检查出来的代码质量问题数。 延迟上线问题数:由于检查引擎的能力提升,出现的新问题数。 未解决新问题数:当前的代码检查结果中,未解决的问题个数。 已解决问题数:当前的代码检查结果中,已解决的问题个数 代码平均圈复杂度:代码的平均圈复杂度。 代码重复率:代码的重复率。 NBNC代码行:非空非注释的代码行数。 问题数最多Top10检查规则:问题数Top10的检查规则以及每条规则对应的问题数。 待处理问题严重程度:待处理的各个等级问题数量分布情况。 问题指派分配:检查出来的代码问题修改分配情况。如果已指派的数量与问题数不一致,说明存在某代码问题还未分配修改责任人。 历史趋势:默认展示近一个月内该代码检查任务的检查结果变化趋势,包括问题数、圈复杂度和重复率。
  • 查看代码度量 代码度量可准确的反映提交代码的质量,助力用户及时发现并修改问题,提升研发效能。代码度量包括已下两种类型的问题: 圈复杂度:代码的复杂度。 扫描Shell语言代码时,度量结果不支持圈复杂度计算。 单击文件名称进入文件详情页面,单击可进入到对应的代码仓修改代码。 重复率:代码检查服务通过重复块、重复行、重复率来识别被测代码的重复情况。 修改重复率问题操作指导如下: 单击文件名称进入文件详情页面。 文件详情页面左侧的竖线标识了重复的代码块,单击标识竖线,将会显示与该段代码重复的文件列表。 单击文件名称,可对比查看两个文件的重复代码块。 单击可进入到对应的代码仓修改代码。
  • 使用流程 表1 使用流程说明 流程 说明 开通CodeArts Check 指导您如何开通代码检查服务。 配置CodeArts Check项目级角色权限 为您介绍如何配置CodeArts Check服务项目级权限以及访问代码检查服务首页的方式。 创建代码检查任务 您可创建不同代码源的代码检查任务。 配置代码检查任务 您可对已有的检查任务进行修改或配置。 执行代码检查任务 您可对目标代码检查任务执行检查,及时发现源代码中的代码问题。 查看代码检查结果 代码检查任务执行完成后,您可查看检查结果并修改代码问题。
  • 开通CodeArts Check 代码检查服务采用包年/包月计费模式,提供基础版、专业版套餐,以满足不同规模用户的使用需求。套餐详情介绍请参见包年/包月套餐说明。 进入购买CodeArts Check套餐页面。 参考表1根据实际需要进行购买。 表1 套餐包配置 配置项 配置详情 计费模式 包年/包月。 区域 选择需要使用的区域。不同区域购买的资源不能跨区使用,需慎重选择。 产品 CodeArts Check套餐 规格 可选择“基础版”或“专业版”,差异如下。 基础版 支持Java/C++/JavaScript/Go/Python/C#/TypeScript/ CSS /HTML/PHP/LUA/RUST/Shell/KOTLIN/SCALA/ArkTS10+种语言。 支持质量类、安全类规则。 检查并发:5个任务并发数。 专业版 基础版所有特性 提供增强的代码安全检查规则,深度识别代码安全风险和漏洞 检查并发:10个任务并发数。 购买时长 可选择1个月~3年。 自动续费 勾选后将开启自动续费。自动续费规则请参考自动续费规则说明。 建议根据您业务所在物理区域就近选择,以减少网络延时。购买的套餐只在对应的区域生效,不能跨区域使用。 确认套餐信息,勾选我已经阅读并同意《CodeArts服务使用声明》,单击“下一步”。 图1 确认套餐信息 若确认无误,继续根据页面提示完成支付。
  • 应用场景 随着现在项目的代码量越来越大,以及现有开发框架的增加,静态分析所需要覆盖的场景也日益增多,存在的问题如下: 传统静态分析引擎靠工具提供通用规则来对常见安全,风格和质量场景下的编码问题进行扫描分析,难以实时覆盖不同用户特定场景下的代码问题。 用户往往不熟悉工具提供的通用规则所能覆盖的全部场景。在为新开发的业务场景寻找适用的规则时需要耗费大量的时间,增加开发成本。 不同用户之间的代码差异大,研发无法实时掌握不同用户的具体需求,在开发规则过程中难以针对不同用户的业务代码场景来制定全面有效的工具规则。 本示例为您介绍如何使用自定义规则检查代码中存在调试代码的问题。