阿里巴巴Java開發規約外掛簡要說明
2017年10月14日杭州雲棲大會,Java程式碼規約掃描外掛全球首發儀式正式啟動,規範正式以外掛形式公開走向業界,引領Java語言的規範之路。
Java程式碼規約掃描外掛以今年年初發布的《阿里巴巴Java開發規約》為標準,作為Eclipse、IDEA的外掛形式存在,檢測JAVA程式碼中存在不規範得位置然後給予提示。規約外掛是採用kotlin語言開發的,感興趣的同學可以去開看外掛原始碼。
外掛地址: alibaba/p3c
一、外掛安裝
本文以Intellij為例安裝外掛,Eclipse等其他IDEA工具,同學們可以自己看看官方資料
File-->Setting-->Plugins-->Browse repositories-->輸入Alibaba
二、功能說明
規約掃描外掛支援外掛中文,不過筆者使用慣了findbugs、pmd等靜態程式碼分析工具的英文說明,看著中文有點彆扭,不過阿里巴巴支援語言切換至英文。
阿里巴巴規約外掛包含三個子選單:編碼規約掃描、關閉試試檢測功能、切換語言至英文(English)。如果工具欄顯示中文亂碼,可能是字型不支援中文顯示,可以在
Settings--->Appearance&Behavior--->Appearance選擇支援中文的支援
編碼規約掃描外掛掃描結果包含三個bug等級Blocker(崩潰)、Critical(嚴重)、Major(主要)。
我們可以檢視編輯器Inspection,Inspection對每條規約都有詳細介紹
編碼規約掃描外掛支援在提交程式碼執GIT、SVN等VCS版本工具之前對程式碼進行規約檢查
三、原始碼分析
規約外掛是採用kotlin語言開發的,kt程式碼本身不復雜,對開發IDEA外掛和程式碼分析感興趣的同學可以去開看外掛原始碼。
四、總結分析
規約外掛實際上是Alibaba技術文化重要輸出部分,毋庸置疑的是A裡巴巴內部經過多年試錯、沉澱出來的成果,但是作為技術人員還是抱著批判性思維來看待這款工具。大家在看<<阿里巴巴Java開發規約>>還是要根據實際業務場景和歷史技術問題來進行思考