IntelliJ IDEA安裝插件阿里巴巴Java開(kāi)發(fā)手冊(cè)(Alibaba Java Coding Guidelines)
以前看到過(guò)個(gè):Java開(kāi)發(fā)手冊(cè)(阿里巴巴-公開(kāi)版),這是個(gè)pdf文檔,里面描述了一些Java開(kāi)發(fā)的規(guī)約,里面確實(shí)有很多好用的規(guī)約,要是在學(xué)校就有機(jī)會(huì)看看的話,那么,在畢業(yè)之后,實(shí)際工作中就會(huì)少很多坑?,F(xiàn)在,阿里巴巴又一次對(duì)這個(gè)文檔進(jìn)行了升級(jí),直接變成了一個(gè)插件。你需要的就是:知道有這么個(gè)插件,然后,還得安裝這個(gè)插件,那么以后,你在寫(xiě)代碼的時(shí)候,這個(gè)插件就會(huì)自動(dòng)的糾正你在寫(xiě)代碼的時(shí)候的一些很low的不規(guī)范代碼。
下面看怎么在這個(gè) IntelliJ IDEA 上安裝這個(gè)插件。
通過(guò)Jetbrains官方倉(cāng)庫(kù)安裝
1. 打開(kāi) Settings >> Plugins >> Browse repositories...
2. 在搜索框輸入alibaba即可看到Alibaba Java Code Guidelines插件,點(diǎn)擊Install進(jìn)行安裝,然后重啟IDE生效
注意:因?yàn)椴寮ip包托管在Jetbrains官方CDN上,所以是從國(guó)外的服務(wù)器進(jìn)行下載,可能會(huì)出現(xiàn)超時(shí)的情況
也就是說(shuō),你下載半天,他就是沒(méi)下載下來(lái)。
表緊,下面還有離線安裝的呢。我提供云盤(pán)鏈接。
通過(guò)離線的安裝包安裝
下載地址如下:
安裝完插件,一般都是需要重啟一下IDE的。重啟完之后,這個(gè)插件就可以工作啦。
可能會(huì)有中文亂碼以及中英文提示切換
這個(gè)中文亂碼說(shuō)的估計(jì)是,這個(gè)插件的提示有些是中文的(下面看自定義顯示提示的,就可以看到很多的提示是中文的),因?yàn)?,這個(gè)編輯器 不是老外寫(xiě)的嗎。所以,他自帶的提示,都是英文的,所以,阿里寫(xiě)的插件,自帶的提示就是中文的,這個(gè)提示的中文,可能是亂碼,但是也不一定。因?yàn)?,我安裝這個(gè)編輯器的時(shí)候,好像默認(rèn)字體就是微軟雅黑(microsoft yahei light)
可以看下,新出來(lái)的2個(gè)按鈕
可以看到這個(gè)地方,不是可以切換語(yǔ)言至英文嗎?,切換之后,要重啟的。
不過(guò),看我博客的,估計(jì)都是使用漢字的,那咱就不換了 ,就用這個(gè)中文提示吧。
具體使用
這個(gè)不是多了2個(gè)按鈕嗎?
上面的tool bar的后面多了2個(gè)按鈕,如下圖,這2個(gè)按鈕,還可以直接在當(dāng)前文件內(nèi),右鍵,也是可以看到選項(xiàng)的。這是對(duì)單個(gè)文件操作。
也可以,在左側(cè)的Project目錄樹(shù)種點(diǎn)擊右鍵,可以觸發(fā)對(duì)整個(gè)工程或者選擇的某個(gè)目錄、文件進(jìn)行檢測(cè)。
一個(gè)按鈕,綠色的那個(gè)“編碼規(guī)約掃描”,點(diǎn)擊之后,就會(huì)對(duì)當(dāng)前文件進(jìn)行分析。
后面那個(gè)藍(lán)色的按鈕,他就是打開(kāi)和關(guān)閉,實(shí)時(shí)檢測(cè)。
實(shí)時(shí)檢測(cè)功能會(huì)在開(kāi)發(fā)過(guò)程中對(duì)當(dāng)前文件進(jìn)行檢測(cè),并以高亮的形式提示出來(lái),同時(shí)也可以支持 Quick Fix,該功能默認(rèn)開(kāi)啟,可以通過(guò)配置關(guān)閉。
我在上面這個(gè)截圖里面,截取了這個(gè)按鈕,也就是藍(lán)色的那個(gè),2種情況下的狀態(tài)。至于,這個(gè) Quick Fix ,我馬上給你說(shuō),這個(gè)知道的,就不需要解釋啦,不知道的,就聽(tīng)濕胸我啰嗦一下吧。
下面是一張,實(shí)際分析一個(gè)Java文件代碼的截圖。
這個(gè)圖,就是你在當(dāng)前編輯的文件,直接點(diǎn)右上角的那個(gè)綠色按鈕““編碼規(guī)約掃描””,或者,你右鍵,再選擇“編碼規(guī)約掃描”也可以。
然后,就出現(xiàn)了上圖的分析結(jié)果。
可以簡(jiǎn)單的看一下。
我圖上打圈的這個(gè),剛剛工作的小伙伴,可能就會(huì)出這個(gè)問(wèn)題,具體原因,上面也給出了描述。
1,有可能會(huì)空指針異常,正確的寫(xiě)法,就是常量在前面,調(diào)用這個(gè)equals方法。
2,方法名、參數(shù)名、成員變量、局部變量都統(tǒng)一使用lowerCamelCase,必須遵從駝峰形式(這個(gè)也是剛剛工作的小伙伴不在意的問(wèn)題)
3,不允許任何魔法值(即未經(jīng)定義的常量)直接出現(xiàn)在代碼中。上面那個(gè)使用equals方法的這個(gè)字符串,是直接寫(xiě)在代碼里面的,這個(gè)就叫做 “ 魔法值 ”。
4,及時(shí)清理不再使用的代碼段或配置信息。當(dāng)你在改別人代碼的時(shí)候,直接把不用的就刪除了吧,別想著說(shuō),需求搞不好還會(huì)改回來(lái)呢。不然滿屏幕都是注釋的但是未刪除的代碼,最后,注釋的代碼比正兒八經(jīng)工作的代碼還多。
5,關(guān)于代碼注釋的正確書(shū)寫(xiě)姿勢(shì)啦。這就不多說(shuō)了。
關(guān)于Quick Fix 的使用(高科技,簡(jiǎn)單實(shí)用。)
這個(gè)一般都是在你寫(xiě)完代碼,發(fā)現(xiàn)代碼那地方有提示,看下圖,就知道啦。
就是左邊的那個(gè)燈泡狀的東西,一般你鼠標(biāo)光標(biāo)移動(dòng)到代碼下面有橫線的地方,他就會(huì)提示你怎么去修改。
這樣,你可以快捷的修改代碼,比如,上面這個(gè)常量字符串應(yīng)該在前面,這個(gè)時(shí)候,你只需要按2下下方向,選我截圖所指的那個(gè)地方,回車(chē)之后,他就把你的代碼給自動(dòng)修正啦,這就大大加快了代碼 編輯速度。
這地方,有個(gè)快捷鍵,不知道這快捷鍵的,估計(jì)你就得用鼠標(biāo)點(diǎn)點(diǎn)點(diǎn)啦,這太慢啦。
我這windows系統(tǒng),哦,我的idea使用的keymap是eclipse,所以,我這個(gè)對(duì)應(yīng)的快捷鍵就是 alt + enter。。??旖萱I一按,然后,啪啪啪,按幾下方向鍵,就可以直接修改代碼啦。
好多代碼提示的地方,都可以,這么試試,看看效果。
隨心所欲的使用此插件的提示功能
理論上講,老師給你講的東西,那都是為你好,但是,做為學(xué)生的我們,并不希望,事事都聽(tīng)老師啰嗦。也有一些事兒,這指的是這個(gè)插件的提示咯。并不是很必要的,我們不想看到這些提示,怎么辦呢?這個(gè)是可以自定義的。
先看一個(gè)不是很必要的提示的截圖吧。
我這都寫(xiě)了 create by 啦后面也寫(xiě)日期啦,但是,此插件還是提示我說(shuō)沒(méi)寫(xiě)作者,下面看這個(gè)提示的點(diǎn)開(kāi)詳情圖。
等下,可能有些老鐵,不知道在哪設(shè)置這個(gè)名字吧,這地方的默認(rèn)值是自己電腦的名字,而不一定是你想要的名字??聪旅骀溄?,怎么自己設(shè)置。
IntelliJ IDEA 中怎么修改新建文件時(shí),自動(dòng)生成的注釋的user的默認(rèn)值
好,那下面就看怎么把這個(gè)不需要的提示給關(guān)掉
關(guān)掉之后,就不會(huì)有這個(gè)提示啦??聪聢D,就是關(guān)掉之后的效果。
關(guān)掉分析結(jié)果的窗體
我使用的idea的版本是2017.1 ,開(kāi)發(fā)版,也即是需要注冊(cè)激活的idea。不是社區(qū)版哦,社區(qū)版很多功能都不能用。jdk 1.7 1.8 都有。
實(shí)際檢測(cè)之后的提示實(shí)例
下面放幾個(gè)這個(gè)插件的實(shí)際檢測(cè)之后,提示效果圖。
關(guān)于注釋的正確姿勢(shì)的提示。
關(guān)于有人寫(xiě)if語(yǔ)句不帶括號(hào)的提示。
關(guān)于變量命名不按駝峰法套路的提示。
long類(lèi)型的數(shù)據(jù),后面要用大些的L,這個(gè)主要是讓人看的舒服,機(jī)器是無(wú)所謂的。
枚舉都有寫(xiě)注釋,不能因?yàn)樘?jiǎn)單,就不寫(xiě)注釋。
還是變量的命名,需要注意的地方。
哎喲,這個(gè)例子實(shí)在是太多啦,我就先上這么幾個(gè)吧。
到此這篇關(guān)于IntelliJ IDEA安裝插件阿里巴巴Java開(kāi)發(fā)手冊(cè)(Alibaba Java Coding Guidelines)的文章就介紹到這了,更多相關(guān)IDEA安裝阿里巴巴插件內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Spring Jpa多數(shù)據(jù)源工程配置過(guò)程解析
這篇文章主要介紹了Spring Jpa多數(shù)據(jù)源工程配置過(guò)程解析,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-08-08Java 1,2,3,4能組成多少個(gè)互不相同且無(wú)重復(fù)數(shù)字的實(shí)現(xiàn)代碼
這篇文章主要介紹了Java 1,2,3,4能組成多少個(gè)互不相同且無(wú)重復(fù)數(shù)字的實(shí)現(xiàn)代碼,需要的朋友可以參考下2017-02-02tomcat部署java web項(xiàng)目遇到的問(wèn)題及解決方法
這篇文章主要介紹了tomcat部署java web項(xiàng)目遇到的問(wèn)題及解決方法,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2019-07-07Spring中ClassPathXmlApplicationContext類(lèi)的使用詳解
這篇文章主要介紹了Spring中ClassPathXmlApplicationContext類(lèi)的使用詳解,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-01-01Mybatis多個(gè)字段模糊匹配同一個(gè)值的案例
這篇文章主要介紹了Mybatis多個(gè)字段模糊匹配同一個(gè)值的案例,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2020-09-09SpringCloud gateway如何修改返回?cái)?shù)據(jù)
這篇文章主要介紹了SpringCloud gateway如何修改返回?cái)?shù)據(jù)的操作,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-06-06