1. 程式人生 > >《阿裏巴巴 Java 開發規約》自動化檢測插件安裝及體驗

《阿裏巴巴 Java 開發規約》自動化檢測插件安裝及體驗

程序 -1 cloud 水平 杭州 代碼掃描 imp 發出 分享

2017 開春之際,有助於提高行業編碼規範化水平的《阿裏巴巴 Java 開發手冊》首次面世。匯聚阿裏集團近萬名技術精英的經驗知識,這套高含金量的手冊一經公開,便引起業界普遍關註和學習。

歷經數次叠代更新,終於在九月份,這套手冊迎來終極版,也是阿裏官方對外發布的最後一個 PDF 版本。與此同時,也正式面向海外發布英文版。

10 月 14號,在杭州雲棲大會上,歷經 247 天的持續研發,《阿裏巴巴 Java 代碼規約》掃描插件正式發布!這套規範將以插件的形式公開走向業界,引領 Java 編程語言的規範開發之路。

阿裏巴巴也提供一個 Apsara Clouder 基礎技能認證之阿裏巴巴編碼規範,幫助大家證明你的編碼風格是否合格。考試地址如下:

https://edu.aliyun.com/certification/cldt02?utm_content=m_30791

技術分享

不得不說,阿裏作為一個有擔當的企業真的是為業界做了很多。這不,擔心很多程序員只是紙上談兵、停留在理論學習上,為了將規範實實在在地應用到真實項目的開發當中,基於這套手冊,阿裏巴巴研發出這份自動化 IDE 檢測插件。並將其開源在 GitHub 網站上面,地址如下:

https://github.com/alibaba/p3c

項目包含三個部分:

  • PMD implementations

  • IntelliJ IDEA plugin

  • Eclipse plugin

下面以IntellJ IDEA為例,詳細演示此插件的安裝及使用過程:

依次打開 [Preferences],[Plugins],[Browse repositories],搜索 alibaba 關鍵字,便能一鍵安裝插件:

技術分享

安裝完成後,重新IDEA。

IDE重啟完成後,在某個java文件或者工程上右鍵點擊菜單,發現多了兩個菜單:

技術分享

點擊編碼規約掃描菜單後,插件就會啟動代碼掃描,並將結果展示在IDE下方:

技術分享

如上圖所示,代碼中違反編碼規約的地方都進行了標註,同事對於違反了具體哪一條編碼規約也給出了提示,非常人性化。

技術分享

點擊某一條具體的規約,會在右側顯示出違反規約的具體的代碼。

《阿裏巴巴 Java 開發規約》自動化檢測插件安裝及體驗