版權聲明:本文為部落客原創文章,轉載請注明出處http://blog.csdn.net/u013132758。 https://blog.csdn.net/u013132758/article/details/78337759
前言
好久沒有寫部落格了,前不久的杭州雲栖大會上,阿裡巴巴正式釋出了由阿裡巴巴 P3C 項目組,經過 247 天的持續研發,正式釋出衆所期待的 《阿裡巴巴 Java 開發規約》的掃描插件!
熱愛軍事的朋友應該都知道,P3C 是世界知名的反潛巡邏機,專門對付潛艇,寓意是掃描出所有潛在的代碼隐患。這個項目組是阿裡巴巴開發愛好者自發組織的虛拟項目組,把《阿裡巴巴 Java 開發規約》強制條目轉化自動插件,并實作部分的自動編碼。
關于該項目已經再Github上了,包括《阿裡巴巴Java開發手冊(終極版).pdf》也在上面,有興趣的可以進去看看。
https://github.com/alibaba/p3c插件的主要功能
阿裡技術公衆号于今年的2月9日首次公布《阿裡巴巴Java開發規約》,瞬間引起全民代碼規範的熱潮,上月底又釋出了PDF的終極版,大家都期待配套的靜态掃描工具開放出來。為了讓開發者更加友善、快速将規範推動并實行起來,阿裡巴巴基于手冊内容,研發了一套自動化的IDE檢測插件。于是在今年的雲栖大會上,釋出了阿裡人經過247天持續研發的阿裡巴巴JAVA規約掃描插件——Alibaba
Java Coding Guidelines.
該插件就是《阿裡巴巴Java開發規約》的擴充。為了友善開發者,該插件作為一個IDE的插件形式,支援
IDEA 和Eclipse,當然也支援Android Studio( Android Studio是基于IDEA的)。
該插件在掃描代碼後,将不符合規約的代碼按Blocker/Critical/Major三個等級顯示在下方,甚至在IDEA和Android Studio上,我們還基于Inspection機制提供了實時檢測功能,編寫代碼的同時也能快速發現問題所在。對于曆史代碼,部分規則實作了批量一鍵修複的功能,還有對于送出SVN的代碼該插件也支援掃描。如此爽心悅目的功能是不是很值得擁有?提升代碼品質,提高團隊研發效能。
插件的安裝
Setting=》Plugin=》Browse repositories,搜尋Alibaba就可以了,選擇Alibaba
Java Coding Guidelines,安裝并重新開機。
插件的使用
1、靜态掃描分析JAVA代碼
插件的使用非常簡單,裝好重新開機之後你會發現,頂部工具欄多了兩個按鈕,在某個檔案中右鍵也會多兩個選項。
選擇編碼規約掃描,就會掃描目前檔案,掃描結果如下顯示:将不符合規約的代碼按Blocker/Critical/Major三個等級顯示在下方,并提示不符合什麼規約。
2、Inspections 支援
Inspections 大家應該都比較熟悉,它會自動在我們編碼的階段,進行快速靈活的靜态代碼的掃描分析,自動檢測編譯器和運作時錯誤,并提示開發人員再編譯之前就進行有效的改正和改進。
如下所示,如果沒有及時清除注釋掉的無用代碼會提示。
這些所有的規約在Setting=》Editor=》Inspections 中查到(如圖)。如果不需要檢測這類歸于去掉勾選即可。
3、切換語言
Alibaba Java Coding Guidelines 支援切換語言,Tools=》阿裡編碼規約,切換完重新開機Android Studio即可。
4、VCS的掃描支援
Android
Stuido 中,預設提供 VCS 支援,我們隻需要簡單的配置,就可以支援 Git、SVN 等。例如我們送出代碼時隻需選擇右邊的Alibaba Code Guidelines即可。
5、部分規約的批量修複
前面說了該插件支援部分規約的批量修複功能,具體如何使用如下所示:如果if沒有加大括号,會提示:為語句加上大括号
小結
到此為止Alibaba
Java Coding Guidelines插件的主要情況講解完了,該插件主要是《阿裡巴巴Java開發規約》的擴充,可以抽空看看。關于一些具體的細節可以去Github:
。