Android 項目優化（一）：項目代碼規範

Android 開發時的項目代碼規範爲主要包含：類，常量，變量，id等命名規範；註釋規範；分包規範；代碼風格規範。

項目代碼規範很常見，阿里巴巴推出了《阿里巴巴Java開發手冊》，並針對 IntelliJ IDEA 提供了 idea-plugin 插件，下面咱們講述一下插件的安裝和使用。

1、項目代碼規範插件安裝

1. 經過Jetbrains官方倉庫安裝

打開 Settings >> Plugins >> Browse repositories...

在搜索框輸入alibaba便可看到Alibaba Java Code Guidelines插件，點擊Install進行安裝，而後重啓IDE生效 

注意：由於插件zip包託管在Jetbrains官方CDN上，因此是從國外的服務器進行下載，可能會出現超時的狀況.

2. 經過下載安裝包進行安裝

打開插件頁面

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異常，建議你們都升級一下。

3. 中文亂碼解決方法

修改字體——Appearance&Behavior -> Appearance -> UI Options -> Name 裏面設置成中文字體——如微軟雅黑。

Switch Language to English and restart

2、插件使用

目前插件實現了開發手冊中的的53條規則，大部分基於PMD實現，其中有4條規則基於IDEA實現，而且實現了實時檢測功能。部分規則實現了Quick Fix功能，對於能夠提供Quick Fix但沒有提供的，咱們會盡快實現，也歡迎有興趣的同窗加入進來一塊兒努力。 目前插件檢測有兩種模式：實時檢測、手動觸發。

實時檢測

實時檢測功能會在開發過程當中對當前文件進行檢測，並以高亮的形式提示出來，同時也能夠支持Quick Fix，該功能默認開啓，能夠經過配置關閉。

結果高亮提示

檢測結果高亮提示，而且鼠標放上去會彈出提示信息。

Intention QuickFix功能

Alt+Enter鍵可呼出Intention菜單，不一樣的規則會提示不一樣信息的Quick Fix按鈕

關閉實時檢測

在某些狀況下，咱們不但願對代碼提示違規信息，好比咱們在閱讀Github開源項目代碼的時候，若是界面出現一堆紅色、黃色的提示，此時內心確定是飄過一萬隻草泥馬。這個時候咱們能夠經過Inspection的設置關閉實時檢測功能。

經過右鍵快速關閉（打開）全部規則的實時檢測功能

 

經過Settings >> Editor >> Inspections 進行手動設置

也能夠關閉某條規則的實時檢測功能或者修改提示級別。

代碼掃描

能夠經過右鍵菜單、Toolbar按鈕、快捷鍵三種方式手動觸發代碼檢測。同時結果面板中能夠對部分實現了QuickFix功能的規則進行快速修復。

觸發掃描

在當前編輯的文件中點擊右鍵，能夠在彈出的菜單中觸發對該文件的檢測。

在左側的Project目錄樹種點擊右鍵，能夠觸發對整個工程或者選擇的某個目錄、文件進行檢測。

若是您打開了IDE的Toolbar，也能夠經過Toolbar中的按鈕來觸發檢測，目前Toolbar的按鈕觸發的檢測範圍與您IDE當時的焦點有關，如當前編輯的文件或者是Project目錄樹選中的項，是否是感受與右鍵菜單的檢測範圍相似呢。

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

掃描結果

檢測結果直接使用IDEA Run Inspection By Name功能的結果界面，插件的檢測結果分級爲Blocker、Critical、Major。默認按等級分組，方便統計每一個級別錯誤的數量。

默認狀況咱們在結果面板須要雙擊具體違規項才能打開對應的源文件，開啓Autoscroll To Source選項，單擊面板中的文件名、或者是具體的違規項的時候IDEA會自動打開對應的源文件。

QuickFix

對於實現Quick Fix的規則，在結果面板中能夠直接一鍵修復 注意：IDEA1四、15能夠經過左下角的燈泡進行一鍵修復操做。

其餘

面板中其餘按鈕的功能你們自行探索吧，就不一一贅述了

代碼提交時檢測

在提交代碼框勾選Alibaba Code Guidelines選項 

若是有違反手冊的地方會提示是否繼續提交，選擇取消後會自動對修改的代碼進行掃描