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

        盼了好久的《阿里巴巴Java开发规约》插件终于在10月14日的杭州云栖大会《研发效能峰会》上发布了，虽然之前学习了《阿里巴巴Java开发手册(终极版)》，但是在开发的过程中仍然会有很多地方没有按照开发规约来，那么现在发布java开发规约插件后，其好处就不言而喻了。

        首先看一下插件的官方介绍：该插件在扫描代码后，将不符合规约的代码按Blocker/Critical/Major三个等级显示在下方，甚至在IDEA上，还基于Inspection机制提供了实时检测功能，编写代码的同时也能快速发现问题所在。对于历史代码，部分规则实现了批量一键修复的功能。其中有一句值得注意：把《阿里巴巴Java开发规约》强制条目转化成自动化插件，并实现部分的自动编程。具体此插件对Java开发规约支持到何种程度，还需经过长时间使用后再进行总结。

插件安装及使用

1、IDEA

      IDEA最低支持的版本及JDK版本为IDEA 14.1.7，JDK1.7+，打开 Settings >> Plugins >> Browse repositories 输入 Alibaba 搜索，看到对应插件后即可安装，具体步骤如下图：

        安装完成，重启IDEA后，随便打开一个java文件，点击右键，下方会多出两个选项：

      点击“编码规约扫描”，插件会扫描当前类中不符合规约的代码并将其原因一并列出，如图所示（两张图为左右结构，截成一个字太小，故分为两张）：

      图中列出3类编码不规范，分别为：Blocker，最严重，以错误的方式指出并说明原因，必须修改，提供一键修改按钮，即图中的小灯泡：“‘l’替换为‘L’”；Critical，级别较Blocker低一点，以建议的方式指出，但仍要求修改，部分提示有一键修改；Major，最低级别，部分有提示，不会影响程序执行，但建议按照规约修改。以上对于3个级别的理解，均是我个人短时间内使用插件时对其的理解，如果错误的地方，欢迎各路大神指正，谢谢！

      上图是对单个java类的编码规约扫描，也可对多各类（如一个package甚至整个项目）进行扫描，当然这样扫描问题可能会比较多，处理起来也比较麻烦，一个不小心搞错了也不是没可能。贴一个我扫描某一个项目的结果及处理建议图（看这个数量，捂脸中....）：

      对于Blocker级别的问题，大部分都会有一键修改的功能，很方便。

      以上介绍的是手动扫描，可用于检测已完成的历史代码，对历史代码进行整改，同时插件提供了实时监测功能，帮助你在写新代码的过程中及时发现问题，此功能默认开启，可手动关闭（上面右键菜单中“关闭实时监测功能”），在我使用的IDEA中，遇到Blocker级别的问题，会直接以错误提示（红色波浪线），并列出原因及修改建议，点击more可查看更详细的信息（java开发手册中的内容），如图所示：

      对于Critical级别的问题，以淡黄色波浪线提示，同样可查看相信说明，如图所示：

      对于Major级别的问题，部分无提示，但是可以通过手动扫描检测出，有提示的如“删除无用代码”，也以淡黄色波浪线提示，如图所示：

      以上就是在IDEA下使用java开发规约插件的介绍，如此神器，还不快尝试一下？

2、eclipse

      eclipse支持最低版本为Eclipse Juno(eclipse版本比较多，看一下自己的版本是否支持吧)+，JDK1.7+，通过 Help >> Install New Software 然后输入https://p3c.alibaba.com/plugin/eclipse/update 即可看到安装列表。通过 Help >> Check for Udates 进行插件新版检测，步骤如图：

     按照步骤安装即可，最后出现提示包含为签名内容，直接OK即可，安装完成后重启eclipse即可使用。

     安装完成后，工具栏会多两个图标：

      同时右键菜单中出现选项：

      现在打开一个类，来体验一下：

      eclipse中使用插件检测时，result和detail分为了两个tab，为了显示方便，我将其调整类似于IDEA的左右结构，eclipse中一键修复按钮在图中箭头所指的位置，功能就不用再次介绍了。需要说明的是，eclipse不支持实时监测，只有手动执行规约扫描后，才会根据不同级别有不同的提示，但eclipse的提示，并没有IDEA的详细，在不使用手动检测规约时，无法查看更详细的提示信息，比如同样是“if语句缺少大括号”的提示，对比如图（上图为eclipse，下图为IDEA）：

      以上就是在IDEA和eclipse中安装和体验Java开发规约插件，总的来说非常好，如果团队中都使用此规约插件的话，一定可以提升代码质量，提高团队研发效能。感谢阿里！最后附上插件地址，有机会可以深入学习一下：https://github.com/alibaba/p3c

      注：本篇内容，如有侵权，请告知，将立即删除，谢谢！