快捷導(dǎo)航

Go源碼字符串規(guī)范檢查lint工具strchecker使用詳解

更新時間：2022年06月24日 08:47:06 作者：深藍studyzy

這篇文章主要為大家介紹了Go源碼字符串規(guī)范檢查lint工具strchecker使用詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪

1.背景

在大型項目開發(fā)過程中，經(jīng)常會遇到打印大量日志，輸出信息和在源碼中寫注釋的情況。對于軟件開發(fā)來說，我們一般都是打印輸出英文的日志（主要考慮軟件在各種環(huán)境下的兼容性，如果打印中文日志可能會出現(xiàn)亂碼，另外英文日志更容易搜索，更容易后續(xù)做國際化），但是對于我們中國人來說，很容易就把中文全角的中文標點符號一不注意就寫到日志中了。不過源碼中的注釋因為是完全面向開發(fā)者的，不會面向客戶，所以如果研發(fā)團隊全是中國人，那么代碼注釋用中文就更有效率。

在實際開發(fā)過程中，確實就發(fā)現(xiàn)了打印日志中包含了中文標點的情況，但是如果我們直接用中文標點在IDE中進行全文搜索，就好發(fā)現(xiàn)大量的代碼注釋使用中文標點，而到底哪里是日志打印時的中文標點，哪里是注釋中的中文標點，根本看不出來。于是我參考golangci-lint的代碼掃描檢查功能，寫了一個Go源碼中字符串規(guī)范檢查的lint工具：strchecker。源碼放在：https://github.com/studyzy/go-strchecker

2.strchecker介紹

strchecker可以掃描某個文件夾或者該文件夾下的所有子文件夾中的go代碼，并對其中的go代碼進行語法分析，構(gòu)建語法樹，找到其中申明的常量、變量、函數(shù)參數(shù)、返回值、賦值、case語句等場景下的字符串string類型，然后對這些字符串進行正則匹配。系統(tǒng)默認的正則匹配方式是只有ASCII字符才是合法字符，只要超過一個字節(jié)的（比如中文、中文標點等都是多字節(jié)的）就會被匹配到，而匹配到的字符串就算是非法字符串，并最終將這些非法字符串打印出來。

下面舉一個示例：

1.安裝strchecker

go install github.com/studyzy/go-strchecker/cmd/strchecker@latest

2.找到我們要進行掃描的文件夾，這里就以go-strchecker/testdata/ 這個文件夾為例，進行非法字符串掃描。

strchecker $GOPATH/src/github.com/studyzy/go-strchecker/testdata

3.輸出結(jié)果如下：

/Users/devinzeng/go/src/github.com/studyzy/go-strchecker/testdata/call.go:9:60 has invalid string: "！"
/Users/devinzeng/go/src/github.com/studyzy/go-strchecker/testdata/call.go:10:11 has invalid string: "a！b"
/Users/devinzeng/go/src/github.com/studyzy/go-strchecker/testdata/call.go:11:5 has invalid string: "aa！"
/Users/devinzeng/go/src/github.com/studyzy/go-strchecker/testdata/call.go:12:40 has invalid string: "bb！"
/Users/devinzeng/go/src/github.com/studyzy/go-strchecker/testdata/main.go:10:30 has invalid string: "not found！"
/Users/devinzeng/go/src/github.com/studyzy/go-strchecker/testdata/main.go:12:17 has invalid string: "no，data！"
/Users/devinzeng/go/src/github.com/studyzy/go-strchecker/testdata/main.go:15:14 has invalid string: "Hello，World！"
/Users/devinzeng/go/src/github.com/studyzy/go-strchecker/testdata/main.go:16:12 has invalid string: "Current time："
/Users/devinzeng/go/src/github.com/studyzy/go-strchecker/testdata/main.go:19:15 has invalid string: "???"
/Users/devinzeng/go/src/github.com/studyzy/go-strchecker/testdata/main.go:20:15 has invalid string: "にほんご"
/Users/devinzeng/go/src/github.com/studyzy/go-strchecker/testdata/main.go:22:14 has invalid string: ":) ??????"

如果是在Goland這樣的IDE中的，那么我們就可以直接點擊源碼路徑，定位到具體的代碼位置了。

5.然后對其中的字符串進行修復(fù)，將其中的中文標點替換成英文標點。

6.如果我們有一些特殊的要求，而不是只允許ASCII碼表中的內(nèi)容才是合法內(nèi)容，比如我們允許中英文，但是不允許日文、韓文等，那么怎么辦？于是我在參數(shù)中預(yù)置了ASCII表允許和ASCII+中文+中文標點允許這兩種常用的匹配類型。如果我們想允許ASCII和中文，那么命令是：

strchecker -invalid-type=1 ./testdata/...

【注意：這里最后的...表示testdata目錄下的所有子文件和子文件夾，會遞歸的掃描，當然因為我們testdata沒有子文件夾，所以這個...加或者不加都是一樣的?！?/p>

輸入結(jié)果為：

testdata/main.go:19:15 has invalid string: "???"
testdata/main.go:20:15 has invalid string: "にほんご"
testdata/main.go:22:14 has invalid string: ":) ????"