阿里釋出的規約外掛使用指南

一、前言

10月14日，阿里巴巴在杭州雲棲大會上，正式釋出了由阿里巴巴 P3C 專案組，經過 247 天的持續研發，正式釋出眾所期待的 《阿里巴巴 Java 開發規約》的掃描外掛！

把《阿里巴巴 Java 開發規約》強制條目轉化自動外掛，並實現部分的自動編碼。

該外掛已經在 Github 上開源，有興趣的可以直接去看看。

github.com/alibaba/p3c
或者在Github直接搜尋p3c

二、功能介紹

該外掛主要是對《阿里巴巴 Java 開發規約》的一個規約，它是一個 IDE 的外掛，可以自動對手冊中的 Java 不規範的問題進行提示。現在主要支援（IDEA、Eclipse）。

Android Studio 是基於 IDEA 的，所以也是支援 Android 開發人員的。

該外掛在掃描程式碼後，會將不符合規約的程式碼按照 Blocker、Critical、Major 三個等級顯示在下方，甚至在 IDEA 上。

還可以基於 Inspection 機制提供了實時檢測的功能，編寫程式碼的同時也能快速發現不規範的程式碼。而對於歷史程式碼，部分規則實現了批量一鍵修復的功能。

三、安裝

在Android Studio中，和普通外掛一樣：

File->Setting->Plugins，搜尋alibaba，找到Alibaba Java Coding Guidelines ，第一條就是，如圖：

安裝：

重啟 就可以了！

四、使用

1、語言切換

因為該外掛是阿里團隊開發，那當然是支援中文的啦。同時也支援英文。

你可以在Tools->Alibaba Coding Guidelines->Switch language to XXX 進行切換

切換之後，需要重啟才能生效。

2、實時監測

Inspections 大家應該都不陌生，會自動在編碼階段，進行快速靈活的靜態程式碼分析，自動檢測編譯器和執行時錯誤，並提示開發人員。

所有的規範，可以在Setting->Inspections中看到：

舉個例子：

可以看到，這裡提示ZQWebViewActivity類沒有嚴格按照大駝峰命名法進行命名，也沒用註明作者。

可以點選more檢視完整提示：

3、靜態分析程式碼

該外掛除了支援實時監測，也可以靜態全域性分析程式碼：

通過Tools->阿里編碼規約->編碼規約掃描，進行程式碼掃描，監測程式碼規範。當然也可以使用快捷鍵：Ctrl+Alt+Shift+J 。

執行完成後，會按照Blocker、Critical、Major（極嚴重、嚴重、警告）三個等級來顯示不規範的地方：

因為當前外掛是中文版，所以對於我們來說非常友好！

4、VCS前監測

我們在團隊開發時一定會用到版本控制，無非兩種：Git和SVN。而此規約外掛是同時支援兩種版本控制工具的：

在程式碼提交介面，勾選Alibaba Code Guidelines，點選Commit，會如圖彈框提示，開發者可繼續提交，或者取消去修改程式碼。

最後

規約外掛的介紹大概就是這樣，大家可以關注我的微信公眾號——安卓乾貨營，獲取更多精彩內容！