经过247天的持续研发,阿里巴巴于10月14日在杭州云栖大会上,正式发布众所期待的《阿里巴巴Java开发规约》扫描插件!
插件全球首发仪式,大牛云集
阿里巴巴大牛天团倾力助阵:毕玄、玄难、索尼、叶渡,淘宝代码第一人多隆、代码规约作者孤尽携手规约项目组成员,以及业界规约生态代表等重磅大咖联合发布阿里巴巴代码规约插件!
该插件由阿里巴巴P3C项目组研发。P3C是世界知名的反潜机,专门对付水下潜水艇,寓意是扫描出所有潜在的代码隐患。这个项目组是阿里巴巴开发爱好者自发组织形成的虚拟项目组,把《阿里巴巴Java开发规约》强制条目转化成自动化插件,并实现部分的自动编程。
插件下载地址
https://github.com/alibaba/p3c
或者在Github直接搜索p3c
插件有哪些功能?
阿里技术公众号于今年的2月9日首次公布《阿里巴巴Java开发规约》,瞬间引起全民代码规范的热潮,上月底又发布了PDF的终极版,大家踊跃留言,期待配套的静态扫描工具开放出来。
为了让开发者更加方便、快速将规范推动并实行起来,阿里巴巴基于手册内容,研发了一套自动化的IDE检测插件(IDEA、Eclipse)。该插件在扫描代码后,将不符合规约的代码按Blocker/Critical/Major三个等级显示在下方,甚至在IDEA上,我们还基于Inspection机制提供了实时检测功能,编写代码的同时也能快速发现问题所在。对于历史代码,部分规则实现了批量一键修复的功能,如此爽心悦目的功能是不是很值得拥有?提升代码质量,提高团队研发效能,插件将会一路同行。
插件扫描结果示例:
说明:从图中可以看出扫描结果有1个block错误(不符合命名方式);有20个critical错误和54个major错误。双击可以定位至代码处,右侧窗口还有代码的批量修复功能。
如何安装IDEA插件?
目前,我们已将IDEA版的插件,发布至IDEA官方仓库中(最低支持版本14.1.7,JDK1.7+)。你只需打开 Settings >> Plugins >> Browse repositories 输入 Alibaba 搜索,看到对应插件后即可安装。
至于具体如何使用,请大家到官方Github仓库中进行查看。IDEA会自动检测插件新版,并提示出来,所以大家不用担心插件的更新问题。
Github仓库地址:https://github.com/alibaba/p3c
如何安装Eclipse插件?
Eclipse版插件支持4.2(Juno,JDK1.8+)及以上版本,我们提供自主的Update Site,通过 Help >> Install New Software 然后输入https://p3c.alibaba.com/plugin/eclipse/update 即可看到安装列表。大家可以通过 Help >> Check for Udates 进行插件新版检测。
成为全球开源标准代码规范
上月底阿里巴巴对海外发布了《阿里巴巴Java开发规约》的英文版,我们的愿景是做成全世界的开源标准代码规范。
阿里巴巴P3C项目组会长期更新与维护插件,我们也希望更多的人参与进来,除了发现和解决已实现的检测规则以外,能够实现更多有益的规则,让插件变得更加完善并且帮助到更多的开发者。
如果你在使用插件的过程里,有任何问题或建议,欢迎与代码规约作者孤尽联系。
孤尽邮箱:guanbao.yanggb@taobao.com