文档首页/ 代码检查 CodeArts Check/ 用户指南/ 参考/ CodeArts Check插件使用指南（IntelliJ IDEA版本）
更新时间：2024-11-29 GMT+08:00
查看PDF
分享

CodeArts Check插件使用指南（IntelliJ IDEA版本）

本插件致力于守护开发人员代码质量，成为开发人员的助手和利器。秉承极简、极速、即时看护的理念，提供业界规范的检查、代码风格一键格式化及代码自动修复功能。

安装CodeArts Check插件

  1. 在IDEA IDE编辑器顶部菜单栏选择“File > Settings”，进入IDEA设置界面。
  2. 左侧菜单中单击“Plugins”, 右侧窗口切换到“Marketplace”。
  3. 在搜索输入框内搜索“Huawei Cloud CodeArts Check” 或“CodeArts Check”可查看到CodeArts Check代码检查插件。
  4. 单击“安装”，IDEA会重启，重启之后，会自动开始下载引擎包和JDK。
  5. 下载完成之后，在IDEA IDE编辑器右下角会有下载安装成功的提示信息。

登录IntelliJ IDEA版本插件（可选）

分为两种登录方式。

  • 方式一：通过华为云账号直接登录或CSDN账号授权登录CodeArts Check IDE插件。

  • 方式二：通过华为云账号的AK/SK登录。
    1. 获取华为云账号的AK/SK。
      1. 登录华为云访问密钥界面。
      2. 单击“新增访问密钥”，在弹出的窗口中根据实际需要填写描述信息。
      3. 单击“确定”，弹出“身份验证”窗口，通过手机的验证方式进行身份验证。

      4. 输入验证码后单击“确定”，会弹出窗口提示“创建成功”，单击“立即下载”按钮。

      5. 打开下载的“.csv”文件，查看User Name/Access Key/Secret Key信息。
    2. IDEA IDE编辑器右下角提示“Huawei Cloud ToolKit：Login Failed”。

    3. 单击“Set your AK/SK”，打开华为云ToolKit的登录界面窗，输入1中获取华为云账号的AK/SK。

      需要勾选“Remember me”。

    4. 单击“Apply”，在弹出的窗口中单击“同意并继续使用”。

    5. IDEA IDE右下角会有登录的用户名提示信息，表示已经登录成功。

配置CodeArts Check插件

  1. 编辑器下方切换到“CodeArts Check”窗口，在底部工具栏单击“Setting”，弹出配置窗口。

  2. 单击配置窗口中“规则”左侧的图标可以查看规则详细信息。
  3. 根据实际需要确定勾选是否自动触发代码检查，然后输入检查的屏蔽目录和指定的扫描目录。

  4. 可以查看当前被激活/应用到的规则（包括状态、危险级别、编程语言、引擎标签、规则类型）或者根据规则集筛选规则（所有规则集/推荐规则集）。

  5. 配置后，单击“应用”。

使用CodeArts Check插件检查和修复文件

以Java项目为例。

本地选择一个Java项目。支持对单个Java文件或多个Java文件进行扫描检查，或对整个项目进行工程检查，还可以通过一键格式化对文件进行自动代码风格问题纠正等，详细介绍请参见CodeArts Check插件检查功能介绍、CodeArts Check一键格式化及自动修复功能介绍和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一键格式化”。

  • 自动修复：针对插件扫描出来的单个问题，插件提供建议如何修复的预览界面及自动修复。

CodeArts Check规则配置功能介绍

打开CodeArts Check窗口，选择“Setting”页签，查看配置。

若未登录，请先登录再使用查看配置，单击打开“Setting”配置界面。若未登录，“Setting”界面提示“单击链接登录后获取配置数据(…)”等相关信息，单击提示下连接“Login config”跳转到登录页面登录。

若已登录，“Setting”页面提示“设置页面已移动到底部CodeArts Check > Setting面板”，单击提示下方链接打开底部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格式的规则文件导入至工具。
父主题： 参考