一個軟件需要花費80%的生命週期成本去維護。
幾乎沒有任何軟件的整個生命週期僅由其原作者來維護。
編碼規範改善軟件的可讀性,讓工程師更快更徹底地理解新的代碼。
如果你將源代碼轉變為一個產品,那麼您需要確保它和你創建的其它產品一樣是乾淨且包裝良好的。
借用《Java編程語言代碼規範》一段開場白,也許就解釋了我們為什麼需要編碼規範。
無規矩不成方圓,無規範不能協作。阿里近萬名Java技術開發者通過不斷總結與提煉,並經歷了多次大規模一線實戰檢驗及完善,出版了眾所周知的《阿里巴巴Java開發手冊》,希望使更多的開發者團隊在Java開發上更高效、容錯、有協作性,提高代碼質量並降低維護成本,而手冊也儘可能涵蓋開發常見環節,包括編程規約、單元測試規約、異常日誌規約、MySQL規約、工程規約、安全規約等。
但對於很多人而言,手冊始終無法直接應用在日常的開發工作中,如果有相應的IDE插件進行支持,那簡直完美。因此,Cloud Toolkit應運而生。
Cloud Toolkit 集成了 Java 代碼檢查功能。該功能基於《阿里巴巴 Java 開發手冊》中的代碼規約,執行 Java 代碼的靜態檢查,幫助您在編譯前快速發現代碼異常,並提供修改建議。
前提條件
已安裝 2019.11.1 或更高版本的 Cloud Toolkit 插件。安裝方法請參見
[• 在Eclipse中安裝和配置Cloud Toolkit
](https://help.aliyun.com/document_detail/29970.html#task-1942357)
[• 在IntelliJ IDEA中安裝和配置Cloud Toolkit
](https://help.aliyun.com/document_detail/98762.html#concept-29968-zh)
執行代碼檢查
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:使用快速修正
您可以使用快速修正功能修正代碼,也可以手動修改代碼。
當然,您可以通過各種形式獲取Cloud Toolkit
獲取方式:
• IntelliJ IDEA版/PyCharm版本:
https://plugins.jetbrains.com/plugin/11386-alibaba-cloud-toolkit
• Visual Studio Code版本:
https://marketplace.visualstudio.com/items?itemName=alibabacloud-cloudtoolkit.toolkit-vscode
• Eclipse 版本:
https://marketplace.eclipse.org/content/alibaba-cloud-toolkit
• Maven 版本:
https://help.aliyun.com/document_detail/108682.html
使用教程:
https://help.aliyun.com/document_detail/147728.html?spm=a2c4g.11186623.6.541.1958602bbDiHei