歯磨き.go Go言語の静的解析とコード生成勉強会

Copyright © 2020 Present ANDPAD Inc. This information is confidential and was prepared by ANDPAD Inc. for the use of our client. It is not to be relied on by and 3rd party. Proprietary & Confidential 無断転載・無断複製の禁止
歯磨き.go
はじめての静的解析

歯磨き.goとは
Conﬁdential
Copyright © 2020 Present ANDPAD Inc. This information is confidential and was prepared by ANDPAD Inc. for the use of our client. It is not to be relied on by and 3rd party. 無断転載・無断複製の禁止
一過性の勉強会ではなく、少しずつ無理のない範囲で
毎日の歯磨きのように続けていくことを目的とした
ゆるふわなgo勉強会です。
（もともと社内でやってたけどスピンオフしました）

歯磨き.goとは
Conﬁdential
・社内で静的解析の勉強会を始めたので
　そのアウトプットの場になれば。会が進んできたら、　社内で
作った静的解析ツールを紹介（自慢）する場に
　なれば良いなとか
・社内だけだと閉塞感でると思うので社外の方用のLT
　枠も用意するのでぜひぜひ登壇したい方大歓迎。
　ゆるふわな会なので怖く無いよ。

自己紹介

自己紹介
Conﬁdential
山下大輔 Daisuke Yamashita
ものづくり系エンジニア 
go言語に限らずものづくりに関わる開発は
全般的に好き。 
 
毎日使う最強のツールを作るのが目標。

何を作っているか
Conﬁdential
全人類が日々感じる不便さ

何を作っているか
Conﬁdential
全人類が日々感じる不便さ
建築業界 ANDPAD
建築業界特化型ツール

目次
Conﬁdential
・静的解析がなぜ必要か
・特定のパッケージ(fmt)を使っているか抽出しよう！
・レイヤードアーキテクチャでの依存方向の制約間違い 
　を指摘する静的解析を作ろう！（プロジェクト独自定義）

静的解析がなぜ必要か

Conﬁdential
要件定義実装 QAテストリリース

Conﬁdential
右の発見ほどコスト増
シフトレフト

Conﬁdential
静的解析が活躍
自動テストが活躍

今日作る静的解析のおしながき
Conﬁdential
① 特定のパッケージ(fmt)を使っているか抽出しよう！ 
 
②レイヤードアーキテクチャでの依存方向の制約間違い 
　を指摘する静的解析を作ろう！（プロジェクト独自定義）

Conﬁdential
特定のパッケージ(fmt)を使っているか抽出しよう！

Conﬁdential
$ go install github.com/gostaticanalysis/skeleton@latest
go 1.16以上
$ go get -u github.com/gostaticanalysis/skeleton
go 1.16未満
https://github.com/gostaticanalysis/skeleton

はじめての静的解析の開発手順
Conﬁdential
① 雛形の作成(skeleton実行するだけ) 
② テストデータの作成 
③ テスト実行 
④ Analyzerのロジックを修正 
skeletonを使った実装

Conﬁdential
$ skeleton -path=fmt_search
雛形を生成

Conﬁdential
$ skeleton -path=fmt_search
雛形を生成
テストデータとし
ての
コード
開発はこちら

Conﬁdential
$ cd fmt_search
$ go mod tidy
$ go test

analysis package
Conﬁdential
https://pkg.go.dev/golang.org/x/tools/go/analysis
静的解析をモジュール化するためのライブラリ
雛形生成で自動作成されています。

analysis.Analyzer
Conﬁdential
https://pkg.go.dev/golang.org/x/tools/go/analysis#Analyzer
// Analyzer is ...
var Analyzer = &analysis.Analyzer{
Name: "....",
Doc: doc,
Run: run,
Requires: []*analysis.Analyzer{
inspect.Analyzer,
},
}
静的解析の実行単位
自動生成されており、runで渡している
関数で実際の静的解析のロジックを
作成する。

analysis.Pass
Conﬁdential
https://pkg.go.dev/golang.org/x/tools/go/analysis#Pass
func run(pass *analysis.Pass) (interface{}, error) {
// 静的解析のロジックを書く
}
run関数に引数として渡されてくやつ。
ターゲットのソースコードを静的解析するための必要な情報が入ってい
る。

analysis.Pass
Conﬁdential
https://pkg.go.dev/golang.org/x/tools/go/analysis#Pass
type Pass struct {
Fset *token.FileSet // file position information
Files []*ast.File // the abstract syntax tree of each file
Pkg *types.Package // type information about the package
Report func(Diagnostic)
...
}

テストデータを作成
Conﬁdential
fmt_search/testdata/src/a/a.go
package a
import "fmt" // want "fmt exists"
func f() {
fmt.Println("test")
}
importを検出するだけの
シンプルなもの

import fmtを探すコード
Conﬁdential
fmt_search/fmt_search.go
for _, f := range pass.Files{
for _,imp := range f.Imports{
v, err := strconv.Unquote(imp.Path.Value)
if err != nil{
return nil, err
}
if "fmt" == v {
pass.Reportf(imp.Pos(), "%s is imported.", v)
}
}
}
return nil, nil
}
“”の文字列を削除

動作
Conﬁdential
$ go test
https://github.com/daisuke0131/fmt_search

プロジェクト独自定義
Conﬁdential
レイヤードアーキテクチャでの依存方向の制約間違い 
　を指摘する静的解析を作ろう！ 
（プロジェクト独自定義）

レイヤードアーキテクチャ
Conﬁdential
依存の方向
一番外側のレイヤー
repositoryの実態とかhandlerとか
外界に依存しない、ビジネスロジック
（repositoryのIFのみに依存したい）
依存が逆転してしまっているものを検
知したい！

Conﬁdential
https://github.com/daisuke0131/layer
for _, f := range pass.Files{
dir := pass.Fset.File(f.Pos()).Name()
if strings.Contains(dir,"/usecase/service/"){
// infrastructureの層への依存はしない
for _,imp := range f.Imports{
v, err := strconv.Unquote(imp.Path.Value)
if err != nil{
return nil, err
}
if strings.Contains(v,"/infrastructure/") {
pass.Reportf(imp.Pos(), "%s is invalid import.", v)
}
}
}
}
return nil, nil
}

Conﬁdential
https://github.com/daisuke0131/layer
$ go test

まとめ

まとめ
Conﬁdential
・ANDPADの開発でも自分たちで作った静的解析の
　ツールを活用していくぞい！
・簡単な静的解析ツールの作り方を説明しました。
　これくらいでも実用的なものを作れそう。

歯磨き.go Go言語の静的解析とコード生成勉強会

Recommended

Recommended

More Related Content

Similar to 歯磨き.go Go言語の静的解析とコード生成勉強会

Similar to 歯磨き.go Go言語の静的解析とコード生成勉強会 (20)

More from Daisuke Yamashita

More from Daisuke Yamashita (12)

Recently uploaded

Recently uploaded (20)

歯磨き.go Go言語の静的解析とコード生成勉強会