阿里巴巴Java开发规范插件说明-eclipse

阿里规约插件

1、插件安装

环境: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...按提示走下去就好。 然后就是提示重启了,安装完毕。

阿里巴巴Java开发规范插件说明-eclipse_第1张图片

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

插件使用

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

* 所有的覆写方法,必须加@Override注解,

* if/for/while/switch/do等保留字与左右括号之间都必须加空格,

* long或者Long初始赋值时,必须使用大写的L,不能是小写的l)

* Object的equals方法容易抛空指针异常,应使用常量或确定有值的对象来调用equals。

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

代码扫描

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

触发扫描

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

阿里巴巴Java开发规范插件说明-eclipse_第2张图片

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

阿里巴巴Java开发规范插件说明-eclipse_第3张图片

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

扫描结果

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

阿里巴巴Java开发规范插件说明-eclipse_第4张图片

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

国际化

阿里巴巴Java开发规范插件说明-eclipse_第5张图片

阿里巴巴Java开发规范插件说明-eclipse_第6张图片

原文地址:

https://github.com/alibaba/p3c/blob/master/eclipse-plugin/README_cn.md

代码地址:

https://github.com/alibaba/p3c

IDEA文档:
https://github.com/alibaba/p3c/blob/master/idea-plugin/README.md

你可能感兴趣的:(阿里巴巴Java开发规范插件说明-eclipse)