《阿里巴巴Java开发手册》终极版IDE插件

就在10月14日上午9:00  阿里巴巴于在杭州云栖大会《研发效能峰会》上,正式发布《阿里巴巴Java开发手册》扫描插件,该插件在扫描代码后,将不符合《手册》的代码按Blocker/Critical/Major三个等级显示在下方,甚至在IDEA上,还基于Inspection机制提供了实时检测功能,编写代码的同时也能快速发现问题所在。对于历史代码,部分规则实现了批量一键修复的功能。


官网博文地址: https://yq.aliyun.com/articles/224817?spm=5176.100239.0.0.7TT9AJ#

关于规约插件的背景介绍,可见上篇文章:提升团队研发效能利器,《阿里巴巴Java开发手册》插件全球首发(附插件下载地址)

一、阿里巴巴Java开发手册IDEA插件使用指南

通过Jetbrains官方仓库安装

1. 打开 Settings >> Plugins >> Browse repositories...

2. 在搜索框输入alibaba即可看到Alibaba Java Code Guidelines插件,点击Install进行安装,然后重启IDE生效 注意:因为插件zip包托管在Jetbrains官方CDN上,所以是从国外的服务器进行下载,可能会出现超时的情况

通过下载安装包进行安装

1. 打开插件页面

download

2. Settings >> Plugins >> Install plugin from disk...,选择刚刚下载的zip包安装,然后重启IDE

注意

最低支持IDEA版本为14.1(buildNumber 141.0,可以在About Intellij IDEA中查看版本信息),使用IDEA14的同学最好升级到14.1.7(历史版本传送门)

插件基于JDK1.7打包,所以IDEA启动时使用的JDK版本如果是1.6的话就会报Unsupported major.minor version 51.0异常,建议大家都升级一下。

中文乱码解决方法

  1. 修改字体——Appearance&Behavior -> Appearance -> UI Options -> Name 里面设置成微软雅黑(microsoft yahei light)

  2. Switch Language to English and restart.

插件使用

目前插件实现了集团编码规约中的41条规则,大部分基于PMD实现,其中有4条规则基于IDEA实现,并且基于IDEA Inspection实现了实时检测功能。部分规则实现了Quick Fix功能,对于可以提供Quick Fix但没有提供的,我们会尽快实现,也欢迎有兴趣的同学加入进来一起努力。
目前插件检测有两种模式:实时检测、手动触发。

实时检测

实时检测功能会在开发过程中对当前文件进行检测,并以高亮的形式提示出来,同时也可以支持Quick Fix,该功能默认开启,可以通过配置关闭。

结果高亮提示

检测结果高亮提示,并且鼠标放上去会弹出提示信息。

Intention QuickFix功能

Alt+Enter键可呼出Intention菜单,不同的规则会提示不同信息的Quick Fix按钮

关闭实时检测

在某些情况下,我们不希望对代码提示违规信息,比如我们在阅读Github开源项目代码的时候,如果界面出现一堆红色、黄色的提示,此时心里肯定是飘过一万只草泥马。这个时候我们可以通过Inspection的设置关闭实时检测功能。

  1. 通过右键快速关闭(打开)所有规则的实时检测功能


2. 通过Settings >> Editor >> Inspections 进行手动设置

也可以关闭某条规则的实时检测功能或者修改提示级别。

代码扫描

可以通过右键菜单、Toolbar按钮、快捷键三种方式手动触发代码检测。同时结果面板中可以对部分实现了QuickFix功能的规则进行快速修复。

触发扫描

在当前编辑的文件中点击右键,可以在弹出的菜单中触发对该文件的检测。

在左侧的Project目录树种点击右键,可以触发对整个工程或者选择的某个目录、文件进行检测。

如果您打开了IDE的Toolbar,也可以通过Toolbar中的按钮来触发检测,目前Toolbar的按钮触发的检测范围与您IDE当时的焦点有关,如当前编辑的文件或者是Project目录树选中的项,是不是感觉与右键菜单的检测范围类似呢。


使用快捷键(Ctrl+Shift+Alt+J)触发弹出窗口,选择检测范围;您也可自定义快捷键。

扫描结果

检测结果直接使用IDEA Run Inspection By Name功能的结果界面,插件的检测结果分级为Blocker、Critical、Major。默认按等级分组,方便统计每个级别错误的数量。

默认情况我们在结果面板需要双击具体违规项才能打开对应的源文件,开启Autoscroll To Source选项,单击面板中的文件名、或者是具体的违规项的时候IDEA会自动打开对应的源文件。

QuickFix

对于实现Quick Fix的规则,在结果面板中可以直接一键修复 注意:IDEA14、15可以通过左下角的灯泡进行一键修复操作。

二、阿里巴巴Java开发手册Eclipse插件使用指南

首先非常感谢大家对插件的支持与意见,Eclipse的功能相对来说比较简单,希望有更多的同学加入进来一起完善。

插件安装

环境:JDK1.8,Eclipse4+。有同学遇到过这样的情况,安装插件重启后,发现没有对应的菜单项,从日志上也看不到相关的异常信息,最后把JDK从1.6升级到1.8解决问题。

Help -> Install New Software...

输入Update Site地址:https://p3c.alibaba.com/plugin/eclipse/update 回车,然后勾选Ali-CodeAnalysis,再一直点Next Next...按提示走下去就好。 然后就是提示重启了,安装完毕。

注意:有同学反映插件扫描会触发JPA插件启动后台线程执行不明任务,如果不需要的话卸载掉JPA插件即可,目前尚未发现原因

插件使用

目前插件实现了开发手册中的53条规则,大部分基于PMD实现,其中有4条规则基于Eclipse实现,支持4条规则的QuickFix功能。

* 所有的覆写方法,必须加@Override注解, 
* if/for/while/switch/do等保留字与左右括号之间都必须加空格,
* long或者Long初始赋值时,必须使用大写的L,不能是小写的l)
* Object的equals方法容易抛空指针异常,应使用常量或确定有值的对象来调用equals。

目前不支持代码实时检测,需要手动触发,希望更多的人加入进来一起把咱们的插件做得越来越来,尽量提升研发的使用体验。

代码扫描

可以通过右键菜单、Toolbar按钮两种方式手动触发代码检测。同时结果面板中可以对部分实现了QuickFix功能的规则进行快速修复。

触发扫描

在当前编辑的文件中点击右键,可以在弹出的菜单中触发对该文件的检测。

在左侧的Project目录树种点击右键,可以触发对整个工程或者选择的某个目录、文件进行检测。

也可以通过Toolbar中的按钮来触发检测,目前Toolbar的按钮触发的检测范围与您IDE当时的焦点有关,如当前编辑的文件或者是Project目录树选中的项,是不是感觉与右键菜单的检测范围类似呢。

扫描结果

简洁的结果面板,按规则等级分类,等级->规则->文件->违规项。同时还提供一个查看规则详情的界面。

清除结果标记更方便,支持上面提到的4条规则QuickFix。

查看所有规则


国际化

文章作者:阿里云研发效能事业部 骏烈

如你在使用插件的过程里,有任何问题或建议,欢迎与代码规约作者孤尽联系,也欢迎加入P3C项目组,一起打造具有全球竞争力,效率/质量最优的一站式研发/运维/测试平台,加入方式:guanbao.yanggb@taobao.com

________________________________________________________________________

思维导图家的博文:

--两个字牛逼
      git地址为 https://github.com/alibaba/p3c


1    IDea的安装方式:



IDEA版的插件发布到了IDEA官方仓库中(最低支持版本14.1.7,JDK1.7+),
只需打开

 Settings >> Plugins >> Browse repositories

输入 Alibaba 搜索一下便可以看到对应插件了,点击安装等待安装完成。

如图




2  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开发手册(终极版).pdf》源文件。
图片.png


评论区

JFinal

2017-10-17 10:11

已经下载了,非常棒,感谢你的分享

Lg

2017-10-17 11:04

感谢平头哥

年轻人

2017-10-18 09:29

好多图都看不了了,被微信拦截了

杜福忠

2017-10-18 11:28

@年轻人 我把阿里的原文也复制过来看吧, 总有一个能看的

年轻人

2017-10-18 15:49

@杜福忠 嗯嗯,感谢分享

Rlax

2017-10-24 18:13

好用 ! 感谢分享!

浊酒一杯落梨花

2017-10-25 09:30

虽然没用但感觉很牛叉

杜福忠

2017-10-25 10:41

@浊酒一杯落梨花 我们公司现在都装上了 , 如果提交上来的代码被质监扫到不规范的, 下班请串

九块腹肌进先生

2017-10-27 16:48

Myeclipse不支持的么?

jiren

2018-05-11 08:30

过河

2019-02-08 21:48

已经用上了,谢谢分享~