前言
2017年2月9日,首次公布《阿里巴巴Java開發(fā)手冊》;
2017年9月25日雳锋，阿里巴巴集團(tuán)發(fā)布了《阿里巴巴Java開發(fā)手冊》PDF終極版;
2017年10月14日黄绩，在2017杭州云棲大會上，規(guī)約插件全球首發(fā)玷过。
通過Jetbrains官方倉庫安裝
1. 打開 Settings >> Plugins >> Browse repositories...
2. 在搜索框輸入alibaba即可看到Alibaba Java Code Guidelines插件爽丹，點擊Install進(jìn)行安裝筑煮，然后重啟IDE生效
通過下載安裝包進(jìn)行安裝
1.打開插件頁面
2.Settings >> Plugins >> Install plugin from disk...，選擇剛剛下載的zip包安裝粤蝎，然后重啟IDE
最低支持IDEA版本為14.1（buildNumber 141.0真仲，可以在About Intellij IDEA中查看版本信息），使用IDEA14的同學(xué)最好升級到14.1.7(歷史版本傳送門)
插件基于JDK1.7打包初澎，所以IDEA啟動時使用的JDK版本如果是1.6的話就會報Unsupported major.minor version 51.0異常秸应，建議大家都升級一下。
修改字體——Appearance&Behavior -> Appearance -> UI Options -> Name 里面設(shè)置成微軟雅黑（microsoft yahei light）
Switch Language to English and restart.
目前插件實現(xiàn)了集團(tuán)編碼規(guī)約中的41條規(guī)則碑宴，大部分基于PMD實現(xiàn)软啼，其中有4條規(guī)則基于IDEA實現(xiàn)，并且基于IDEAInspection實現(xiàn)了實時檢測功能延柠。部分規(guī)則實現(xiàn)了Quick Fix功能焰宣，對于可以提供Quick Fix但沒有提供的，我們會盡快實現(xiàn)捕仔，也歡迎有興趣的同學(xué)加入進(jìn)來一起努力匕积。
目前插件檢測有兩種模式：實時檢測、手動觸發(fā)榜跌。
實時檢測功能會在開發(fā)過程中對當(dāng)前文件進(jìn)行檢測闪唆，并以高亮的形式提示出來，同時也可以支持Quick Fix钓葫，該功能默認(rèn)開啟悄蕾，可以通過配置關(guān)閉。
檢測結(jié)果高亮提示础浮，并且鼠標(biāo)放上去會彈出提示信息帆调。
IntentionQuickFix功能
Alt+Enter鍵可呼出Intention菜單，不同的規(guī)則會提示不同信息的Quick Fix按鈕
在某些情況下豆同，我們不希望對代碼提示違規(guī)信息番刊，比如我們在閱讀Github開源項目代碼的時候，如果界面出現(xiàn)一堆紅色影锈、黃色的提示芹务，此時心里肯定是飄過一萬只草泥馬。這個時候我們可以通過Inspection的設(shè)置關(guān)閉實時檢測功能鸭廷。
通過右鍵快速關(guān)閉（打開）所有規(guī)則的實時檢測功能
2. 通過Settings >> Editor >> Inspections 進(jìn)行手動設(shè)置
也可以關(guān)閉某條規(guī)則的實時檢測功能或者修改提示級別枣抱。
可以通過右鍵菜單、Toolbar按鈕辆床、快捷鍵三種方式手動觸發(fā)代碼檢測佳晶。同時結(jié)果面板中可以對部分實現(xiàn)了QuickFix功能的規(guī)則進(jìn)行快速修復(fù)。
在當(dāng)前編輯的文件中點擊右鍵讼载，可以在彈出的菜單中觸發(fā)對該文件的檢測轿秧。
在左側(cè)的Project目錄樹種點擊右鍵中跌，可以觸發(fā)對整個工程或者選擇的某個目錄、文件進(jìn)行檢測淤刃。
如果您打開了IDE的Toolbar，也可以通過Toolbar中的按鈕來觸發(fā)檢測吱型，目前Toolbar的按鈕觸發(fā)的檢測范圍與您IDE當(dāng)時的焦點有關(guān)逸贾，如當(dāng)前編輯的文件或者是Project目錄樹選中的項，是不是感覺與右鍵菜單的檢測范圍類似呢津滞。
使用快捷鍵（Ctrl+Shift+Alt+J）觸發(fā)彈出窗口铝侵，選擇檢測范圍；您也可自定義快捷鍵触徐。
檢測結(jié)果直接使用IDEA Run Inspection By Name功能的結(jié)果界面咪鲜，插件的檢測結(jié)果分級為Blocker、Critical撞鹉、Major疟丙。默認(rèn)按等級分組，方便統(tǒng)計每個級別錯誤的數(shù)量鸟雏。
默認(rèn)情況我們在結(jié)果面板需要雙擊具體違規(guī)項才能打開對應(yīng)的源文件享郊，開啟Autoscroll To Source選項，單擊面板中的文件名孝鹊、或者是具體的違規(guī)項的時候IDEA會自動打開對應(yīng)的源文件炊琉。
對于實現(xiàn)Quick Fix的規(guī)則，在結(jié)果面板中可以直接一鍵修復(fù)注意：IDEA14又活、15可以通過左下角的燈泡進(jìn)行一鍵修復(fù)操作苔咪。
二、阿里巴巴Java開發(fā)手冊Eclipse插件使用指南
首先非常感謝大家對插件的支持與意見柳骄，Eclipse的功能相對來說比較簡單团赏，希望有更多的同學(xué)加入進(jìn)來一起完善。
環(huán)境：JDK1.8耐薯，Eclipse4+馆里。有同學(xué)遇到過這樣的情況，安裝插件重啟后可柿，發(fā)現(xiàn)沒有對應(yīng)的菜單項鸠踪，從日志上也看不到相關(guān)的異常信息，最后把JDK從1.6升級到1.8解決問題复斥。
Help -> Install New Software...
輸入Update Site地址：https://p3c.alibaba.com/plugin/eclipse/update回車营密，然后勾選Ali-CodeAnalysis，再一直點Next Next...按提示走下去就好目锭。 然后就是提示重啟了评汰，安裝完畢纷捞。
注意：有同學(xué)反映插件掃描會觸發(fā)JPA插件啟動后臺線程執(zhí)行不明任務(wù)，如果不需要的話卸載掉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方法容易拋空指針異常捣染，應(yīng)使用常量或確定有值的對象來調(diào)用equals骄瓣。
目前不支持代碼實時檢測，需要手動觸發(fā)耍攘，希望更多的人加入進(jìn)來一起把咱們的插件做得越來越來榕栏，盡量提升研發(fā)的使用體驗。
可以通過右鍵菜單蕾各、Toolbar按鈕兩種方式手動觸發(fā)代碼檢測臼膏。同時結(jié)果面板中可以對部分實現(xiàn)了QuickFix功能的規(guī)則進(jìn)行快速修復(fù)。
在當(dāng)前編輯的文件中點擊右鍵示损，可以在彈出的菜單中觸發(fā)對該文件的檢測渗磅。
在左側(cè)的Project目錄樹種點擊右鍵，可以觸發(fā)對整個工程或者選擇的某個目錄检访、文件進(jìn)行檢測始鱼。
也可以通過Toolbar中的按鈕來觸發(fā)檢測，目前Toolbar的按鈕觸發(fā)的檢測范圍與您IDE當(dāng)時的焦點有關(guān)脆贵，如當(dāng)前編輯的文件或者是Project目錄樹選中的項医清，是不是感覺與右鍵菜單的檢測范圍類似呢。
簡潔的結(jié)果面板卖氨，按規(guī)則等級分類会烙，等級->規(guī)則->文件->違規(guī)項。同時還提供一個查看規(guī)則詳情的界面筒捺。
清除結(jié)果標(biāo)記更方便柏腻，支持上面提到的4條規(guī)則QuickFix。
新聞：https://yq.aliyun.com/articles/224345?spm=5176.100238.spm-cont-list.14.qYOmd3
插件使用指南：https://yq.aliyun.com/articles/224817?spm=5176.100239.blogcont224345.17.Xz3hib
