編碼規約掃描使用方法

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

若是有違反手冊的地方會提示是否繼續提交，選擇取消後會自動對修改的代碼進行掃描