阿里巴巴于10月14日在杭州云棲大會上，正式發(fā)布眾所期待的《阿里巴巴Java開發(fā)規(guī)約》掃描插件。今天，阿里妹為大家詳細介紹一下IDEA插件與Eclipse插件的安裝使用。

插件下載地址
https://github.com/alibaba/p3c
或者在Github直接搜索p3c

阿里巴巴Java開發(fā)手冊IDEA插件
使用指南

通過Jetbrains官方倉庫安裝

打開 Settings >> Plugins >> Browse repositories…

在搜索框輸入alibaba即可看到Alibaba Java Code Guidelines插件，點擊Install進行安裝，然后重啟IDE生效

注意：因為插件zip包托管在Jetbrains官方CDN上，所以是從國外的服務器進行下載，可能會出現(xiàn)超時的情況

通過下載安裝包進行安裝

打開插件頁面

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 里面設(shè)置成微軟雅黑（microsoft yahei light）

2.Switch Language to English and restart.

插件使用

目前插件實現(xiàn)了集團編碼規(guī)約中的41條規(guī)則，大部分基于PMD實現(xiàn)，其中有4條規(guī)則基于IDEA實現(xiàn)，并且基于IDEA Inspection實現(xiàn)了實時檢測功能。部分規(guī)則實現(xiàn)了Quick Fix功能，對于可以提供Quick Fix但沒有提供的，我們會盡快實現(xiàn)，也歡迎有興趣的同學加入進來一起努力。
目前插件檢測有兩種模式：實時檢測、手動觸發(fā)。

實時檢測

實時檢測功能會在開發(fā)過程中對當前文件進行檢測，并以高亮的形式提示出來，同時也可以支持Quick Fix，該功能默認開啟，可以通過配置關(guān)閉。

結(jié)果高亮提示

檢測結(jié)果高亮提示，并且鼠標放上去會彈出提示信息。

Intention QuickFix功能

Alt+Enter鍵可呼出Intention菜單，不同的規(guī)則會提示不同信息的Quick Fix按鈕

關(guān)閉實時檢測

在某些情況下，我們不希望對代碼提示違規(guī)信息，比如我們在閱讀Github開源項目代碼的時候，如果界面出現(xiàn)一堆紅色、黃色的提示，此時心里肯定是飄過一萬只草泥馬。這個時候我們可以通過Inspection的設(shè)置關(guān)閉實時檢測功能。

1.通過右鍵快速關(guān)閉（打開）所有規(guī)則的實時檢測功能。

通過Settings >> Editor >> Inspections 進行手動設(shè)置

也可以關(guān)閉某條規(guī)則的實時檢測功能或者修改提示級別。

代碼掃描

可以通過右鍵菜單、Toolbar按鈕、快捷鍵三種方式手動觸發(fā)代碼檢測。同時結(jié)果面板中可以對部分實現(xiàn)了QuickFix功能的規(guī)則進行快速修復。

觸發(fā)掃描

在當前編輯的文件中點擊右鍵，可以在彈出的菜單中觸發(fā)對該文件的檢測。

在左側(cè)的Project目錄樹種點擊右鍵，可以觸發(fā)對整個工程或者選擇的某個目錄、文件進行檢測。

如果您打開了IDE的Toolbar，也可以通過Toolbar中的按鈕來觸發(fā)檢測，目前Toolbar的按鈕觸發(fā)的檢測范圍與您IDE當時的焦點有關(guān)，如當前編輯的文件或者是Project目錄樹選中的項，是不是感覺與右鍵菜單的檢測范圍類似呢。

使用快捷鍵（Ctrl+Shift+Alt+J）觸發(fā)彈出窗口，選擇檢測范圍；您也可自定義快捷鍵。

掃描結(jié)果

檢測結(jié)果直接使用IDEA Run Inspection By Name功能的結(jié)果界面，插件的檢測結(jié)果分級為Blocker、Critical、Major。默認按等級分組，方便統(tǒng)計每個級別錯誤的數(shù)量。

默認情況我們在結(jié)果面板需要雙擊具體違規(guī)項才能打開對應的源文件，開啟Autoscroll To Source選項，單擊面板中的文件名、或者是具體的違規(guī)項的時候IDEA會自動打開對應的源文件。

QuickFix

對于實現(xiàn)Quick Fix的規(guī)則，在結(jié)果面板中可以直接一鍵修復 注意：IDEA14、15可以通過左下角的燈泡進行一鍵修復操作。

阿里巴巴Java開發(fā)手冊Eclipse插件
使用指南

首先非常感謝大家對插件的支持與意見，Eclipse的功能相對來說比較簡單，希望有更多的同學加入進來一起完善。

插件安裝

環(huán)境：JDK1.8，Eclipse4+。有同學遇到過這樣的情況，安裝插件重啟后，發(fā)現(xiàn)沒有對應的菜單項，從日志上也看不到相關(guān)的異常信息，最后把JDK從1.6升級到1.8解決問題。
Help -> Install New Software…

輸入Update Site地址：https://p3c.alibaba.com/plugin/eclipse/update 回車，然后勾選Ali-CodeAnalysis，再一直點Next Next…按提示走下去就好。 然后就是提示重啟了，安裝完畢。

注意：有同學反映插件掃描會觸發(fā)JPA插件啟動后臺線程執(zhí)行不明任務，如果不需要的話卸載掉JPA插件即可，目前尚未發(fā)現(xiàn)原因

插件使用

目前插件實現(xiàn)了開發(fā)手冊中的53條規(guī)則，大部分基于PMD實現(xiàn)，其中有4條規(guī)則基于Eclipse實現(xiàn)，支持4條規(guī)則的QuickFix功能。

• 所有的覆寫方法，必須加@Override注解，
• if/for/while/switch/do等保留字與左右括號之間都必須加空格,
• long或者Long初始賦值時，必須使用大寫的L，不能是小寫的l）
• Object的equals方法容易拋空指針異常，應使用常量或確定有值的對象來調(diào)用equals。

目前不支持代碼實時檢測，需要手動觸發(fā)，希望更多的人加入進來一起把咱們的插件做得越來越來，盡量提升研發(fā)的使用體驗。

代碼掃描

可以通過右鍵菜單、Toolbar按鈕兩種方式手動觸發(fā)代碼檢測。同時結(jié)果面板中可以對部分實現(xiàn)了QuickFix功能的規(guī)則進行快速修復。

觸發(fā)掃描

在當前編輯的文件中點擊右鍵，可以在彈出的菜單中觸發(fā)對該文件的檢測。

在左側(cè)的Project目錄樹種點擊右鍵，可以觸發(fā)對整個工程或者選擇的某個目錄、文件進行檢測。

也可以通過Toolbar中的按鈕來觸發(fā)檢測，目前Toolbar的按鈕觸發(fā)的檢測范圍與您IDE當時的焦點有關(guān)，如當前編輯的文件或者是Project目錄樹選中的項，是不是感覺與右鍵菜單的檢測范圍類似呢。

掃描結(jié)果

簡潔的結(jié)果面板，按規(guī)則等級分類，等級->規(guī)則->文件->違規(guī)項。同時還提供一個查看規(guī)則詳情的界面。
清除結(jié)果標記更方便，支持上面提到的4條規(guī)則QuickFix。

查看所有規(guī)則

國際化

總結(jié)

以上是生活随笔為你收集整理的《阿里巴巴Java开发规约》插件使用详细指南的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。