背景
筆者在曠視公司，從事私有開發(fā)油狂，使用語言為go历恐。為了提升代碼質(zhì)量，給一個(gè)存在一段時(shí)間的Go代碼倉庫添加靜態(tài)掃描专筷，最終使用golangci-lint + reviewdog增加代碼質(zhì)量弱贼。
為什么選用golangci-lint
golangci-lint 速度快，可選linters多磷蛹，另外我看golint風(fēng)格不爽吮旅。
golangci-lint最喜歡的點(diǎn)是可以配置多種linters，詳見官網(wǎng)文檔味咳。
https://golangci-lint.run/usage/linters/
如何選擇linters
golangci-lint 有50+ linters庇勃，如何選擇golinters。
這里引用GopherCon 2019 俄羅斯小哥的一個(gè)分享槽驶，雖然linters有50+但是有用的就2责嚷，3個(gè)。
ppt見： https://drive.google.com/file/d/1XhIshGdMMq2KxDdOIh100eYnXsQbm0fE/view
那么筆者是如何選擇golinters的呢掂铐？是如何給一個(gè)存在了兩年以上的go倉庫添加Golint呢罕拂。
先回答第二個(gè)問題揍异，如何給一個(gè)存在兩年的代碼倉庫添加golint。不管選用哪種golinters組合爆班，對(duì)于一個(gè)這樣的代碼倉庫都會(huì)有大量的修改衷掷，那么最好的辦法是做增量修改，然后再慢慢改已有的代碼柿菩，這樣避免了大量修lint的沖擊戚嗅，也實(shí)現(xiàn)了代碼質(zhì)量的迭代提升。
如何做代碼的增量golint檢查呢碗旅？如何集成到gitlab-ci中呢渡处？
這里引入了第二個(gè)重量嘉賓: reviewdog
https://github.com/reviewdog/reviewdog
上圖為reviewdog效果圖∷畋伲可以通過reviewdog把golint檢查的問題医瘫，直接commit到gitlab或者github中。
export REVIEWDOG_GITLAB_API_TOKEN=xx
export CI_COMMIT_SHA=xxx
export GITLAB_API=xxx
export CI_REPO_NAME=xxx
golangci-lint run ./... | reviewdog -f=golangci-lint -reporter=gitlab-mr-discussion
通過聲明gitlab ci中的變量就可以把golangci-lint的結(jié)果直接發(fā)送到git diff上的comment種旧困。注：上面的reviewdog是筆者根據(jù)公司gitlab 的api情況調(diào)整過源碼醇份。
實(shí)現(xiàn)了git diff的增量golint后。那么回到了第一個(gè)問題如何選擇golinters吼具。
關(guān)于對(duì)golinters的選擇非常痛苦僚纷，通過各種Linters的描述，和測試效果來看拗盒，linters分為如下幾類
- 完美符合怖竭，exp: bodyclose, deadcode不管改動(dòng)多少代碼都要使用
- 部分符合，有些檢查很好陡蝇，有些檢查不認(rèn)可痊臭。exp: gosimple, govet棄之可惜，用之難受登夫，代碼改動(dòng)破壞較大
- 這個(gè)linters是強(qiáng)迫癥晚期吧广匙，還有點(diǎn)搞笑。不會(huì)選擇
筆者采用的方法為1恼策，2都選擇鸦致，3不選擇，然后1, 2的lint會(huì)comment到gitlab上涣楷。這樣golint不是一個(gè)必須要過的選項(xiàng)分唾，而是comment到MR上后根據(jù)實(shí)際情況選擇修改還是resolve。
優(yōu)點(diǎn)
最大限度的利用已有的linters發(fā)現(xiàn)隱藏的問題总棵，通過迭代的方式剔除不需要的linters
缺點(diǎn)
由于Linters選用較多鳍寂，一個(gè)MR的comment會(huì)很多，需要手動(dòng)resolve
最后
上干貨情龄， 筆者的golangci-lint配置：
enable:
- bodyclose
- deadcode
- varcheck
- ineffassign
- scopelint
- sqlclosecheck
- structcheck
- typecheck
- unused
- gofmt
- goimports
- misspell
- unconvert
- staticcheck
- govet
- gosimple
- unparam
- gocritic
disable:
- errcheck
- noctx
- goconst
- gosec
- exhaustive
結(jié)束語
愛上寫作
