插件推薦：如何將Java編碼規範落地實際開發中

一個軟件須要花費80%的生命週期成本去維護。 　
幾乎沒有任何軟件的整個生命週期僅由其原做者來維護。
編碼規範改善軟件的可讀性,讓工程師更快更完全地理解新的代碼。
若是你將源代碼轉變爲一個產品,那麼您須要確保它和你建立的其它產品同樣是乾淨且包裝良好的。

借用《Java編程語言代碼規範》一段開場白，也許就解釋了咱們爲何須要編碼規範。

無規矩不成方圓，無規範不能協做。阿里近萬名Java技術開發者經過不斷總結與提煉，並經歷了屢次大規模一線實戰檢驗及完善，出版了衆所周知的《阿里巴巴Java開發手冊》，但願使更多的開發者團隊在Java開發上更高效、容錯、有協做性，提升代碼質量並下降維護成本，而手冊也儘量涵蓋開發常見環節，包括編程規約、單元測試規約、異常日誌規約、MySQL規約、工程規約、安全規約等。

但對於不少人而言，手冊始終沒法直接應用在平常的開發工做中，若是有相應的IDE插件進行支持，那簡直完美。所以，Cloud Toolkit應運而生。

Cloud Toolkit 集成了 Java 代碼檢查功能。該功能基於《阿里巴巴 Java 開發手冊》中的代碼規約，執行 Java 代碼的靜態檢查，幫助您在編譯前快速發現代碼異常，並提供修改建議。

前提條件

已安裝 2019.11.1 或更高版本的 Cloud Toolkit 插件。安裝方法請參見

• 在Eclipse中安裝和配置Cloud Toolkit
• 在IntelliJ IDEA中安裝和配置Cloud Toolkit

執行代碼檢查

1. 在 IDE 的 Project 面板上左鍵單擊要檢查的工程文件，在彈出的菜單欄中選擇 Alibaba Cloud > Coding Guidelines Check。![]
   若是您不想檢查整個工程，也能夠在工程的文件目錄中選中想要檢查的目錄，在右側代碼編輯區域的空白處單擊鼠標左鍵，選擇 Alibaba Cloud > Coding Guidelines Check，進行檢查。
2. 在工程的文件目錄區域下方會出現 Inspection Results 面板，可在面板下方看到代碼檢查進度。![]
   Cloud Toolkit 默認將檢查出的錯誤按照嚴重程度從高到低分爲 Blocker、Critical、Major。Blocker 程度的錯誤可能會影響代碼的成功編譯。
3. 在 Inspection Results 面板的左側區域顯示錯誤信息目錄。單擊信息則右側區域會顯示錯誤代碼，部分錯誤會提供快速修正建議，以下圖中的標記 1 所示。Inspection Results 面板各區域功能說明以下。

• 上圖標記 2：錯誤信息目錄的最下級節點的行末顯示錯誤代碼所在行數 line XX。雙擊該級節點，則位於Inspection Results 面板上方的代碼編輯區會定位到錯誤代碼並高亮顯示。
• 上圖標記 3 區域內，從左至右，從上至下的按鈕功能以下。
• Rerun Inspection：從新執行代碼檢查
• Group by Severity：按照錯誤嚴重程度分組錯誤信息
• Expand All：將錯誤信息目錄展開至最下級
• Group by Directory：按照目錄分組錯誤信息
• Collapse All：將錯誤信息目錄收起至最上級
• Filter Resolved Items：過濾掉以及修改完成的錯誤
• Go Prev Problem：在錯誤目錄區域移動至上一條錯誤
• Autocsroll to Source：打開此功能，在錯誤目錄區域單擊錯誤信息時，代碼編輯區自動跳轉到錯誤代碼
• Go Next Problem：在錯誤目錄區域移動至下一條錯誤
• Export：將錯誤信息導出至本地，可選擇導出爲 HTML 或 XML 格式
• Edit Settings：編輯錯誤代碼檢查的設置文件
• Apply Quickfix：使用快速修正

1. 您可使用快速修正功能修正代碼，也能夠手動修改代碼。