Go 语言如何自定义 linter(静态检查工具)
前言
哈喽,大家好,我是asong
;
通常我们在业务项目中会借助使用静态代码检查工具来保证代码质量,通过静态代码检查工具我们可以提前发现一些问题,比如变量未定义、类型不匹配、变量作用域问题、数组下标越界、内存泄露等问题,工具会按照自己的规则进行问题的严重等级划分,给出不同的标识和提示,静态代码检查助我们尽早的发现问题,Go
语言中常用的静态代码检查工具有golang-lint
、golint
,这些工具中已经制定好了一些规则,虽然已经可以满足大多数场景,但是有些时候我们会遇到针对特殊场景来做一些定制化规则的需求,所以本文我们一起来学习一下如何自定义linter需求;
Go语言中的静态检查是如何实现?
众所周知Go
语言是一门编译型语言,编译型语言离不开词法分析、语法分析、语义分析、优化、编译链接几个阶段,学过编译原理的朋友对下面这个图应该很熟悉:
编译器将高级语言翻译成机器语言,会先对源代码做词法分析,词法分析是将字符序列转换为Token序列的过程,Token一般分为这几类:关键字、标识符、字面量(包含数字、字符串)、特殊符号(如加号、等号),生成Token
序列后,需要进行语法分析,进一步处理后,生成一棵以 表达式为结点的 语法树,这个语法树就是我们常说的AST
,在生成语法树的过程就可以检测一些形式上的错误,比如括号缺少,语法分析完成后,就需要进行语义分析,在这里检查编译期所有能检查静态语义,后面的过程就是中间代码生成、目标代码生成与优化、链接,这里就不详细描述了,这里主要是想引出抽象语法树(AST),我们的静态代码检查工具就是通过分析抽象语法树(AST)根据定制的规则来做的;那么抽象语法树长什么样子呢?我们可以使用标准库提供的go/ast
、go/parser
、go/token
包来打印出AST
,也可以使用可视化工具:http://goast.yuroyoro.net/ 查看AST
,具体AST
长什么样我们可以看下文的例子;
制定linter规则
假设我们现在要在我们团队制定这样一个代码规范,所有函数的第一个参数类型必须是Context
,不符合该规范的我们要给出警告;好了,现在规则已经定好了,现在我们就来想办法实现它;先来一个有问题的示例:
// example.go
package mainfunc add(a, b int) int {return a + b
}
对应AST
如下:
*ast.FuncDecl {8 . . . Name: *ast.Ident {9 . . . . NamePos: 3:610 . . . . Name: "add" 11 . . . . Obj: *ast.Object {12 . . . . . Kind: func13 . . . . . Name: "add" // 函数名14 . . . . . Decl: *(obj @ 7)15 . . . . }16 . . . }17 . . . Type: *ast.FuncType {18 . . . . Func: 3:119 . . . . Params: *ast.FieldList {20 . . . . . Opening: 3:921 . . . . . List: []*ast.Field (len = 1) {22 . . . . . . 0: *ast.Field {23 . . . . . . . Names: []*ast.Ident (len = 2) {24 . . . . . . . . 0: *ast.Ident {25 . . . . . . . . . NamePos: 3:1026 . . . . . . . . . Name: "a"27 . . . . . . . . . Obj: *ast.Object {28 . . . . . . . . . . Kind: var29 . . . . . . . . . . Name: "a"30 . . . . . . . . . . Decl: *(obj @ 22)31 . . . . . . . . . }32 . . . . . . . . }33 . . . . . . . . 1: *ast.Ident {34 . . . . . . . . . NamePos: 3:1335 . . . . . . . . . Name: "b"36 . . . . . . . . . Obj: *ast.Object {37 . . . . . . . . . . Kind: var38 . . . . . . . . . . Name: "b"39 . . . . . . . . . . Decl: *(obj @ 22)40 . . . . . . . . . }41 . . . . . . . . }42 . . . . . . . }43 . . . . . . . Type: *ast.Ident {44 . . . . . . . . NamePos: 3:1545 . . . . . . . . Name: "int" // 参数名46 . . . . . . . }47 . . . . . . }48 . . . . . }49 . . . . . Closing: 3:1850 . . . . }51 . . . . Results: *ast.FieldList {52 . . . . . Opening: -53 . . . . . List: []*ast.Field (len = 1) {54 . . . . . . 0: *ast.Field {55 . . . . . . . Type: *ast.Ident {56 . . . . . . . . NamePos: 3:2057 . . . . . . . . Name: "int"58 . . . . . . . }59 . . . . . . }60 . . . . . }61 . . . . . Closing: -62 . . . . }63 . . . }
方式一:标准库实现custom linter
通过上面的AST
结构我们可以找到函数参数类型具体在哪个结构上,因为我们可以根据这个结构写出解析代码如下:
package mainimport ("fmt""go/ast""go/parser""go/token""log""os"
)func main() {v := visitor{fset: token.NewFileSet()}for _, filePath := range os.Args[1:] {if filePath == "--" { // to be able to run this like "go run main.go -- input.go"continue}f, err := parser.ParseFile(v.fset, filePath, nil, 0)if err != nil {log.Fatalf("Failed to parse file %s: %s", filePath, err)}ast.Walk(&v, f)}
}type visitor struct {fset *token.FileSet
}func (v *visitor) Visit(node ast.Node) ast.Visitor {funcDecl, ok := node.(*ast.FuncDecl)if !ok {return v}params := funcDecl.Type.Params.List // get params// list is equal of zero that don't need to checker.if len(params) == 0 {return v}firstParamType, ok := params[0].Type.(*ast.SelectorExpr)if ok && firstParamType.Sel.Name == "Context" {return v}fmt.Printf("%s: %s function first params should be Context\n",v.fset.Position(node.Pos()), funcDecl.Name.Name)return v
}
然后执行命令如下:
$ go run ./main.go -- ./example.go
./example.go:3:1: add function first params should be Context
通过输出我们可以看到,函数add()
第一个参数必须是Context;这就是一个简单实现,因为AST
的结构实在是有点复杂,就不在这里详细介绍每个结构体了,可以看曹大之前写的一篇文章:golang 和 ast
方式二:go/analysis
看过上面代码的朋友肯定有点抓狂了,有很多实体存在,要开发一个linter
,我们需要搞懂好多实体,好在go/analysis
进行了封装,go/analysis
为linter
提供了统一的接口,它简化了与IDE,metalinters,代码Review等工具的集成。如,任何go/analysis
linter都可以高效的被go vet
执行,下面我们通过代码方式来介绍go/analysis
的优势;
新建一个项目代码结构如下:
.
├── firstparamcontext
│ └── firstparamcontext.go
├── go.mod
├── go.sum
└── testfirstparamcontext├── example.go└── main.go
添加检查模块代码,在firstparamcontext.go
添加如下代码:
package firstparamcontextimport ("go/ast""golang.org/x/tools/go/analysis"
)var Analyzer = &analysis.Analyzer{Name: "firstparamcontext",Doc: "Checks that functions first param type is Context",Run: run,
}func run(pass *analysis.Pass) (interface{}, error) {inspect := func(node ast.Node) bool {funcDecl, ok := node.(*ast.FuncDecl)if !ok {return true}params := funcDecl.Type.Params.List // get params// list is equal of zero that don't need to checker.if len(params) == 0 {return true}firstParamType, ok := params[0].Type.(*ast.SelectorExpr)if ok && firstParamType.Sel.Name == "Context" {return true}pass.Reportf(node.Pos(), "''%s' function first params should be Context\n",funcDecl.Name.Name)return true}for _, f := range pass.Files {ast.Inspect(f, inspect)}return nil, nil
}
然后添加分析器:
package mainimport ("asong.cloud/Golang_Dream/code_demo/custom_linter/firstparamcontext""golang.org/x/tools/go/analysis/singlechecker"
)func main() {singlechecker.Main(firstparamcontext.Analyzer)
}
命令行执行如下:
$ go run ./main.go -- ./example.go
/Users/go/src/asong.cloud/Golang_Dream/code_demo/custom_linter/testfirstparamcontext/example.go:3:1: ''add' function first params should be Context
如果我们想添加更多的规则,使用golang.org/x/tools/go/analysis/multichecker
追加即可。
集成到golang-cli
我们可以把golang-cli
的代码下载到本地,然后在pkg/golinters
下添加firstparamcontext.go
,代码如下:
import ("golang.org/x/tools/go/analysis""github.com/golangci/golangci-lint/pkg/golinters/goanalysis""github.com/fisrtparamcontext"
)func NewfirstparamcontextCheck() *goanalysis.Linter {return goanalysis.NewLinter("firstparamcontext","Checks that functions first param type is Context",[]*analysis.Analyzer{firstparamcontext.Analyzer},nil,).WithLoadMode(goanalysis.LoadModeSyntax)
}
然后重新make
一个golang-cli
可执行文件,加到我们的项目中就可以了;
总结
golang-cli
仓库中pkg/golinters
目录下存放了很多静态检查代码,学会一个知识点的最快办法就是抄代码,先学会怎么使用的,慢慢再把它变成我们自己的;本文没有对AST
标准库做过多的介绍,因为这部分文字描述比较难以理解,最好的办法还是自己去看官方文档、加上实践才能更快的理解。
本文所有代码已经上传:https://github.com/asong2020/Golang_Dream/tree/master/code_demo/custom_linter
好啦,本文到这里就结束了,我是asong,我们下期见。
Go 语言如何自定义 linter(静态检查工具)相关推荐
- cppcheck 自定义规则_cppcheck代码静态检查工具及相关工具插件用法介绍
摘要:介绍代码缺陷静态检查工具(static code analyzer)cppcheck,以及其vs.qtcreator.git.jenkins插件及用法. Cppcheck着重于检测未定义的行为和 ...
- linux shell脚本 静态检查工具 shellcheck 简介
简介 shellcheck 是一款实用的 shell脚本静态检查工具. 首先,可以帮助你提前发现并修复简单的语法错误,节约时间.每次都需要运行才发现写错了一个小地方,确实非常浪费时间. 其次,可以针对 ...
- Jenkins 在 Tomcat 中的部署及代码静态检查工具集成
Jenkins 的简单部署 在安装了 Jenkins 运行所需的依赖(主要是 JDK)之后,可以通过如下步骤简单快速地部署 Jenkins: 下载 Jenkins. 打开终端并切换至下载目录. 运行命 ...
- React Native工程中TSLint静态检查工具的探索之路
背景 建立的代码规范没人遵守,项目中遍地风格迥异的代码,你会不会抓狂? 通过测试用例的程序还会出现Bug,而原因仅仅是自己犯下的低级错误,你会不会抓狂? 某种代码写法存在问题导致崩溃时,只能全工程检查 ...
- 代码静态检查工具PC-Lint运用实践
代码静态检查工具PC-Lint运用实践 如何提交zero bug的产品,如何尽早发现bug,是软件开发工程师和测试工程师都需要思考的问题.我认为高质量的代码是关键,具体实施保障办法有:框架约束,代码评 ...
- 从静态检查工具谈代码编程规范
提升自身编程能力是每一个码农的追求,也许我们每日都可以写上几百几千行代码,抑或每日只能修修补补添加几行代码,可是编写代码的行数的增加确实是提升编程能力的体现吗?从我个人的理解来看并不是这样. 从学校到 ...
- 一些代码静态检查工具的简介
1.KLOCWORK: 适用语言:C, C++, JAVA 是否开源:否, 是否需要编译:是 作用:代码静态检查工具.用于高效检测软件缺陷和安全隐患,提供优秀的静态源代码分析解决方案.软件号称是业界领 ...
- 代码质量静态检查工具
一 点睛 代码质量静态检查工具可以自动快速发现劣质代码,潜在Bug,给出代码优化建议.因此代码静态检查工具在实际项目研发中有举足轻重的作用,利用好各种优秀检查工具是做好品质管理的重要环节. 二 静态分 ...
- C/C++代码缺陷静态检查工具cppcheck
cppcheck介绍和安装 CppCheck是一个C/C++代码缺陷静态检查工具.静态代码检查是检查代码是否安全和健壮,是否有隐藏问题. CppCheck只检查编译器检查不出来的bug,不检查语法错误 ...
- Go语言如何自定义 linter(静态检查工具)
前言 哈喽,大家好,我是asong: 通常我们在业务项目中会借助使用静态代码检查工具来保证代码质量,通过静态代码检查工具我们可以提前发现一些问题,比如变量未定义.类型不匹配.变量作用域问题.数组下标越 ...
最新文章
- 《LeetCode力扣练习》第53题 最大子数组和 Java
- Android之ASD组件(一)
- We Chall-Training: Get Sourced-Writeup
- C++Tower of Hanoi汉诺塔的实现算法(附完整源码)
- 关于function和Object的认识
- 【floyd】HDU 1874 畅通project续
- 《测试驱动数据库开发》——1.2 谁是目标读者
- java 下载文件大小_如何在浏览器中显示使用角度5下载的文件的文件大小?
- find的详细用法及其例子
- Raki的读paper小记:MEMORY REPLAY WITH DATA COMPRESSION FOR CONTINUAL LEARNING
- Android sdk 环境变量配置无效
- 商品信息SKU数据库设计
- Java多线程编程模式实战指南一:Active Object模式
- 安装mysql数据库出现问题_安装mysql数据库及问题解决方法
- UE4引擎源码学习笔记(一):源码整体文件结构
- webpack css-loader style-loader scss-loader cssloader模块化
- java 金额比较大小写_Java金额大小写的转换方法
- 狡猾的老鼠-循环C语言,狡猾的老鼠
- 你是个年轻人,请你好好生活
- windows server 2016 搭建AD域服务