有了这些 IDEA 插件，代码拿捏!

傷城~ 2024-04-01 16:07 61阅读 0赞

随着业务的发展，系统会越来越庞大，原本简单稳定的功能，可能在不断迭代后复杂度上升，潜在的风险也随之暴露，导致最终服务不稳定，造成业务价值的损失。而为了减少这种情况，其中一种比较好的方式就是提高代码质量，比如通过代码审查，从而降低错误风险，但是，代码审查难度大，代码缺陷、漏洞不易发现，且审查工作随着代码量增加而增加，审查效率低。

工欲善其事，必先利其器，因此，这篇文章给大家介绍几种检查代码质量的利器，Alibaba Java Coding Guidelines、CheckStyle、PMD、FindBugs、SonarLint，让你在关注代码质量的同时，减少 code review 的工作量，提高 code review 的效率，并通过代码质量分析去反向提升我们的代码编写能力

### 一、Alibaba Java Coding Guidelines ###

#### 1、整体介绍： ####

Alibaba Java Coding Guidelines 专注于 Java 代码规范，目的是让开发者更加方便、快速规范代码格式。该插件在扫描代码后，将不符合规约的代码按 Blocker、Critical、Major 三个等级显示出来，并且大部分可以自动修复，它还基于 Inspection 机制提供了实时检测功能，编写代码的同时也能快速发现问题所在。

阿里巴巴规约扫描包括：

*  OOP 规约
 *  并发处理
 *  控制语句
 *  命名规约
 *  常量定义
 *  注释规范

#### 2、安装步骤： ####

`File > Settings > Plugins > Marketplace`搜索 “`Alibaba Java Coding Guidelines`”，按照提示进行安装，然后重启即可。

#### 3、使用说明： ####

**3.1、运行方式**

（1）可以 Tools > 阿里编码规约 > 编码规约扫描

![7ba54c9c4ebd1dc7c4c5156dbe1f4f42.png][]

（2）在编辑界面或者项目区域点击右键，在右键菜单中选择“编码规约扫描”即可：

![45e92d3dc460be1a9a107d218bad5f84.png][]

**3.2、菜单功能**

*  **编码规约扫描**：开始扫描代码
 *  **打开/关闭实时检测功能**：实时检测代码，一般机器性能比较好的话可以开启这项功能
 *  **切换语言至英文**：中英文切换

**3.3、运行结果**

扫描完成后显示结果如下，我们可以看到扫描结果主要分为 Blocker（阻挡者）、Critical（严重问题）、Major（主要的）三个大类，它们表示的是问题的严重程度，严重程度由高到低为：`Blocker > Critical > Major`，至于每一类中都会包含什么样的问题，图中的内容已经说明了一切。

![9ca659f1a573d88cc7e364c397350870.png][]

选中其中的一个问题项目，会出现如下内容（如果当前鼠标点击的是最终项，右边区域显示的是其它的内容，后面会再讲到）：

![a62079d57cdb567189fefe2ddef66ca0.png][]

（1）指定区域搜索同一类问题：

当点击 ③ 处的按钮时，会弹出如下按钮：

![72d35f5342bb5f71f7be819ab874d7f3.png][]

这里选择扫描区域，来扫描鼠标选中的同类问题。如果按照默认选择，那么运行后的结果就如下图所示：

![f6aa28cb0c275e5727845316ff0fd9f6.png][]

这里我们可以看到，显示了整个 Project 中的所有该类的问题。

（2）预览具体的不规范代码：

如果点击的是最终的问题点或者问题所在的类文件，那显示的就是如下界面，预览该处不规范的代码。

![4342fa9d28612123356b97cc8743cfca.png][]

**3.4、工具栏功能介绍**

![78fa61c7c6c86b4bfa1351e83c4a6773.png][]

*  `Rerun Inspection`：重新运行一次扫描
 *  `Close`：关闭真个 AJCG 面板
 *  `Expand All`：展开结果的树状结构，整个结果是树状结构的。
 *  `Collapse All`：收起结果的树状结构
 *  `Go Pre Problem`：选择上一个问题
 *  `Go Next Problem`：选择下一个问题
 *  `Help`：帮助
 *  `Group by Serverity`：（不知道如何描述）
 *  `Group by derectory`：按目录分组/按类名分组间切换
 *  `Filter resoled items`：过滤掉已经解决的项
 *  `Autoscroll to Source`：自动滚动到源码
 *  `Export`：导出，可以导出为 XML 和 HTML 两种格式
 *  `Edit Settings`：编辑设置

### 二、CheckStyle ###

#### 1、整体介绍： ####

CheckStyle 侧重检查编码格式和代码风格规范，如命名规范、Javadoc 注释规范、空格规范、size 度量（如过长的方法）、重复代码、多余 Imports 等，从而有效约束开发人员更好地遵循代码编写规范。Checkstyle 主要是文法层面的代码编写规范的分析，对 bug 几乎没什么发现能力。

Checkstyle 插件中默认内置有 2 个执行代码检查的配置文件（Sun Checks 和 Sun Checks），但是这两个文件检查的非常详细严格，即使优秀的开源项目也会检查出来有非常多的错误告信息，所以需要导入我们自定义的配置文件。

#### 2、安装步骤： ####

通过`File > Settings > Plugins > Marketplace`搜索 “CheckStyle”，按照提示进行安装，然后重启即可。

#### 3、使用说明： ####

![63ee9b67f86ae61ee310f2605bc60f9e.png][]

可以看到基本都是一些缩进啥的编码规范，可以不用太关注

### 三、PMD ###

#### 1、整体介绍： ####

PMD 侧重面向安全编码规则，且具备一定的数据流分析和路径分析能力，能力比 CheckStyle 稍微强点，并且 PMD 支持自定义规则，PMD 可以直接使用的规则包括以下内容：

*  **潜在的 bug**：空的`try/catch/finally/switch`语句
 *  **未使用的代码（Dead code）**：未使用的变量、参数、私有方法等
 *  **可选的代码**：`String/StringBuffer`的滥用
 *  **复杂的表达式**：不必须的 if 语句、可被 while 替代的 for 循环
 *  **重复的代码**：拷贝/粘贴代码意味着拷贝/粘贴 bugs
 *  **循环体创建新对象**：尽量不要在循环体内实例化新对象
 *  **资源关闭**：Connect，Result，Statement 等使用之后确保关闭掉

#### 2、安装步骤： ####

通过`File > Settings > Plugins > Marketplace`搜索 “`PMDPlugin`”，按照提示进行安装，然后重启即可

#### 3、使用说明： ####

参考文章：http://wjhsh.net/andy-songwei-p-11830812.html

**3.1、运行方式**

（1）从 Tools 菜单中启动：

通过`Tools > Run PMD`可以看到如下的界面，如果通过该方式启动，扫描的范围就是整个项目中的文件了。

![db16ea5c6df7b2d2ad64fac734897f31.png][]

*  **Pre Defined**：预定义的规则，也就是插件自带的检测规则。后面展开的列表中列出了所有的规则列表，想扫描哪一种类型的问题，点击即可。其中“All”表示使用所有的规则。
 *  **Custom Rules**：自定义的检测规则，PMD 允许用户根据需要自定义检查规则，默认这里是不可点击的，需要在设置中导入自定义规则文件后方可选择。

（2）从右键菜单中启动：

在文件或者编辑器中点击右键，也可以看到“Run PMD”选项，如果通过该方式启动， 检测范围取决于鼠标或光标当前所选中的区域。

**3.2、运行结果**

![17926351b1f150eceffa2950d1f3a6c7.png][]

运行后会出现如上所示的面板，左边工具栏，鼠标停留在上面会提示其功能；右边显示了检测结果，当点击具体某一问题项时，会跳转到对应的源码中。

**3.3、配置检测规则**

通过`File > Settings > Other Settings > PMD`可以打开检测规则的设置界面：

![6e6edef64ac0824560ec0f898a26a06b.png][]

在 “RuleSets（规则设置）” 界面可以管理自定义的检测规则。因为在实际工作中，可能需要根据实际情况自定义检测规则，就可以通过这里导入，如果要使用它，需要在启动 PMD 进行检测时选择该自定义规则。

点击“Options”选项卡，在其中可以配置一些检测规则选项：

![e379d027a9b7c141d20b375aeae33e32.png][]

其中重点需要留意的是“Skip TestSource”这一项，因为在项目中有不少 Android Studio 自动生成的测试代码，如下所示，选择上述选项后可以将其过滤掉。

![4dfa16650bb09f5c92037376a736031c.png][]

### 四、FindBugs ###

#### 1、整体介绍： ####

FindBugs 侧重于发现代码中存在的 bug，如运行时错误检测（空指针检查、未合理关闭资源、字符串相同判断错（==，而不是 equals）等），它可以简单高效全面地帮助我们发现程序代码中存在的 bug 以及潜在隐患，针对各种问题，它提供了简单的修改意见供我们参考

#### 2、安装步骤： ####

通过`File > Settings > Plugins > Marketplace`搜索 “FindBugs”，按照提示进行安装，然后重启即可

#### 3、使用说明： ####

FindBugs 可以分析单个文件、包下面的所有文件、整个 module 下的文件、整个 project 下的文件，右键想要分析的文件名/包名`/module`名`/project`

![54eac7b7af5309e5ae5a4ac7971706da.png][]

分析完之后就会出现结果面板

![8c0aa9e13ad703a5b201d12039b718a1.png][]

点击对应的 item 在右边会定位到具体的代码，这是根据提示进行处理修改就行

![280099127739fcd97a4c809d05651e2b.png][]

#### 4、附：常见的错误信息 ####

**4.1、Bad practice 代码坏习惯**

![5a6c0e3446fe45511e43e9fd4fdf6949.png][]

图片

**4.2、Dodgy code 糟糕的代码**

![0977c1aee053091aef45c70179dad57d.png][]

图片

**4.3、Internationalization 代码国际化相关**

![28d142cc175e58c5d3595c64224199cd.png][]

图片

**4.4、Performance 代码性能相关**

![f13030d03d58887f52462e453c251dfa.png][]

图片

4.5、Experimental：

![0a17e911365a077e4f5c74589d9909d9.png][]

**4.6、Malicious code vulnerability 恶意破坏代码相关**

![ab9741718dcc162980b1760f7086d6c3.png][]

**4.7、Multitreaded correctness 多线程代码正确性相关**

![4e3a76683cd3cab072d50472dbcd34b1.png][]

**4.8、Correctness 代码正确性相关**

![9e6cd05498c36232225ae2f5241f8ae5.png][]

### 五、SonarLint ###

#### 1、整体介绍： ####

sonar 比`Findbugs`高了一个层级，它不仅关注常规静态 BUG，还关注到了如代码质量、包与包、类与类之间的依赖情况，代码耦合情况，类、方法、文件的复杂度，代码中是否包含大量复制粘贴的代码，关注的是项目代码整体的健康情况。sonar 有两种使用方式：插件和客户端，sonar 的插件名称为`sonarLint`。

#### 2、安装步骤： ####

通过`File > Settings > Plugins > Marketplace`搜索 “SonarLint”，按照提示进行安装，然后重启即可

#### 3、使用说明： ####

![a224b1485efe25a53bf83c37a6f58cf8.png][]

右键项目或者文件进行如上图所示操作，执行之后可以看到如下信息，如果代码中有不合理的地方会在 report 中显示，同时点击错误的地方在右边会给出建议的修改供参考。

![da0210027345d1fa1180b8055cacdc5f.png][]

#### 4、配置 SonarLint 服务端： ####

**4.1、配置 Sonar 服务器**

`sonarLint`插件的使用场景是自用自审，但 sonar 也提供了平台版本，使用场景则是他审，sonar 平台的搭建就不在这篇文章介绍了，感兴趣的读者可以自己上网查看，我们这里主要介绍如何在`sonarLint`插件中配置关联 sonar 平台服务器的工程，进行本地检查：

![ca36cdac2689cfd1d5a79538fac6a25a.png][]

点击新增按钮，输入`Configuration Name`，配置`sonarlint`服务器的地址，然后下拉框选择`Login/Password`，输入`sonarlint`服务器的账号密码

![01c5d88e11439451a16a7debf717b3f7.png][]

**4.2、具体 Sonar 工程配置**

配置完服务器之后，需要针对具体工程进行配置，点击`connection`下拉框，选择上面配置好的服务器连接，然后点击`Search in list`，找到对应的工程：

![de174aa0f1868d5faf75659dc1a106a7.png][]

**4.3、使用 SonarLint 检查**

配置完上面两步之后，接下来就可以选择要进行检查的类或者目录进行`sonarlint`检查了（跟第 3 点的使用方式一致），同时，在 commit 代码的时候，勾选 “`Perform Sonarlint analysis`”，会针对你要提交的代码进行 sonarlint 检查

![baf97bf3af85e2d48443a6ba58ecf511.png][]

### 总结 ###

检查代码规范的话，直接使用`Alibaba Java Coding Guidelines`就可以了。

找 BUG 的话，使用`PMD、Findbugs、SonarLint`相互补充。`PMD`自定义能力强，用来自定义项目BUG规则非常好用。`Findbugs`找 BUG 能力很强，我们拿找到的BUG给新员工培训也很好。`SonarLint`规则丰富，比 Findbugs 能覆盖到更全的场景

[7ba54c9c4ebd1dc7c4c5156dbe1f4f42.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/619db6d7f3af4e7abc1beff7921dcd2b.png
[45e92d3dc460be1a9a107d218bad5f84.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/c6e42e4c6aa6433daa22fb82ddff75ff.png
[9ca659f1a573d88cc7e364c397350870.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/26386fded2b645fd9abd03071c130c7b.png
[a62079d57cdb567189fefe2ddef66ca0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/e69d9ec2455a43518d6962fb8ee2e08d.png
[72d35f5342bb5f71f7be819ab874d7f3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/3014bbf889ff42fe981e7fc28d49f4ff.png
[f6aa28cb0c275e5727845316ff0fd9f6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/5d4d9f8c5a99498683ee16ea850a598a.png
[4342fa9d28612123356b97cc8743cfca.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/3242f868eb7f47a1aee2bae75b37a47e.png
[78fa61c7c6c86b4bfa1351e83c4a6773.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/80a21de2eb8f418bb64872e133b50cc2.png
[63ee9b67f86ae61ee310f2605bc60f9e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/8151cf27f06f4d44892f33b15cbd5545.png
[db16ea5c6df7b2d2ad64fac734897f31.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/604f687964544370b3f57d593fc4a768.png
[17926351b1f150eceffa2950d1f3a6c7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/3e57c44113f149829f273589aa9d05b3.png
[6e6edef64ac0824560ec0f898a26a06b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/311a2a75b33b46a18f5f5c0cb101f844.png
[e379d027a9b7c141d20b375aeae33e32.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/a6a2a89206ff4a03aa4ed8f0fe40630a.png
[4dfa16650bb09f5c92037376a736031c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/e1855e3382144f908db4603e555466a9.png
[54eac7b7af5309e5ae5a4ac7971706da.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/56f69e3ead0a4cfeb271c517bd4b0060.png
[8c0aa9e13ad703a5b201d12039b718a1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/ab8823d89bb440a9ad811dcfc6751eef.png
[280099127739fcd97a4c809d05651e2b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/9160e7bb84e8422b8274d8fc1a4ec0f8.png
[5a6c0e3446fe45511e43e9fd4fdf6949.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/095138e68b87443e9ca407f51b99ab9d.png
[0977c1aee053091aef45c70179dad57d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/00efd055b535428983646dc1cc792138.png
[28d142cc175e58c5d3595c64224199cd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/eca290cbf95343a38c50192c13aafe33.png
[f13030d03d58887f52462e453c251dfa.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/68d62e0c6c604d30b3295f851f3023f4.png
[0a17e911365a077e4f5c74589d9909d9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/225325c683344ad8bb946f853d0af762.png
[ab9741718dcc162980b1760f7086d6c3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/71111029f66f4007baf5183062de7582.png
[4e3a76683cd3cab072d50472dbcd34b1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/06291161541b4ace8949738166dfbaa2.png
[9e6cd05498c36232225ae2f5241f8ae5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/6a0d3b6c3a9b4d7a8568972a48da8ce6.png
[a224b1485efe25a53bf83c37a6f58cf8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/441ebe5c6af54d86aaed35e1c920f9ed.png
[da0210027345d1fa1180b8055cacdc5f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/c4be447d1f8140f694c377260ea5f300.png
[ca36cdac2689cfd1d5a79538fac6a25a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/0a446a8bf6644b9ca148817ddbf265f2.png
[01c5d88e11439451a16a7debf717b3f7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/ebead1449d364cd582af6269899efa0b.png
[de174aa0f1868d5faf75659dc1a106a7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/2718ed77187749e1987ac6bcaa2b0b4c.png
[baf97bf3af85e2d48443a6ba58ecf511.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/6a2fd176441647809a5b66c0747be4cd.png