编码规约扫描使用方法

1 安装方法

1.1 插件下载地址

https://github.com/alibaba/p3c

1.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 进行插件新版检测。

1.3 Idea插件安装

打开 IDEA，选择 File - Settings - Plugins - Browse repositories 后，输入 alibaba 选中 Alibaba Java Coding Guidelines，点击 Install

2 扫描方式

2.1 整个工程扫描

1. 选择Java工程根目录

2. 右键选择阿里编码规约扫描

 

image.png

2.2 单文件扫描

单文件扫描和整个工程扫描方式是一致的。具体如下

1. 选择Java工程中的单个文件

2. 右键选择阿里编码规约扫描

3 各指标含义

扫描完毕后结果如下图

 

image.png

3.1 扫描结果分为三类：Blocker（崩溃）Critical（严重）Major（一般）

其中Blocker必须进行修改

3.1.1Blocker: 即系统无法执行、崩溃或严重资源不足、应用模块无法启动或异常退出、无法测试、造成系统不稳定。

1. 严重花屏

2. 内存泄漏

3. 用户数据丢失或破坏

4. 系统崩溃/死机/冻结

5. 模块无法启动或异常退出

6. 严重的数值计算错误

7. 功能设计与需求严重不符

8. 其它导致无法测试的错误, 如服务器500错误

3.1.2 Critical：即影响系统功能或操作，主要功能存在严重缺陷，但不会影响到系统稳定性。

1. 功能未实现

2. 功能错误

3. 系统刷新错误

4. 数据通讯错误

5. 轻微的数值计算错误

6. 影响功能及界面的错误字或拼写错误

7. 安全性问题

3.1.3 Major：即界面、性能缺陷、兼容性。

1. 操作界面错误（包括数据窗口内列名定义、含义是否一致）

2. 边界条件下错误

3. 提示信息错误（包括未给出信息、信息提示错误等）

4. 长时间操作无进度提示

5. 系统未优化（性能问题）

6. 光标跳转设置不好，鼠标（光标）定位错误

7. 兼容性问题

4 其他功能描述

4.1 规则描述功能：可以清晰的看到规则说明，并举例说明

 

image.png

4.2 QuickFix

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

 

image.png

4.3 代码提交时检测（目前只有git且idea工具时才能使用）

在提交代码框勾选Alibaba Code Guideline项

 

image.png

如果有违反手册的地方会提示是否继续提交，选择取消后会自动对修改的代码进行扫描