【原創(chuàng)】Checkstyle項(xiàng)目規(guī)范管理

? ? ? ? 項(xiàng)目總監(jiān)在管理項(xiàng)目時(shí),會(huì)擔(dān)心技術(shù)人員開(kāi)發(fā)代碼不規(guī)范的問(wèn)題。如果人員少口頭述說(shuō)一下就好了。但是人員大呢?比如50人的大團(tuán)隊(duì),如果一個(gè)一個(gè)去說(shuō)那肯定不可能。所以就需要借助工具checkstyle了。checkstyle的介紹如下:

????????“CheckStyle是SourceForge下的一個(gè)項(xiàng)目,提供了一個(gè)幫助JAVA開(kāi)發(fā)人員遵守某些編碼規(guī)范的工具。它能夠自動(dòng)化代碼規(guī)范檢查過(guò)程,從而使得開(kāi)發(fā)人員從這項(xiàng)重要,但是枯燥的任務(wù)中解脫出來(lái)?!?

? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?-------來(lái)自百度百科

? ? ? ? ?相信很多人使用過(guò)它,但是項(xiàng)目經(jīng)理無(wú)法保證所有開(kāi)發(fā)人員都有使用它,但是代碼規(guī)范就是要強(qiáng)制執(zhí)行!接下來(lái)我就介紹項(xiàng)目如何強(qiáng)制執(zhí)行checkstyle,讓開(kāi)發(fā)人員不去繞過(guò)它。

? ? ? ? ?現(xiàn)在的代碼管理基本都是使用git,git里面有個(gè)內(nèi)置工具h(yuǎn)ooks。hooks的作用簡(jiǎn)單來(lái)說(shuō)就是你使用git某些指令的時(shí)候,會(huì)觸發(fā)hooks。可以看做hooks就是git的內(nèi)置攔截器。如果每個(gè)技術(shù)人員能把項(xiàng)目總監(jiān)的hooks裝上,那么就可以在提交操作時(shí)強(qiáng)制執(zhí)行hooks中的pre-commit攔截器:

pre-commit腳本

? ? ? ? 加上之后,如果本次提交的代碼有問(wèn)題,就會(huì)報(bào)checkstyle的錯(cuò)誤,并且終止提交(如果攔截器返回為非0則會(huì)阻止每次操作)。如圖:

checkstyle檢查截圖

? ? ? ?那么技術(shù)總監(jiān)如果能把這個(gè)pre-commit裝到每個(gè)開(kāi)發(fā)人員的hooks里,就可以實(shí)現(xiàn)提交代碼強(qiáng)制執(zhí)行checkstyle。接下來(lái)就是在項(xiàng)目中如何把checkstyle裝到每個(gè)開(kāi)發(fā)人員的電腦中的技術(shù)方案。

? ? ? ?原理:選定一個(gè)必須觸發(fā)的條件,在觸發(fā)方法中在hooks中生成pre-commit。

? ? ? ?我通過(guò)spring的生命周期,在項(xiàng)目啟動(dòng)的時(shí)候,把要執(zhí)行的pre-commit內(nèi)容寫入到該項(xiàng)目對(duì)應(yīng)的git中的hooks里。這樣開(kāi)發(fā)人員只要拉取代碼并且啟動(dòng)項(xiàng)目,pre-commit就會(huì)生成在hooks里了。后續(xù)開(kāi)發(fā)人員提交代碼的時(shí)候,如果有代碼規(guī)范問(wèn)題工具就會(huì)提醒開(kāi)發(fā)人員并且不讓提交成功,只有在做好規(guī)范后才能提交成功。

? ? ? ?由于公司政策,就不貼源代碼了。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容