通常我們在業務專案中會借助使用靜態程式碼檢查工具來保證程式碼質量，透過靜態程式碼檢查工具我們可以提前發現一些問題，例如變數未定義、類型不符、變數作用域問題、陣列下標越界、記憶體外洩等問題，工具會依照自己的規則進行問題的嚴重等級劃分，給出不同的識別和提示，靜態程式碼檢查助我們儘早的發現問題，Go語言中常用的靜態程式碼檢查工具有golang-lint、golint，這些工具中已經制定好了一些規則，雖然已經可以滿足大多數場景，但是有些時候我們會遇到針對特殊場景來做一些客製化規則的需求，所以本文我們一起來學習一下如何自訂linter需求；
眾所周知Go語言是一門編譯型語言，編譯型語言離不開詞法分析、語法分析、語意分析、最佳化、編譯連結幾個階段，學過編譯原理的朋友對下面這個圖應該很熟悉：
編譯器將高階語言翻譯成機器語言，會先對原始碼做詞法分析，詞法分析是將字元序列轉換為Token序列的過程， Token一般分為這幾類：關鍵字、識別碼、字面量（包含數字、字串）、特殊符號（如加號、等號），產生Token序列之後，需要進行語法分析，進一步處理後，生成一棵以表達式為結點的語法樹，這個語法樹就是我們常說的AST，在生成語法樹的過程就可以檢測一些形式上的錯誤，例如括號缺少，語法分析完成後，就需要進行語義分析，在這裡檢查編譯期所有能檢查靜態語義，後面的過程就是中間代碼生成、目標代碼生成與優化、鏈接，這裡就不詳細描述了，這裡主要是想引出抽象語法樹（AST），我們的靜態程式碼檢查工具就是透過分析抽象語法樹（AST）根據定制的規則來做的；那麼抽象語法樹長什麼樣子呢？我們可以使用標準函式庫提供的go/ast、go/parser、go/token套件來列印出AST#，也可以使用視覺化工具：http://goast.yuroyoro.net/ 查看AST，具體AST長什麼樣我們可以看下文的例子；
假設我們現在要在我們團隊制定這樣一個程式碼規範，所有函數的第一個參數類型必須是Context，不符合該規範的我們要給出警告；好了，現在規則已經定好了，現在我們就來想辦法實現它；先來一個有問題的示例：
// example.go
package main
func add(a, b int) int {
return a + b
}對應AST如下：
*ast.FuncDecl {
8 . . . Name: *ast.Ident {
9 . . . . NamePos: 3:6
10 . . . . Name: "add"
11 . . . . Obj: *ast.Object {
12 . . . . . Kind: func
13 . . . . . Name: "add" // 函数名
14 . . . . . Decl: *(obj @ 7)
15 . . . . }
16 . . . }
17 . . . Type: *ast.FuncType {
18 . . . . Func: 3:1
19 . . . . Params: *ast.FieldList {
20 . . . . . Opening: 3:9
21 . . . . . List: []*ast.Field (len = 1) {
22 . . . . . . 0: *ast.Field {
23 . . . . . . . Names: []*ast.Ident (len = 2) {
24 . . . . . . . . 0: *ast.Ident {
25 . . . . . . . . . NamePos: 3:10
26 . . . . . . . . . Name: "a"
27 . . . . . . . . . Obj: *ast.Object {
28 . . . . . . . . . . Kind: var
29 . . . . . . . . . . Name: "a"
30 . . . . . . . . . . Decl: *(obj @ 22)
31 . . . . . . . . . }
32 . . . . . . . . }
33 . . . . . . . . 1: *ast.Ident {
34 . . . . . . . . . NamePos: 3:13
35 . . . . . . . . . Name: "b"
36 . . . . . . . . . Obj: *ast.Object {
37 . . . . . . . . . . Kind: var
38 . . . . . . . . . . Name: "b"
39 . . . . . . . . . . Decl: *(obj @ 22)
40 . . . . . . . . . }
41 . . . . . . . . }
42 . . . . . . . }
43 . . . . . . . Type: *ast.Ident {
44 . . . . . . . . NamePos: 3:15
45 . . . . . . . . Name: "int" // 参数名
46 . . . . . . . }
47 . . . . . . }
48 . . . . . }
49 . . . . . Closing: 3:18
50 . . . . }
51 . . . . Results: *ast.FieldList {
52 . . . . . Opening: -
53 . . . . . List: []*ast.Field (len = 1) {
54 . . . . . . 0: *ast.Field {
55 . . . . . . . Type: *ast.Ident {
56 . . . . . . . . NamePos: 3:20
57 . . . . . . . . Name: "int"
58 . . . . . . . }
59 . . . . . . }
60 . . . . . }
61 . . . . . Closing: -
62 . . . . }
63 . . . }透過上面的AST結構我們可以找到函數參數型別具體在哪個結構上，因為我們可以根據這個結構寫出解析程式碼如下：
package main
import (
"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
看过上面代码的朋友肯定有点抓狂了，有很多实体存在，要开发一个linter，我们需要搞懂好多实体，好在go/analysis进行了封装，go/analysis为linter 提供了统一的接口，它简化了与IDE,metalinters，代码Review等工具的集成。如，任何go/analysislinter都可以高效的被go vet执行，下面我们通过代码方式来介绍go/analysis的优势；
新建一个项目代码结构如下：
.
├── firstparamcontext
│ └── firstparamcontext.go
├── go.mod
├── go.sum
└── testfirstparamcontext
├── example.go
└── main.go添加检查模块代码，在firstparamcontext.go添加如下代码：
package firstparamcontext
import (
"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 main
import (
"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的代码下载到本地，然后在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
以上是Go語言如何自訂linter（靜態檢查工具）的詳細內容。更多資訊請關注PHP中文網其他相關文章！
