整体介绍

Alibaba Java Coding Guidelines 专注于Java代码规范,目的是让开发者更加方便、快速规范代码格式。该插件在扫描代码后,将不符合规约的代码按 Blocker、Critical、Major 三个等级显示出来,并且大部分可以自动修复,它还基于 Inspection 机制提供了实时检测功能,编写代码的同时也能快速发现问题所在。
阿里巴巴规约扫描包括:
OOP规约
并发处理
控制语句
命名规约
常量定义
注释规范

安装步骤IDEA

File > Settings > Plugins > Marketplace 搜索 “Alibaba Java Coding Guidelines”,按照提示进行安装,然后重启即可。

安使用说明

运行方式:
(1)可以Tools > 阿里编码规约 > 编码规约扫描
enter image description here
(2)在编辑界面或者项目区域点击右键,在右键菜单中选择“编码规约扫描”即可:
enter image description here
菜单功能
编码规约扫描:开始扫描代码
打开/关闭实时检测功能:实时检测代码,一般机器性能比较好的话可以开启这项功能
切换语言至英文:中英文切换
运行结果:
扫描完成后显示结果如下,我们可以看到扫描结果主要分为 Blocker(阻挡者)、Critical(严重问题)、Major(主要的)三个大类,它们表示的是问题的严重程度,严重程度由高到低为:Blocker > Critical > Major,至于每一类中都会包含什么样的问题,图中的内容已经说明了一切。
enter image description here
选中其中的一个问题项目,会出现如下内容(如果当前鼠标点击的是最终项,右边区域显示的是其它的内容,后面会再讲到):
enter image description here
(1)指定区域搜索同一类问题:
当点击③处的按钮时,会弹出如下按钮:
enter image description here
这里选择扫描区域,来扫描鼠标选中的同类问题。如果按照默认选择,那么运行后的结果就如下图所示:
enter image description here
这里我们可以看到,显示了整个Project中的所有该类的问题。
(2)预览具体的不规范代码:
如果点击的是最终的问题点或者问题所在的类文件,那显示的就是如下界面,预览该处不规范的代码。
enter image description here
3.工具栏功能介绍:
enter image description here
Rerun Inspection:重新运行一次扫描
Close:关闭真个AJCG面板
Expand All:展开结果的树状结构,整个结果是树状结构的。
Collapse All:收起结果的树状结构
Go Pre Problem:选择上一个问题
Go Next Problem:选择下一个问题
Help:帮助
Group by Serverity:(不知道如何描述)
Group by derectory:按目录分组/按类名分组间切换
Filter resoled items:过滤掉已经解决的项
Autoscroll to Source:自动滚动到源码
Export:导出,可以导出为XML和HTML两种格式
Edit Settings:编辑设置

安装步骤Eclipse

选择help >> Instakll New Software… 进入插件安装界面
在Work with中输入: p3c.alibaba.com/plug...
enter image description here
enter image description here
enter image description here
安装完成后悔提示重启,重启后依次点击 Window >> Show View >> Other…然后就能找到我们所安装的插件了。
测试:
enter image description here
1>Blocker: 即系统无法执行、崩溃或严重资源不足、应用模块无法启动或异常退出、无法测试、造成系统不稳定。
  严重花屏
  内存泄漏
  用户数据丢失或破坏
  系统崩溃/死机/冻结
  模块无法启动或异常退出
  严重的数值计算错误
  功能设计与需求严重不符
  其它导致无法测试的错误, 如服务器500错误

 2>Critical:即影响系统功能或操作,主要功能存在严重缺陷,但不会影响到系统稳定性。
  功能未实现
  功能错误
  系统刷新错误
  数据通讯错误
  轻微的数值计算错误
  影响功能及界面的错误字或拼写错误
  安全性问题

 3> Major:即界面、性能缺陷、兼容性。
  操作界面错误(包括数据窗口内列名定义、含义是否一致)
  边界条件下错误
  提示信息错误(包括未给出信息、信息提示错误等)
  长时间操作无进度提示
  系统未优化(性能问题)
  光标跳转设置不好,鼠标(光标)定位错误
  兼容性问题

 4>Minor/Trivial:即易用性及建议性问题。
  界面格式等不规范
  辅助说明描述不清楚
  操作时未给用户提示
  可输入区域和只读区域没有明显的区分标志
  个别不影响产品理解的错别字
文字排列不整齐等一些小问题
检查结果一共分三个等级:
enter image description here

作者:刘冬冬  创建时间:2024-06-26 10:50
最后编辑:刘冬冬  更新时间:2024-06-26 16:33