1 插件安装

1.1 通过JetBrains官方仓库安装

1. 打开 Settings ——> Plugins ——> Marketplace

1-install alibaba java coding guidlines plugin.png

2. 在搜索框输入alibaba或Alibaba Java Coding Guidelines即可看到Alibaba Java Coding Guidelines插件，点击Install进行安装，然后重启IDE生效。

   注意：因为插件zip包托管在JetBrains官方CDN上，所以是从国外的服务器进行下载，可能会出现超时的情况

1.2 通过下载安装包进行安装

1. 打开JetBrains官方插件页面

2-install from disk.png

2. Settings ——> Plugins ——> Manage Repositories,Configure Proxy or Install Plugin from Disk，选择刚刚下载的zip包安装，然后重启IDE。

   
   3-Manage Repositories,Configure Proxy or Install Plugin from Disk.png

2 插件使用

Alibaba Java Coding Guidelines实现了57条规则，支持实时检测和手动触发。

2.1 实时检测

实时检测功能会在开发过程中对当前文件进行检测，并以高亮的形式提示出来，同时也可以支持Quick Fix，该功能默认开启，可以通过配置关闭。

结果高亮提示

检测结果高亮提示，并且鼠标放上去会弹出提示信息。

4-实时检测.png

Intention QuickFix功能

Alt+Enter键可呼出Intention菜单，不同的规则会提示不同信息的Quick Fix按钮。

5-Intation Quick Fix.png

2.2 关闭实时检测

在某些情况下，我们不希望对代码提示违规信息，比如我们在阅读Github开源项目代码的时候，如果界面出现一堆红色、黄色的提示，非常不便于阅读。这个时候我们可以通过Inspection的设置关闭实时检测功能。

1. 通过右键快速关闭（打开）所有规则的实时检测功能

6-右键关闭实时检测.png

2. 手动设置：Settings >> Editor >> Inspections

   也可以关闭某条规则的实时检测功能或者修改提示级别。

   
   7-手动关闭实时检测.png

3. 代码扫描

   可以通过右键菜单、Toolbar按钮、快捷键三种方式手动触发代码检测。同时结果面板中可以对部分实现了QuickFix功能的规则进行快速修复。

   2.3 触发扫描

   文件扫描

   在当前编辑的文件中点击右键，可以在弹出的菜单中触发对该文件的检测。

   
   8-触发扫描.png

   项目扫描或目录扫描

   在左侧的Project目录树种点击右键，可以触发对整个工程或者选择的某个目录、文件进行检测。

   
   9-项目或目录扫描.png

如果您打开了IDE的Toolbar，也可以通过Toolbar中的按钮来触发检测，目前Toolbar的按钮触发的检测范围与您IDE当时的焦点有关。

10-Toolbar触发检测.png

使用快捷键（Ctrl+Shift+Alt+J）触发弹出窗口，选择检测范围。

11-快捷键检测.png

2.4 扫描结果

检测结果直接使用IDEA Run Inspection By Name功能的结果界面，插件的检测结果分级为Blocker、Critical、Major。默认按等级分组，方便统计每个级别错误的数量。

12-扫描结果分类.png

默认情况我们在结果面板需要双击具体违规项才能打开对应的源文件，开启Autoscroll To Source选项，单击面板中的文件名、或者是具体的违规项的时候IDEA会自动打开对应的源文件。

13-自动打开源文件.png

QuickFix

对于实现Quick Fix的规则，在结果面板中可以直接一键修复。

14-quickfix.png

2.5 代码提交时检测

1. 在提交代码框勾选Alibaba Code Guidelines选项

   
   15-代码提交时检测.png

2. 如果有违反手册的地方会提示是否继续提交，选择取消后会自动对修改的代码进行扫描

   
   16-依然提交.png

2.6 其他功能

面板中其他按钮的功能大家自行探索，就不一一进行赘述。