Java 开发规约插件

Posted 2020-10-11 Leo_wlCnBlogs

阿里巴巴 Java 开发规约插件初体验

阿里巴巴 Java 开发手册

又一次来谈《阿里巴巴 Java 开发手册》，经过这大半年的版本迭代，这本阿里工程师们总结出来避免写出那么多 Bug 的规范，对于 Java 开发者简直就是必备开发利剑了。

针对这个手册，我之前也简单写过两篇简单的解读，手册的确是清晰的说明了日常开发中很容易踩的坑，我不要脸的把链接放一下：

• 下一个项目为什么要用 SLF4J
• Java 开发中如何正确踩坑

这一次，阿里巴巴于 10 月 14 日在杭州云栖大会上，正式发布众所期待的《阿里巴巴 Java 开发规约》扫描插件！

简单了解一下这插件

该插件由阿里巴巴 P3C 项目组研发。P3C 是世界知名的反潜机，专门对付水下潜水艇，寓意是扫描出所有潜在的代码隐患。

代码已经开源，GitHub：https://github.com/alibaba/p3c
阿里介绍文章：https://mp.weixin.qq.com/s/IbibsXlWHlM59kfXJqRvZA#rd

据说插件支持了IDEA、Eclipse，在扫描代码后，将不符合规约的代码显示出来，甚至在 IDEA 上，我们还基于 Inspection 机制提供了实时检测功能，编写代码的同时也能快速发现问题所在，还实现了批量一键修复的功能。

那我就在 IDEA 下试一下吧。

IDEA 下如何使用？

1.打开 IDEA ，选择 File - Settings - Plugins - Browse repositories
打开 IDEA，选择 File - Settings - Plugins - Browse repositories 后，输入 alibaba 选中 Alibaba Java Coding Guidelines，点击 Install，截至目前已经快有了三千的安装量了。

2.重启IDEA，开始使用
安装后，会提示你重启 IDEA 已启用插件，重启后就可以在你的项目上疯狂点击右键吧，当然菜单栏也会出现俩按钮，它有个快捷键是Ctrl+Shift+Alt+J，你也可以试试看。

当然，选中某一个类，或者在这个类里边右键也可以

3.扫描出坏代码
扫描代码后，将不符合规约的代码按 Blocker/Critical/Major 三个等级显示在下方，双击可以定位至代码处，右侧窗口还有针对代码的批量修复功能，简直不能更 666 了。

稍微解释下Blocker/Critical/Major三个等级，在 Snoar 中对代码规则有五个级别，这是前三个，翻译下就是：崩溃/严重/重要 ，也就是说前两级别是必须要处理掉的。

Eclipse 如何安装插件？

Eclipse 版插件支持4.2（Juno，JDK1.8+）及以上版本，我们提供自主的Update Site，通过 Help >> Install New Software 然后输入https://p3c.alibaba.com/plugin/eclipse/update
即可看到安装列表。大家可以通过 Help >> Check for Udates 进行插件新版检测

我没有在 Eclipse 上体验，你们有 Eclipse 的可以试试看。

总结一下

这个插件可以说对规范代码有重大意义，可以使我们少写一些 Bug，少抛一些异常，少踩一些坑，但真正要写出健壮代码最重要的还在于我们自己，这个插件还存在很多问题，一些容易产生 NPE 的级联调用、空对象什么的，好像它并不能检查出来，依赖工具永远是不可能解决所有问题的。

当然，它的中文版对我们是无比友好的。