IntelliJ IDEA 插件 阿裏巴巴Java開發手冊(Alibaba Java Coding Guidelines)
以前看到過個:Java開發手冊(阿裏巴巴-公開版),這是個pdf文檔,裏面描述了一些Java開發的規約,裏面確實有很多好用的規約,要是在學校就有機會看看的話,那麽,在畢業之後,實際工作中就會少很多坑。現在,阿裏巴巴又一次對這個文檔進行了升級,直接變成了一個插件。你需要的就是:知道有這麽個插件,然後,還得安裝這個插件,那麽以後,你在寫代碼的時候,這個插件就會自動的糾正你在寫代碼的時候的一些很low的不規範代碼。
下面看怎麽在這個 IntelliJ IDEA 上安裝這個插件。
通過Jetbrains官方倉庫安裝
1. 打開 Settings >> Plugins >> Browse repositories...
2. 在搜索框輸入alibaba即可看到Alibaba Java Code Guidelines插件,點擊Install進行安裝,然後重啟IDE生效
註意:因為插件zip包托管在Jetbrains官方CDN上,所以是從國外的服務器進行下載,可能會出現超時的情況
也就是說,你下載半天,他就是沒下載下來。
表緊,下面還有離線安裝的呢。我提供雲盤鏈接。
通過離線的安裝包安裝
看雲盤地址。
鏈接:http://pan.baidu.com/s/1c2fbTmC 密碼:f9lu
安裝完插件,一般都是需要重啟一下IDE的。重啟完之後,這個插件就可以工作啦。
可能會有中文亂碼以及中英文提示切換
這個中文亂碼說的估計是,這個插件的提示有些是中文的(下面看自定義顯示提示的,就可以看到很多的提示是中文的),因為,這個編輯器 不是老外寫的嗎。所以,他自帶的提示,都是英文的,所以,阿裏寫的插件,自帶的提示就是中文的,這個提示的中文,可能是亂碼,但是也不一定。因為,我安裝這個編輯器的時候,好像默認字體就是微軟雅黑(microsoft yahei light)
可以看下,新出來的2個按鈕
可以看到這個地方,不是可以切換語言至英文嗎?,切換之後,要重啟的。
不過,看我博客的,估計都是使用漢字的,那咱就不換了 ,就用這個中文提示吧。
具體使用
這個不是多了2個按鈕嗎?
上面的tool bar的後面多了2個按鈕,如下圖,這2個按鈕,還可以直接在當前文件內,右鍵,也是可以看到選項的。這是對單個文件操作。
也可以,在左側的Project目錄樹種點擊右鍵,可以觸發對整個工程或者選擇的某個目錄、文件進行檢測。
一個按鈕,綠色的那個“編碼規約掃描”,點擊之後,就會對當前文件進行分析。
後面那個藍色的按鈕,他就是打開和關閉,實時檢測。
實時檢測功能會在開發過程中對當前文件進行檢測,並以高亮的形式提示出來,同時也可以支持 Quick Fix,該功能默認開啟,可以通過配置關閉。
我在上面這個截圖裏面,截取了這個按鈕,也就是藍色的那個,2種情況下的狀態。至於,這個 Quick Fix ,我馬上給你說,這個知道的,就不需要解釋啦,不知道的,就聽濕胸我啰嗦一下吧。
下面是一張,實際分析一個Java文件代碼的截圖。
這個圖,就是你在當前編輯的文件,直接點右上角的那個綠色按鈕““編碼規約掃描””,或者,你右鍵,再選擇“編碼規約掃描”也可以。
然後,就出現了上圖的分析結果。
可以簡單的看一下。
我圖上打圈的這個,剛剛工作的小夥伴,可能就會出這個問題,具體原因,上面也給出了描述。
1,有可能會空指針異常,正確的寫法,就是常量在前面,調用這個equals方法。
2,方法名、參數名、成員變量、局部變量都統一使用lowerCamelCase,必須遵從駝峰形式(這個也是剛剛工作的小夥伴不在意的問題)
3,不允許任何魔法值(即未經定義的常量)直接出現在代碼中。上面那個使用equals方法的這個字符串,是直接寫在代碼裏面的,這個就叫做 “ 魔法值 ”。
4,及時清理不再使用的代碼段或配置信息。當你在改別人代碼的時候,直接把不用的就刪除了吧,別想著說,需求搞不好還會改回來呢。不然滿屏幕都是註釋的但是未刪除的代碼,最後,註釋的代碼比正兒八經工作的代碼還多。
5,關於代碼註釋的正確書寫姿勢啦。這就不多說了。
關於Quick Fix 的使用(高科技,簡單實用。)
這個一般都是在你寫完代碼,發現代碼那地方有提示,看下圖,就知道啦。
就是左邊的那個燈泡狀的東西,一般你鼠標光標移動到代碼下面有橫線的地方,他就會提示你怎麽去修改。
這樣,你可以快捷的修改代碼,比如,上面這個常量字符串應該在前面,這個時候,你只需要按2下下方向,選我截圖所指的那個地方,回車之後,他就把你的代碼給自動修正啦,這就大大加快了代碼 編輯速度。
這地方,有個快捷鍵,不知道這快捷鍵的,估計你就得用鼠標點點點啦,這太慢啦。
我這windows系統,哦,我的idea使用的keymap是eclipse,所以,我這個對應的快捷鍵就是 alt + enter。。。快捷鍵一按,然後,啪啪啪,按幾下方向鍵,就可以直接修改代碼啦。
好多代碼提示的地方,都可以,這麽試試,看看效果。
隨心所欲的使用此插件的提示功能
理論上講,老師給你講的東西,那都是為你好,但是,做為學生的我們,並不希望,事事都聽老師啰嗦。也有一些事兒,這指的是這個插件的提示咯。並不是很必要的,我們不想看到這些提示,怎麽辦呢?這個是可以自定義的。
先看一個不是很必要的提示的截圖吧。
我這都寫了 create by 啦後面也寫日期啦,但是,此插件還是提示我說沒寫作者,下面看這個提示的點開詳情圖。
等下,可能有些老鐵,不知道在哪設置這個名字吧,這地方的默認值是自己電腦的名字,而不一定是你想要的名字。看下面鏈接,怎麽自己設置。
IntelliJ IDEA 中怎麽修改新建文件時,自動生成的註釋的user的默認值
好,那下面就看怎麽把這個不需要的提示給關掉
關掉之後,就不會有這個提示啦。看下圖,就是關掉之後的效果。
關掉分析結果的窗體
我使用的idea的版本是2017.1 ,開發版,也即是需要註冊激活的idea。不是社區版哦,社區版很多功能都不能用。jdk 1.7 1.8 都有。
實際檢測之後的提示實例
下面放幾個這個插件的實際檢測之後,提示效果圖。
關於註釋的正確姿勢的提示。
關於有人寫if語句不帶括號的提示。
關於變量命名不按駝峰法套路的提示。
long類型的數據,後面要用大些的L,這個主要是讓人看的舒服,機器是無所謂的。
枚舉都有寫註釋,不能因為太簡單,就不寫註釋。
還是變量的命名,需要註意的地方。
轉自:http://blog.csdn.net/qq_27093465/article/details/78338932
IntelliJ IDEA 插件 阿裏巴巴Java開發手冊(Alibaba Java Coding Guidelines)