Go の analysis パッケージで自作するリファクタリングツール

Transcript

1. Go の analysis パッケージで⾃作する リファクタリングツール golang.tokyo #38 株式会社ナレッジワーク 宮⽥聖也(@38tter)

2. © Knowledge Work Inc. 2 • 宮⽥聖也 (38tter) • ソフトウェアエンジニア＠ナレッジワーク

   • Golang, Ruby が好き • 趣味：🍺🍺🍺, ⚽ (󰧹, 󰎼), 🎸, 📷 ⾃⼰紹介

3. © Knowledge Work Inc. リファクタリングは... 3 3 ⼤事

4. © Knowledge Work Inc. ⼀⼝にリファクタリングといっても様々 4 4 ⾮推奨ライブラリの削除 コーディングスタイル変更への追従 安全性向上のための型の変更

   可読性向上のための変数名の変更 アーキテクチャ変更による互換性維持 …etc.

5. © Knowledge Work Inc. リファクタリングは... 5 5 必要な⼯数も 1 min

   から 1 month まで様々 有効な⼿段も当然異なる 先延ばしにしがち

6. © Knowledge Work Inc. リファクタリングは... 6 6 機械的にやりたい ▶ Go

   の静的解析を活⽤

7. © Knowledge Work Inc. 本発表の⽬的 7 7 Go 標準が提供するリファクタリングツールを知る 各ツールのできること、できないことを押さえる

   ▶ 使いどころを考える

8. © Knowledge Work Inc. ある条件によって抽出されたコードを、挙動を保ちながら 別のコードに置き換えること 8 本発表での「リファクタ」とは before 


   after 


9. © Knowledge Work Inc. go/analysis 9 9 • https://pkg.go.dev/golang.org/x/tools/go/analysis •

   モジュール化された静的解析を提供 • コードを実⾏せずに⾏う検査 • 共通のインターフェースで再利⽤性が⾼い • CLI, IDE, Testing Framework などから利⽤ • analysis.Analyzer

10. © Knowledge Work Inc. go/ast 10 10 • https://pkg.go.dev/golang.org/x/tools/go/ast •

    AST (抽象構⽂⽊) • ソースコードを⽊構造で表現したもの • コード中の字句の意味(式、⽂、宣⾔)や、 ファイル上の位置、親⼦関係を取得可能

11. © Knowledge Work Inc. 11 analyzer の実装例: コマンドインターフェース singlechecker.Main で単⼀の

    Analyzer を スタンドアロンなコマンドとして実⾏できる

12. © Knowledge Work Inc. 12 analyzer の実装例: コマンドインターフェース 解析の詳細は Run

    に記述

13. © Knowledge Work Inc. go/analysis + go/ast によるリファクタの流れ 13 13

    字句解析＆構⽂解析 AST(抽象構⽂⽊) 取得 AST のノードを巡回 指摘箇所を検出（＆修正）

14. © Knowledge Work Inc. 14 analyzer の実装例: コマンドインターフェース 字句解析＆構⽂解析 AST(抽象構⽂⽊)

    取得 AST のノードを巡回 指摘箇所を検出（＆修正） 実装者が AST 取得を意識する必要がない

15. © Knowledge Work Inc. 15 analyzer の実装例: run の内部処理 字句解析＆構⽂解析

    AST(抽象構⽂⽊) 取得 AST のノードを巡回 指摘箇所を検出（＆修正）

16. © Knowledge Work Inc. 16 analyzer の実装例: run の内部処理 字句解析＆構⽂解析

    AST(抽象構⽂⽊) 取得 AST のノードを巡回 指摘箇所を検出（＆修正）

17. © Knowledge Work Inc. 17 ドメインイベントの型変換の実装を差し替えたい go/analysis を使ったリファクタの例

18. © Knowledge Work Inc. 18 ドメインイベントの型変換の実装を差し替えたい go/analysis を使ったリファクタの例

19. © Knowledge Work Inc. 19 単体の場合の差し替えは⼿動でも容易 イベント数が膨⼤(100~)になると困難 go/analysis を使ったリファクタの例

20. © Knowledge Work Inc. 20 go/analysis を使ったリファクタの例 ドメインイベントの型をレシーバに取るメソッド ToActivityEvent を検出し

    実装の中⾝({, } の内側)を置き換える

21. © Knowledge Work Inc. 21 analyzer の実装: run の内部処理 字句解析＆構⽂解析

    AST(抽象構⽂⽊) 取得 AST のノードを巡回 指摘箇所を検出（＆修正） ドメインイベントの型をレシーバに取るメソッド 編集箇所はノードの brace の内側 置き換え後のテキスト 任意の内容が書ける

22. © Knowledge Work Inc. go/analysis を使ったリファクタリングは... 22 22 ルールベースで複雑な置き換えが可能 （もちろん、より単純なことも）

    …だが、置き換え後の動作は 実装者が保証する必要がある

23. © Knowledge Work Inc. eg - example-based refactoring 23 23

    Go 公式のコードリプレイスツール • https://pkg.go.dev/golang.org/x/tools/cmd/eg 式(expression) のリプレイスに限定 • ⽂(statement), 宣⾔(declaration) は指定できない 差分を記述した template を与えて実⾏ • before: 式A, after: 式B と書ける • eg だけに easy (?) リプレイスにともなう import の追加も⾏われる • ただし不要になった import は削除されない • eg 実⾏後に goimports の実⾏が推奨

24. © Knowledge Work Inc. eg: 型安全なコードリプレイス 24 24 置き換え後の式の戻り値の型が⼀致 •

    func before, func after のシグネチャ (types.Signature) の⼀致が要求される before の式が after の式にアサインできるか検証 • types.AssignableTo

25. © Knowledge Work Inc. eg: 式(expression) のリプレイスに限定 25 25 指摘箇所の検出は

    ast.Expr の⼀致を検証 • ワイルドカードによる⽐較も可能 expression 以外の statements の指定は(あえて)スコープアウト • `eg --help` でも注意事項として記載

26. © Knowledge Work Inc. まとめ 26 26 • go/analysis +

    go/ast による静的解析はリファクタツールにも応⽤できる AST ノードの情報により柔軟なコードリプレイスが可能 コードスタイルの変更に伴う修正などの複雑なコンテキストも落とし込める AST の学習コストが⼀定必要となる → fix typo から負債解消のための⼤規模なリファクタリング PJ まで • eg では型安全なリファクタが可能 expression に限定される テンプレートファイルベースで、チーム内共有も容易 学習コストは少ない → ⾮推奨なライブラリの置き換えや、コーディングスタイルの強制など