Go語言自定義linter靜態(tài)檢查工具
前言
通常我們在業(yè)務項目中會借助使用靜態(tài)代碼檢查工具來保證代碼質量，通過靜態(tài)代碼檢查工具我們可以提前發(fā)現(xiàn)一些問題，比如變量未定義、類型不匹配、變量作用域問題、數(shù)組下標越界、內存泄露等問題，工具會按照自己的規(guī)則進行問題的嚴重等級劃分，給出不同的標識和提示，靜態(tài)代碼檢查助我們盡早的發(fā)現(xiàn)問題，Go語言中常用的靜態(tài)代碼檢查工具有golang-lint、golint，這些工具中已經(jīng)制定好了一些規(guī)則，雖然已經(jīng)可以滿足大多數(shù)場景，但是有些時候我們會遇到針對特殊場景來做一些定制化規(guī)則的需求，所以本文我們一起來學習一下如何自定義linter需求;
Go語言中的靜態(tài)檢查是如何實現(xiàn)?
眾所周知Go語言是一門編譯型語言，編譯型語言離不開詞法分析、語法分析、語義分析、優(yōu)化、編譯鏈接幾個階段，學過編譯原理的朋友對下面這個圖應該很熟悉：
編譯器將高級語言翻譯成機器語言，會先對源代碼做詞法分析，詞法分析是將字符序列轉換為Token序列的過程，Token一般分為這幾類：關鍵字、標識符、字面量(包含數(shù)字、字符串)、特殊符號(如加號、等號)，生成Token序列后，需要進行語法分析，進一步處理后，生成一棵以 表達式為結點的 語法樹，這個語法樹就是我們常說的AST，在生成語法樹的過程就可以檢測一些形式上的錯誤，比如括號缺少，語法分析完成后，就需要進行語義分析，在這里檢查編譯期所有能檢查靜態(tài)語義，后面的過程就是中間代碼生成、目標代碼生成與優(yōu)化、鏈接，這里就不詳細描述了，這里主要是想引出抽象語法樹(AST)，我們的靜態(tài)代碼檢查工具就是通過分析抽象語法樹(AST)根據(jù)定制的規(guī)則來做的;那么抽象語法樹長什么樣子呢?我們可以使用標準庫提供的go/ast、go/parser、go/token包來打印出AST，
查看AST，具體AST長什么樣我們可以看下文的例子;
制定linter規(guī)則
假設我們現(xiàn)在要在我們團隊制定這樣一個代碼規(guī)范，所有函數(shù)的第一個參數(shù)類型必須是Context，不符合該規(guī)范的我們要給出警告;好了，現(xiàn)在規(guī)則已經(jīng)定好了，現(xiàn)在我們就來想辦法實現(xiàn)它;先來一個有問題的示例：
// 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" // 函數(shù)名
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" // 參數(shù)名
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 . . . }方式一：標準庫實現(xiàn)custom linter
通過上面的AST結構我們可以找到函數(shù)參數(shù)類型具體在哪個結構上，因為我們可以根據(jù)這個結構寫出解析代碼如下：
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
}然后執(zhí)行命令如下：
$ go run ./main.go -- ./example.go ./example.go:3:1: add function first params should be Context
通過輸出我們可以看到，函數(shù)add()第一個參數(shù)必須是Context;這就是一個簡單實現(xiàn)，因為AST的結構實在是有點復雜，就不在這里詳細介紹每個結構體了，可以看曹大之前寫的一篇文章：golang
和 ast
方式二：go/analysis
看過上面代碼的朋友肯定有點抓狂了，有很多實體存在，要開發(fā)一個linter，我們需要搞懂好多實體，好在go/analysis進行了封裝，go/analysis為linter
提供了統(tǒng)一的接口，它簡化了與IDE,metalinters，代碼Review等工具的集成。如，任何go/analysislinter都可以高效的被go
vet執(zhí)行，下面我們通過代碼方式來介紹go/analysis的優(yōu)勢;
新建一個項目代碼結構如下：
.
├── 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)
}命令行執(zhí)行如下：
$ 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
如果我們想添加更多的規(guī)則，使用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可執(zhí)行文件，加到我們的項目中就可以了;
到此這篇關于Go語言自定義linter靜態(tài)檢查工具的文章就介紹到這了,更多相關Go自定義linter內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
golang?gorm實現(xiàn)get請求查詢案例測試
這篇文章主要為大家介紹了golang?gorm實現(xiàn)get請求查詢案例測試，2022-04-04
go語言中，并沒有棧與隊列相關的數(shù)據(jù)結構，但是我們可以借助切片來實現(xiàn)棧與隊列的操作；接下來我們一起實現(xiàn)棧與隊列基本操作，感興趣的可以了解一下2022-11-11
這篇文章主要為大家介紹了Go編程庫Sync.Pool用法示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-12-12
Go語言中的time包里有個Timer計時器的功能，這篇文章主要就是來和大家介紹一下Timer計時器的使用技巧，感興趣的小伙伴可以跟隨小編一起學習一下2023-07-07
這篇文章主要介紹了golang websocket 服務端的實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2019-09-09
本文主要介紹了go連接mysql的項目實踐，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2023-03-03
這篇文章主要為大家介紹了Go語言rune與字符串轉換的密切關系示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-12-12
Golang?的?Context?包，中文可以稱之為“上下文”，是用來在?goroutine?協(xié)程之間進行上下文信息傳遞的，這些上下文信息包括?kv?數(shù)據(jù)、取消信號、超時時間、截止時間等。本文主要介紹了Context的原理和使用技巧，希望對大家有所幫助2022-11-11
這篇文章主要為大家介紹了go語言LeetCode題解944刪列造序示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-12-12
這篇文章主要為大家學習介紹了Golang如何基于終端庫termbox-go做個功能較簡單的貪吃蛇游戲，文中的示例代碼講解詳細，具有一定的學習價值2023-07-07