Go言語でリンター（静的チェックツール）をカスタマイズする方法
- Golang菜鸟転載
- 2023-08-04 17:32:481426ブラウズ
まえがき
通常、私たちはビジネス プロジェクトでコードの品質を確保するために静的コード チェック ツールを使用します。静的コード チェック ツールを通じて、事前にいくつかのことを発見できます。未定義の変数、型の不一致、変数のスコープの問題、範囲外の配列添字、メモリ リークなどの問題に対応するため、ツールは独自のルールに従って問題の重大度を分類し、異なるラベルとプロンプトを与え、静的コード インスペクション 問題をできるだけ早く発見できるように、Go 言語で一般的に使用される静的コード インスペクション ツールには、golang-lint と golint があります。ほとんどのシナリオに対応できますが、特殊なシナリオ向けにカスタマイズされたルールを作成する必要が生じる場合もあるため、この記事ではリンター要件をカスタマイズする方法を学びます。
Go 言語では静的チェックはどのように実装されますか? ご存知のとおり、
Go 言語はコンパイル済み言語です。コンパイル済み言語は、字句解析、構文解析、意味解析、最適化、コンパイルとリンクの段階から切り離せません。コンパイルの原則を学びました。友達なら次の図をよく知っているはずです: <figure data-tool="mdnice编辑器" style="margin-top: 10px;margin-bottom: 10px;display: flex;flex-direction: column;justify-content: center;align-items: center;"><img src="https://img.php.cn/upload/article/001/274/665/68363a1d7cfb0350eeedd875b382bc48-0.png" alt="Go言語でリンター（静的チェックツール）をカスタマイズする方法" ></figure><p data-tool="mdnice编辑器" style="max-width:90%"> コンパイラは高級言語を機械語に変換します。まずソース コードに対して字句解析を実行します。字句解析は、文字シーケンスを <strong style="color: rgb(53, 179, 120);">Token</strong> に変換するプロセスです。 <strong style="color: rgb(53, 179, 120);">Token</strong> は通常、キーワード、識別子、リテラル (数値、文字列を含む)、特殊記号 (プラス記号、等号など) のカテゴリに分類され、<code style='font-size: 14px;padding: 2px 4px;border-radius: 4px;margin-right: 2px;margin-left: 2px;background-color: rgba(27, 31, 35, 0.05);font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;color: rgb(53, 179, 120);'>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 . . . }方法 1: 標準ライブラリはカスタム リンターを実装します
上記の 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 の構造は少し複雑なので、これは単純な実装です。そのため、それぞれについては紹介しませんCao 以前に書いた記事: golang と ast
方式二：go/analysis
看过上面代码的朋友肯定有点抓狂了，有很多实体存在，要开发一个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
我们可以把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言語でリンター（静的チェックツール）をカスタマイズする方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。