阿裡巴巴于10月14日在杭州雲栖大會上,正式釋出衆所期待的《阿裡巴巴Java開發規約》掃描插件。今天,阿裡妹為大家詳細介紹一下IDEA插件與Eclipse插件的安裝使用。
插件下載下傳位址
<a href="https://github.com/alibaba/p3c">https://github.com/alibaba/p3c</a>
或者在Github直接搜尋p3c
阿裡巴巴Java開發手冊IDEA插件
使用指南
通過Jetbrains官方倉庫安裝
1.打開 Settings >> Plugins >> Browse repositories...
2.在搜尋框輸入alibaba即可看到Alibaba Java Code Guidelines插件,點選Install進行安裝,然後重新開機IDE生效
注意:因為插件zip包托管在Jetbrains官方CDN上,是以是從國外的伺服器進行下載下傳,可能會出現逾時的情況
通過下載下傳安裝包進行安裝
1.打開插件頁面
2.Settings >> Plugins >> Install plugin from disk...,選擇剛剛下載下傳的zip包安裝,然後重新開機IDE
注意
最低支援IDEA版本為14.1(buildNumber 141.0,可以在About Intellij IDEA中檢視版本資訊),使用IDEA14的同學最好更新到14.1.7(曆史版本傳送門)
插件基于JDK1.7打包,是以IDEA啟動時使用的JDK版本如果是1.6的話就會報Unsupported major.minor version 51.0異常,建議大家都更新一下。
中文亂碼解決方法
1.修改字型——Appearance&Behavior -> Appearance -> UI Options -> Name 裡面設定成微軟雅黑(microsoft yahei light)
2.Switch Language to English and restart.
插件使用
目前插件實作了集團編碼規約中的41條規則,大部分基于PMD實作,其中有4條規則基于IDEA實作,并且基于IDEA Inspection實作了實時檢測功能。部分規則實作了Quick Fix功能,對于可以提供Quick Fix但沒有提供的,我們會盡快實作,也歡迎有興趣的同學加入進來一起努力。
目前插件檢測有兩種模式:實時檢測、手動觸發。
實時檢測
實時檢測功能會在開發過程中對目前檔案進行檢測,并以高亮的形式提示出來,同時也可以支援Quick Fix,該功能預設開啟,可以通過配置關閉。
結果高亮提示
檢測結果高亮提示,并且滑鼠放上去會彈出提示資訊。
Intention QuickFix功能
Alt+Enter鍵可呼出Intention菜單,不同的規則會提示不同資訊的Quick Fix按鈕
關閉實時檢測
在某些情況下,我們不希望對代碼提示違規資訊,比如我們在閱讀Github開源項目代碼的時候,如果界面出現一堆紅色、黃色的提示,此時心裡肯定是飄過一萬隻草泥馬。這個時候我們可以通過Inspection的設定關閉實時檢測功能。
1.通過右鍵快速關閉(打開)所有規則的實時檢測功能。
2.通過Settings >> Editor >> Inspections 進行手動設定
也可以關閉某條規則的實時檢測功能或者修改提示級别。
代碼掃描
可以通過右鍵菜單、Toolbar按鈕、快捷鍵三種方式手動觸發代碼檢測。同時結果面闆中可以對部分實作了QuickFix功能的規則進行快速修複。
觸發掃描
在目前編輯的檔案中點選右鍵,可以在彈出的菜單中觸發對該檔案的檢測。
在左側的Project目錄樹種點選右鍵,可以觸發對整個工程或者選擇的某個目錄、檔案進行檢測。
如果您打開了IDE的Toolbar,也可以通過Toolbar中的按鈕來觸發檢測,目前Toolbar的按鈕觸發的檢測範圍與您IDE當時的焦點有關,如目前編輯的檔案或者是Project目錄樹選中的項,是不是感覺與右鍵菜單的檢測範圍類似呢。
使用快捷鍵(Ctrl+Shift+Alt+J)觸發彈出視窗,選擇檢測範圍;您也可自定義快捷鍵。
掃描結果
檢測結果直接使用IDEA Run Inspection By Name功能的結果界面,插件的檢測結果分級為Blocker、Critical、Major。預設按等級分組,友善統計每個級别錯誤的數量。
預設情況我們在結果面闆需要輕按兩下具體違規項才能打開對應的源檔案,開啟Autoscroll To Source選項,單擊面闆中的檔案名、或者是具體的違規項的時候IDEA會自動打開對應的源檔案。
QuickFix
對于實作Quick Fix的規則,在結果面闆中可以直接一鍵修複 注意:IDEA14、15可以通過左下角的燈泡進行一鍵修複操作。
阿裡巴巴Java開發手冊Eclipse插件
首先非常感謝大家對插件的支援與意見,Eclipse的功能相對來說比較簡單,希望有更多的同學加入進來一起完善。
插件安裝
環境:JDK1.8,Eclipse4+。有同學遇到過這樣的情況,安裝插件重新開機後,發現沒有對應的菜單項,從日志上也看不到相關的異常資訊,最後把JDK從1.6更新到1.8解決問題。
Help -> Install New Software...
注意:有同學反映插件掃描會觸發JPA插件啟動背景線程執行不明任務,如果不需要的話解除安裝掉JPA插件即可,目前尚未發現原因
目前插件實作了開發手冊中的53條規則,大部分基于PMD實作,其中有4條規則基于Eclipse實作,支援4條規則的QuickFix功能。
所有的覆寫方法,必須加@Override注解,
if/for/while/switch/do等保留字與左右括号之間都必須加空格,
long或者Long初始指派時,必須使用大寫的L,不能是小寫的l)
Object的equals方法容易抛空指針異常,應使用常量或确定有值的對象來調用equals。
目前不支援代碼實時檢測,需要手動觸發,希望更多的人加入進來一起把咱們的插件做得越來越來,盡量提升研發的使用體驗。
可以通過右鍵菜單、Toolbar按鈕兩種方式手動觸發代碼檢測。同時結果面闆中可以對部分實作了QuickFix功能的規則進行快速修複。
也可以通過Toolbar中的按鈕來觸發檢測,目前Toolbar的按鈕觸發的檢測範圍與您IDE當時的焦點有關,如目前編輯的檔案或者是Project目錄樹選中的項,是不是感覺與右鍵菜單的檢測範圍類似呢。
簡潔的結果面闆,按規則等級分類,等級->規則->檔案->違規項。同時還提供一個檢視規則詳情的界面。
清除結果标記更友善,支援上面提到的4條規則QuickFix。
檢視所有規則
國際化
來源:阿裡技術
<a href="https://mp.weixin.qq.com/s/81oBdbNATkkTXShQAfWFJg">原文連結</a>