1. 程式人生 > >Java 開發規約插件

Java 開發規約插件

src 簡單的 blog 實時 java 合規 如何 支持 html

阿裏巴巴 Java 開發規約插件初體驗

阿裏巴巴 Java 開發手冊

又一次來談《阿裏巴巴 Java 開發手冊》,經過這大半年的版本叠代,這本阿裏工程師們總結出來避免寫出那麽多 Bug 的規範,對於 Java 開發者簡直就是必備開發利劍了。

針對這個手冊,我之前也簡單寫過兩篇簡單的解讀,手冊的確是清晰的說明了日常開發中很容易踩的坑,我不要臉的把鏈接放一下:

  • 下一個項目為什麽要用 SLF4J
  • Java 開發中如何正確踩坑

這一次,阿裏巴巴於 10 月 14 日在杭州雲棲大會上,正式發布眾所期待的《阿裏巴巴 Java 開發規約》掃描插件!

簡單了解一下這插件

該插件由阿裏巴巴 P3C 項目組研發。P3C 是世界知名的反潛機,專門對付水下潛水艇,寓意是掃描出所有潛在的代碼隱患。

代碼已經開源,GitHub:https://github.com/alibaba/p3c
阿裏介紹文章:https://mp.weixin.qq.com/s/IbibsXlWHlM59kfXJqRvZA#rd

據說插件支持了IDEA、Eclipse,在掃描代碼後,將不符合規約的代碼顯示出來,甚至在 IDEA 上,我們還基於 Inspection 機制提供了實時檢測功能,編寫代碼的同時也能快速發現問題所在,還實現了批量一鍵修復的功能。

那我就在 IDEA 下試一下吧。

IDEA 下如何使用?

1.打開 IDEA ,選擇 File - Settings - Plugins - Browse repositories


打開 IDEA,選擇 File - Settings - Plugins - Browse repositories 後,輸入 alibaba 選中 Alibaba Java Coding Guidelines,點擊 Install,截至目前已經快有了三千的安裝量了。

技術分享

2.重啟IDEA,開始使用
安裝後,會提示你重啟 IDEA 已啟用插件,重啟後就可以在你的項目上瘋狂點擊右鍵吧,當然菜單欄也會出現倆按鈕,它有個快捷鍵是Ctrl+Shift+Alt+J,你也可以試試看。

技術分享

當然,選中某一個類,或者在這個類裏邊右鍵也可以

技術分享

3.掃描出壞代碼
掃描代碼後,將不符合規約的代碼按 Blocker/Critical/Major

三個等級顯示在下方,雙擊可以定位至代碼處,右側窗口還有針對代碼的批量修復功能,簡直不能更 666 了。

技術分享

稍微解釋下Blocker/Critical/Major三個等級,在 Snoar 中對代碼規則有五個級別,這是前三個,翻譯下就是:崩潰/嚴重/重要 ,也就是說前兩級別是必須要處理掉的。

Eclipse 如何安裝插件?

Eclipse 版插件支持4.2(Juno,JDK1.8+)及以上版本,我們提供自主的Update Site,通過 Help >> Install New Software 然後輸入https://p3c.alibaba.com/plugin/eclipse/update
即可看到安裝列表。大家可以通過 Help >> Check for Udates 進行插件新版檢測

我沒有在 Eclipse 上體驗,你們有 Eclipse 的可以試試看。

總結一下

這個插件可以說對規範代碼有重大意義,可以使我們少寫一些 Bug,少拋一些異常,少踩一些坑,但真正要寫出健壯代碼最重要的還在於我們自己,這個插件還存在很多問題,一些容易產生 NPE 的級聯調用、空對象什麽的,好像它並不能檢查出來,依賴工具永遠是不可能解決所有問題的。

當然,它的中文版對我們是無比友好的。

Java 開發規約插件