阿里巴巴java開發(fā)手冊插件全球首發(fā)

前言


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é)果高亮提示

檢測結(jié)果高亮提示础浮,并且鼠標(biāo)放上去會彈出提示信息帆调。

IntentionQuickFix功能

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

關(guān)閉實時檢測

在某些情況下豆同,我們不希望對代碼提示違規(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ù)。

觸發(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é)果

檢測結(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)的源文件炊琉。

QuickFix

對于實現(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ù)。

觸發(fā)掃描

在當(dāng)前編輯的文件中點擊右鍵示损,可以在彈出的菜單中觸發(fā)對該文件的檢測渗磅。

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

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

掃描結(jié)果

簡潔的結(jié)果面板卖氨,按規(guī)則等級分類会烙,等級->規(guī)則->文件->違規(guī)項。同時還提供一個查看規(guī)則詳情的界面筒捺。

清除結(jié)果標(biāo)記更方便柏腻,支持上面提到的4條規(guī)則QuickFix。

查看所有規(guī)則

國際化

新聞: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

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末系吭,一起剝皮案震驚了整個濱河市五嫂,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖沃缘,帶你破解...
    沈念sama閱讀 222,681評論 6 517
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件躯枢,死亡現(xiàn)場離奇詭異,居然都是意外死亡槐臀,警方通過查閱死者的電腦和手機(jī)锄蹂,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,205評論 3 399
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來水慨,“玉大人得糜,你說我怎么就攤上這事〖パ玻” “怎么了掀亩?”我有些...
    開封第一講書人閱讀 169,421評論 0 362
  • 文/不壞的土叔 我叫張陵舔哪,是天一觀的道長欢顷。 經(jīng)常有香客問我,道長捉蚤,這世上最難降的妖魔是什么抬驴? 我笑而不...
    開封第一講書人閱讀 60,114評論 1 300
  • 正文 為了忘掉前任,我火速辦了婚禮缆巧,結(jié)果婚禮上布持,老公的妹妹穿的比我還像新娘。我一直安慰自己陕悬,他們只是感情好题暖,可當(dāng)我...
    茶點故事閱讀 69,116評論 6 398
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著捉超,像睡著了一般胧卤。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上拼岳,一...
    開封第一講書人閱讀 52,713評論 1 312
  • 那天枝誊,我揣著相機(jī)與錄音,去河邊找鬼惜纸。 笑死叶撒,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的耐版。 我是一名探鬼主播祠够,決...
    沈念sama閱讀 41,170評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼粪牲!你這毒婦竟也來了哪审?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 40,116評論 0 277
  • 序言:老撾萬榮一對情侶失蹤虑瀑,失蹤者是張志新(化名)和其女友劉穎湿滓,沒想到半個月后滴须,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,651評論 1 320
  • 正文 獨居荒郊野嶺守林人離奇死亡叽奥,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,714評論 3 342
  • 正文 我和宋清朗相戀三年扔水,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片朝氓。...
    茶點故事閱讀 40,865評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡魔市,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出赵哲,到底是詐尸還是另有隱情待德,我是刑警寧澤,帶...
    沈念sama閱讀 36,527評論 5 351
  • 正文 年R本政府宣布枫夺,位于F島的核電站将宪,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏橡庞。R本人自食惡果不足惜较坛,卻給世界環(huán)境...
    茶點故事閱讀 42,211評論 3 336
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望扒最。 院中可真熱鬧丑勤,春花似錦、人聲如沸吧趣。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,699評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽强挫。三九已至岔霸,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間纠拔,已是汗流浹背秉剑。 一陣腳步聲響...
    開封第一講書人閱讀 33,814評論 1 274
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留稠诲,地道東北人侦鹏。 一個月前我還...
    沈念sama閱讀 49,299評論 3 379
  • 正文 我出身青樓,卻偏偏與公主長得像臀叙,于是被迫代替她去往敵國和親略水。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,870評論 2 361

推薦閱讀更多精彩內(nèi)容