strchecker——Go源码字符串规范检查lint工具

2022-06-16 16:28:27 浏览数 (1)

1.背景

在大型项目开发过程中，经常会遇到打印大量日志，输出信息和在源码中写注释的情况。对于软件开发来说，我们一般都是打印输出英文的日志（主要考虑软件在各种环境下的兼容性，如果打印中文日志可能会出现乱码，另外英文日志更容易搜索，更容易后续做国际化），但是对于我们中国人来说，很容易就把中文全角的中文标点符号一不注意就写到日志中了。不过源码中的注释因为是完全面向开发者的，不会面向客户，所以如果研发团队全是中国人，那么代码注释用中文就更有效率。

在实际开发过程中，确实就发现了打印日志中包含了中文标点的情况，但是如果我们直接用中文标点在IDE中进行全文搜索，就好发现大量的代码注释使用中文标点，而到底哪里是日志打印时的中文标点，哪里是注释中的中文标点，根本看不出来。于是我参考golangci-lint的代码扫描检查功能，写了一个Go源码中字符串规范检查的lint工具：strchecker。源码放在：https://github.com/studyzy/go-strchecker

2.strchecker介绍

strchecker可以扫描某个文件夹或者该文件夹下的所有子文件夹中的go代码，并对其中的go代码进行语法分析，构建语法树，找到其中申明的常量、变量、函数参数、返回值、赋值、case语句等场景下的字符串string类型，然后对这些字符串进行正则匹配。系统默认的正则匹配方式是只有ASCII字符才是合法字符，只要超过一个字节的（比如中文、中文标点等都是多字节的）就会被匹配到，而匹配到的字符串就算是非法字符串，并最终将这些非法字符串打印出来。

下面举一个示例：

1.安装strchecker

代码语言：javascript复制
go install github.com/studyzy/go-strchecker/cmd/strchecker@latest

2.找到我们要进行扫描的文件夹，这里就以go-strchecker/testdata/ 这个文件夹为例，进行非法字符串扫描。

代码语言：javascript复制
strchecker $GOPATH/src/github.com/studyzy/go-strchecker/testdata

3.输出结果如下：

代码语言：javascript复制
0 /Users/devinzeng/go/src/github.com/studyzy/go-strchecker/testdata/call.go:9:60 has invalid string: "！"
1 /Users/devinzeng/go/src/github.com/studyzy/go-strchecker/testdata/call.go:10:11 has invalid string: "a！b"
2 /Users/devinzeng/go/src/github.com/studyzy/go-strchecker/testdata/call.go:11:5 has invalid string: "aa！"
3 /Users/devinzeng/go/src/github.com/studyzy/go-strchecker/testdata/call.go:12:40 has invalid string: "bb！"
4 /Users/devinzeng/go/src/github.com/studyzy/go-strchecker/testdata/main.go:10:30 has invalid string: "not found！"
5 /Users/devinzeng/go/src/github.com/studyzy/go-strchecker/testdata/main.go:12:17 has invalid string: "no，data！"
6 /Users/devinzeng/go/src/github.com/studyzy/go-strchecker/testdata/main.go:15:14 has invalid string: "Hello，World！"
7 /Users/devinzeng/go/src/github.com/studyzy/go-strchecker/testdata/main.go:16:12 has invalid string: "Current time："
8 /Users/devinzeng/go/src/github.com/studyzy/go-strchecker/testdata/main.go:19:15 has invalid string: "한국어"
9 /Users/devinzeng/go/src/github.com/studyzy/go-strchecker/testdata/main.go:20:15 has invalid string: "にほんご"
10 /Users/devinzeng/go/src/github.com/studyzy/go-strchecker/testdata/main.go:22:14 has invalid string: ":) 


	


编程算法 ascii ide c++ 数据库一体机TData 




	






	

 0 人点赞