为了让开发者更加方便、并且达到快速规范代码格式的目的并实行起来,阿里巴巴基于《阿里巴巴Java开发规约》手册内容,研发了一套自动化的IDE检测插件(IDEA、Eclipse)。它就是Alibaba Java Coding Guidelines 插件。
该插件在扫描代码后,将不符合规约的代码按Blocker/Critical/Major三个等级显示在下方,甚至在IDEA上,我们还基于Inspection机制提供了实时检测功能,编写代码的同时也能快速发现问题所在。
本博文,重点在如下两种编程工具下安装 Alibaba Java Coding Guidelines 插件。
(1)在IDEA里安装
(2)在Eclipse/MyEclipse里安装
IDEA
1.打开 Settings >> Plugins >> Browse repositories...、
当看到如下情况时,表示安装成功。
我们重启一下IDEA软件,然后查看Tools工具栏下面的内容。
可以看到,工具栏下多出了一个阿里巴巴规约的工具,这就是本博文要介绍的主角了。
Eclipse/MyEclipse
选择help >> Instakll New Software... 进入插件安装界面。
在Work with中输入: https://p3c.alibaba.com/plugin/eclipse/update。
安装完成后悔提示重启,重启后依次点击 Window >> Show View >> Other...然后就能找到我们所安装的插件了。
测试
任意导入一个项目或者代码到我们的编辑器中,然后选择一个文件,右键后选择“编码规约扫描”。
可以看到下方有不符合规约的两个等级:Blockers和Major,实际上Alibaba Java Coding Guidelines 插件会将不符合规约的代码按Blocker/Critical/Major三个等级显示在下方,这是代表不同的级别的意思,由高到低。
1>Blocker: 即系统无法执行、崩溃或严重资源不足、应用模块无法启动或异常退出、无法测试、造成系统不稳定。
严重花屏
内存泄漏
用户数据丢失或破坏
系统崩溃/死机/冻结
模块无法启动或异常退出
严重的数值计算错误
功能设计与需求严重不符
其它导致无法测试的错误, 如服务器500错误
2>Critical:即影响系统功能或操作,主要功能存在严重缺陷,但不会影响到系统稳定性。
功能未实现
功能错误
系统刷新错误
数据通讯错误
轻微的数值计算错误
影响功能及界面的错误字或拼写错误
安全性问题
3> Major:即界面、性能缺陷、兼容性。
操作界面错误(包括数据窗口内列名定义、含义是否一致)
边界条件下错误
提示信息错误(包括未给出信息、信息提示错误等)
长时间操作无进度提示
系统未优化(性能问题)
光标跳转设置不好,鼠标(光标)定位错误
兼容性问题
4>Minor/Trivial:即易用性及建议性问题。
界面格式等不规范
辅助说明描述不清楚
操作时未给用户提示
可输入区域和只读区域没有明显的区分标志
个别不影响产品理解的错别字
文字排列不整齐等一些小问题