硬核，这 3 款 IDE 插件让你的代码牢不可破

朱雀 2021-07-16 20:09 312阅读 0赞

有一段时间没去电影院了，上次看的还是战争题材的《八佰》，现在还能记得当时的观影感受：热血沸腾的同时，一种宁死不屈的信念从心底油然而生。战场虽然只有四行仓库那么大点的地方，却显得牢不可破，敌人再凶猛的火力，似乎都无法有所突破。

作为和代码打交道的我们，天敌除了乱改需求的“产品经理”（请老老实实地背锅），还有那无穷无尽永远也修改不完的 bug。为了抵御 bug 的侵扰，我们想尽了各种办法，不停地修缮工地，努力让我们的代码变得牢不可破。

这些努力当中，有 3 款优秀的 IDE 插件功不可没。是哪 3 个呢？请腰杆挺直，眼睛睁大，大声呼喊出它们的名字。

![6bdd84d2482c42bef2ce1f536bf87724.png][]

### 01、CheckStyle ###

> Checkstyle 是一个静态代码分析工具，用来检查 Java 源代码是否符合编码规则。

那编码规则由谁定义才能比较被认可呢？

![cacdde99dd605bfea271bdfed6484f19.png][]

除了 Sun，还有谷歌，可以吧？感兴趣的小伙伴可以通过下面的地址阅读一下谷歌的 Java 代码规范。

> [https://google.github.io/styleguide/javaguide.html][https_google.github.io_styleguide_javaguide.html]

可以在 Intellij IDEA 的插件市场里直接安装 CheckStyle 这个插件。

![e459c71dc07f45e64b57e2a992fbcffb.png][]

点击 OK 后，就可以在 Intellij IDEA 的底部看到「CheckStyle」面板，默认支持 Sun 和谷歌的代码规范。

![ed9383e5d0ebe158590ee294113c2a70.png][]

选择一种规则后，可以点击左侧的 2 个小图标对项目或者模块进行检查（也可以使用右键「Check Current File」 检查当前类文件），然后就可以看到修改建议了。

![856819c283b15f45abf04ccecd4d841b.png][]

不过，输出的信息里有大量对代码缩进的建议，是因为 CheckStyle 默认的缩进规则是使用 2 个空格，但我更习惯使用 4 个空格，能不能自定义一下呢？

当然可以。

**第一步**，按照下面的路径把 CheckStyle 的 GitHub 仓库导入到码云（可以提高克隆速度）。

> [https://github.com/itwanger/checkstyle][https_github.com_itwanger_checkstyle]

**第二步**，使用 GitHub 桌面版把导入后的仓库 clone 到本地。

![187f2eecb14fe797d604f71cdbeda135.png][]

PS：我已经克隆过了，所以会有警告提示。

**第三步**，找到 src/main/resources/google\_checks.xml 文件，修改 Indentation（缩进）元素后保存。

**第四步**，打开 Intellij IDEA 的首选项，找到「Tools」→「Checkstyle」。

![d8baa66cf7720f91ee9357123cf650a7.png][]

点击「Configuration File」 栏目底部的「+」号，自定义 Checkstyle 规则。填写「Description」，并将之前复制的路径粘贴到「URL」中，点击「Next」。

![939cf17619b6b69b77b60c93769dfe03.png][]

**第五步**，配置成功后，在「CheckStyle」面板看到我们自定义的检查规则了。选中后，再次扫描，就可以看到缩进的警告信息消失了。

![20d81062b31cbc17f5ac460d9fd0bc52.png][]

如果团队内部使用的话，也可以在谷歌和 sun 的代码规约基础上进行一些调整，从而更符合团队开发的习惯，同时还能起到统一代码规范的作用，美哉美哉。

### 02、Alibaba Java 代码规范 ###

《阿里巴巴 Java 开发手册》自从第一个版本起，就倍受业界关注，毕竟是阿里出品啊。最新版是嵩山版，离线下载地址我贴一下：

> [https://pan.baidu.com/s/1iBVFWUPuJNFEBfG8cmd-aA][https_pan.baidu.com_s_1iBVFWUPuJNFEBfG8cmd-aA] 密码:pplh

我看了很多遍，有些规约已经深深地刻在脑海里，在写代码的时候就会特别注意。甚至有时候写完代码，都要对照一遍规约，看看有哪些细节需要调整。

为了让开发者更加方便、快速的将规范推动并执行起来，阿里巴巴基于这本手册的内容，研发了一套自动化的 IDE 插件（有 Intellij IDEA 和 Eclipse 两个版本）。

Intellij IDEA 可以直接在插件市场进行下载安装。

![013068d31b56ed7c21e192b7c46c075f.png][]

目前插件检测有两种模式：实时检测和手动触发。

**1）实时检测**

《阿里巴巴 Java 开发手册》的第一条规约如下：

![319f0016283083d820695c529ff09b81.png][]

实时检测是默认开启的，我们来“明知故犯”一下：

![007d4c02960a3d3eabea36299a515d56.png][]

在编码的时候，插件就会及时的给出提示建议，说`【_name】命名不能以_或$开始`。

如果不喜欢实时检测的话，可以通过「Tools」→「阿里编码规约」→「关闭实时检测功能」来进行关闭。

**2）手动触发**

在代码编辑区域右键菜单选择「编码规约扫描」就可以对当前文件进行扫描，也可以选择整个项目或者某个目录进行扫描。

![c18a6e1620d9ead435afbda657de45b4.png][]

插件扫描后，会将一些不合手册上面的代码按照 Blocker/Critical/Major 三个等级显示出来，点击某个修改建议可以直接跳转到对应的代码处，这样的话，修改起来就非常便捷了。

### 03、SonarLint ###

SonarLint 可让我们在编写代码的时候就对错误和漏洞进行修复，像拼写检查器一样，可以即时突出地显示出编码中的一些问题，并提供清晰的补救指导，方便我们在提交代码之前就解决它们。

SonarLint 支持很多种语言，包括 Java、Kotlin、JavaScript、Ruby、Python、PHP 等等。也支持很多种 IDE，包括 Eclipse、Intellij IDEA、Visual Studio、VS Code 等等。

Intellij IDEA 可以在插件市场直接安装。

![93895a9f9bd9da8f985308f65f56d239.png][]

SonarLint 默认也是开启实时检查的，当我们在声明 List 的时候没有使用泛型，它不仅指出了问题，还给出了修改建议，甚至示例都写好了，真贴心。

![b3f9ffd032e61501811db4a222d516f0.png][]

### 04、总结 ###

好的编程规范有助于写出易于阅读、质量更高、错误更少、更易于维护的程序。CheckStyle、Alibaba Java 代码规范、SonarLint 这 3 款 Intellij IDEA 插件能在很大程度上帮助我们达到这个目的。

**另外，如果你在 Intellij IDEA 插件市场中下载这 3 款插件的时候速度比较慢的话，可以通过下面的方式进行下载，我已经贴心地替你打包好了。**

> 链接:[https://pan.baidu.com/s/1W9AsoLrBJTEtE9JTJlqNXw][https_pan.baidu.com_s_1W9AsoLrBJTEtE9JTJlqNXw] 密码:pa92

下载完成后，可以在 Intellij IDEA 的插件市场选择本地路径的方式进行安装。

![a812d7461323ed0ed9f9fe35531f7807.png][]

直接选择对应的 zip 包就可以安装了。

![9b5a799532a3bdc3bf4b848f791a251b.png][]

希望能对小伙伴们有所帮助，尽快安排一下吧，从此 bug 离我们远一点，少一点。**最后，别忘了一键三连啊，笔芯~**

[6bdd84d2482c42bef2ce1f536bf87724.png]: /images/20210716/b464efbb7dd641c7bbd89cabe31159c0.png
[cacdde99dd605bfea271bdfed6484f19.png]: /images/20210716/578b5e807fab4aa3890fe72b7ad1affd.png
[https_google.github.io_styleguide_javaguide.html]: https://google.github.io/styleguide/javaguide.html
[e459c71dc07f45e64b57e2a992fbcffb.png]: /images/20210716/09696f57734346de8f04bc334c11e31e.png
[ed9383e5d0ebe158590ee294113c2a70.png]: /images/20210716/a5c67420cdbe40e6b740ca56b4c080be.png
[856819c283b15f45abf04ccecd4d841b.png]: /images/20210716/5044ac3414e1472f863ccea6230f5f4a.png
[https_github.com_itwanger_checkstyle]: https://github.com/itwanger/checkstyle
[187f2eecb14fe797d604f71cdbeda135.png]: /images/20210716/af099ccb9bf64cfeba14ec6935ab1a24.png
[d8baa66cf7720f91ee9357123cf650a7.png]: /images/20210716/6baa317e04eb4c0fa5dfdac2c84101f8.png
[939cf17619b6b69b77b60c93769dfe03.png]: /images/20210716/97140df624de4d81a829fb43719ed46d.png
[20d81062b31cbc17f5ac460d9fd0bc52.png]: /images/20210716/543caf20018b4bfa9ae3cc38dfccf9a0.png
[https_pan.baidu.com_s_1iBVFWUPuJNFEBfG8cmd-aA]: https://pan.baidu.com/s/1iBVFWUPuJNFEBfG8cmd-aA
[013068d31b56ed7c21e192b7c46c075f.png]: /images/20210716/e4fbc4953b884cd4bfdbd39532ed86a2.png
[319f0016283083d820695c529ff09b81.png]: /images/20210716/e6348c5dc65149e286f06c6eea51e66d.png
[007d4c02960a3d3eabea36299a515d56.png]: /images/20210716/86027f11e5f64ecd825fdb5b2c054b42.png
[c18a6e1620d9ead435afbda657de45b4.png]: /images/20210716/a5f4c0560c734b368bbf03734f247621.png
[93895a9f9bd9da8f985308f65f56d239.png]: /images/20210716/b0a5f60d532449d3873c2fa747393358.png
[b3f9ffd032e61501811db4a222d516f0.png]: /images/20210716/312b9f0c37f24a4f91bb86ab3bb4849c.png
[https_pan.baidu.com_s_1W9AsoLrBJTEtE9JTJlqNXw]: https://pan.baidu.com/s/1W9AsoLrBJTEtE9JTJlqNXw
[a812d7461323ed0ed9f9fe35531f7807.png]: /images/20210716/3aee6c19ccc941309854bb57a1362d67.png
[9b5a799532a3bdc3bf4b848f791a251b.png]: /images/20210716/3cd0a8bb2bef4411943a4b84b52d1e45.png