计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive
文档首页/ 代码检查 CodeArts Check/ 最佳实践/ 使用自定义规则检查CodeArts Repo代码仓中的代码质量

使用自定义规则检查CodeArts Repo代码仓中的代码质量

更新时间:2024-10-10 GMT+08:00

应用场景

随着现在项目的代码量越来越大,以及现有开发框架的增加,静态分析所需要覆盖的场景也日益增多,存在的问题如下:

  • 传统静态分析引擎靠工具提供通用规则来对常见安全,风格和质量场景下的编码问题进行扫描分析,难以实时覆盖不同用户特定场景下的代码问题。
  • 用户往往不熟悉工具提供的通用规则所能覆盖的全部场景。在为新开发的业务场景寻找适用的规则时需要耗费大量的时间,增加开发成本。
  • 不同用户之间的代码差异大,研发无法实时掌握不同用户的具体需求,在开发规则过程中难以针对不同用户的业务代码场景来制定全面有效的工具规则。

本示例为您介绍如何使用自定义规则检查代码中存在调试代码的问题。

前提准备

  • 已授权使用代码检查服务。
  • 通用Git代码仓中已有Java语言的代码。

操作流程

表1 操作流程

序号

步骤

说明

1

创建代码检查任务所属项目

创建代码检查任务所属的项目。

2

创建CodeArts Repo代码仓

创建代码检查任务使用的代码仓。

3

创建规则文件

创建自定义规则时需要上传使用的规则文件。

4

创建自定义规则

在代码检查服务页面创建自定义规则。

5

创建自定义规则集

自定义规则无法直接使用,需要通过创建自定义规则集使用。

6

创建代码检查任务

创建使用自定义规则检查的代码检查任务。

7

使用自定义规则集执行检查任务

配置代码检查任务使用带有自定义规则的自定义规则集。

8

查看检查结果

查看检查结果,确认使用的规则是否生效。

创建代码检查任务所属项目

  1. 使用华为云账号登录华为云控制台页面
  2. 单击页面左上角,在服务列表中选择开发与运维 > 软件开发生产线 CodeArts
  3. 单击“立即使用”,进入CodeArts服务首页。
  4. 在首页单击“新建项目”,选用“Scrum”项目模板。项目名称填写“Scrum01”,其他参数保持默认即可。
  5. 单击“确定”后,进入到“Scrum01”项目下。

创建CodeArts Repo代码仓

  1. 在页面导航栏中选择代码 > 代码托管
  2. 进入代码托管页面,单击“新建仓库”,选择“模板仓库”
  3. 单击“下一步”,在按模板新建 > 选择仓库模板,搜索并选择“Java Ant Demo”模板。
  4. 单击“下一步”,仓库名称填写“Repo01”“自动创建代码检查任务”参数需要去除勾选。其他参数保持默认即可。
  5. 单击“确定”完成仓库创建。
  6. “com/huawei”目录下的“HelloWorld.java”文件中修改后的代码信息如下。

    package com.huawei;
    /**
     * Generate a unique number
     *
     */
    public class HelloWorld 
    {
    //用于打印日志
      public void debugLog(List<String> msg) {
        for (String msg0 : msg) {
          System.out.println("DEBUG:"+ msg0);
        }
    }
        public static void main( String[] args )
        {
          System.out.println("Hello World!");
        }
    }

创建规则文件

  1. Visual Studio Code官网下载并安装1.67.0以上版本的IDE编辑器。
  2. 在VSCode IDE编辑器界面上,单击左侧按钮,在弹出的窗口中搜索“Huawei Cloud CodeNavi”
  3. 单击“Install”,安装代码检查插件。
  4. 安装后,在VSCode IDE编辑器工作空间新建后缀为“.kirin”的文件,文件名为自定义规则的规则文件名称,例如:CheckDebugCode.kirin。文件内容如下所示。

    functionDeclaration fd1 where
        and(
            fd1.hasBody,
            fd1.name startWith "debug",
            fd1.parameters.size() == 1,
            fd1.parameters[0].type.name == "java.util.List"
        );

  5. 在规则文件界面上鼠标右键,选择CodeNavi > Format格式化校验语法正确性。
  6. 在规则文件界面上鼠标右键,选择CodeNavi > Scan扫描
  7. 在弹出的窗口中选择需要检查的文件或者目录,单击“Scan”
  8. 扫描完成后,单击界面左下角的告警显示具体的代码片段。同时,会在同目录的OutputReport文件中生成“.json”格式的规则文件。

创建自定义规则

  1. 在页面导航栏中选择代码 > 代码检查
  2. 单击“规则”页签。
  3. 单击“新建规则”,参考表2配置参数。

    表2 自定义规则参数说明

    参数

    说明

    规则名称

    创建的规则名称,可自定义。例如:检查调试代码。

    工具规则名称

    默认填充为规则源码文件名,不可手动修改。

    检查工具

    该检查规则使用的检查工具,当前仅支持SecBrella。

    语言

    该规则检查的编译语言,当前仅支持Java。

    规则源码

    该规则的源码文件。上传创建规则文件中生成的文件。

    严重级别

    该规则检查出的代码问题的严重级别,分为致命、严重、一般和提示。这里设置为“提示”

    标签

    为该规则设置标签,便于使用时区分该规则使用场景。非必填,无需填写。

    说明:

    添加多个标签时,需使用英文逗号分隔。

    描述

    对该规则的使用描述。代码内容支持使用MarkDown格式呈现。字符数限制为0~10000。例如:检查是否存在调试代码。

    正确示例

    该规则对应的正确代码示例。代码内容支持使用MarkDown格式呈现。字符数限制为0~10000。非必填,无需填写。

    错误示例

    不满足该规则的错误代码示例。代码内容支持使用MarkDown格式呈现。字符数限制为0~10000。非必填,无需填写。

    修复建议

    对于该规则检查出的问题修改建议。代码内容支持使用MarkDown格式呈现。字符数限制为0~10000。非必填,无需填写。

  4. 单击“新建规则”,完成创建。

创建自定义规则集

  1. 在代码检查任务列表页,单击“规则集”页签,进入规则集列表页面。
  2. 单击“新建规则集”,在弹出的窗口设置“规则集名称”“RuleList”“检查语言”“Java”
  3. 单击“确定”,进入到“规则集配置”页面。
  4. 勾选创建自定义规则中创建的规则,单击右上角“保存”。

创建代码检查任务

  1. 在代码检查任务列表页,单击“新建任务”,按照如下表格配置参数。

    表3 代码检查任务参数说明

    参数

    说明

    归属项目

    创建代码检查任务所属项目中创建的项目名称“Scrum01”。默认填写,无需配置。

    代码源

    选择需要检查的代码来源。选择“Repo”

    任务名称

    代码检查任务名称,可自定义。例如:CheckTask01。

    仓库

    选择创建CodeArts Repo代码仓中创建的代码仓“Repo01”

    分支

    保持默认“master”即可。

    检查语言

    选择“Java”

  2. 单击“新建任务”,完成代码检查任务的创建。

使用自定义规则集执行检查任务

  1. 在代码检查任务列表页单击代码检查任务名称,进入代码检查任务详情页。
  2. 单击“设置”
  3. 单击“规则集”,在右侧区域单击选择创建自定义规则集中创建的规则集“RuleList”
  4. 单击右上角“开始检查”

查看检查结果

  1. 在代码检查页面任务列表中,搜索创建代码检查任务创建的任务名称“CheckTask01”
  2. 单击任务名称,查看代码检查详情,包括概览、代码问题、代码度量、检查日志等。

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容