KanColleViewer PluginAnalyzer の実装

Metro.cs #1 https://roommetro.doorkeeper.jp/events/30482 のセッション資料。
* KanColleViewer で Roslyn を使うに至った理由と、Roslyn の意義 👈 https://speakerdeck.com/grabacr07/roslyn-plus-kancolleviewer
* KanColleViewer で使ったアナライザー実装の解説 👈 この資料

Transcript

1. KanColleViewer PluginAnalyzerの実装 2015/09/16 Metro.cs #1 @veigr
2. Self Introduction ゔぇい Work 小さな独立系 SIer (C# + WPF + ASP .NET WebAPI とか) Private 提督業も忙しい！ (KanColleViewer) 開発メンバー (Plugin Analyzer / Network 等) 同プラグイン開発 Nekoxy (艦これ向け HTTP プロキシライブラリ) 開発 Twitter: @veigr Blog: http://www.cat-ears.net
3. Agenda 作ったもの KanColleViewer.PluginAnalyzer Analyzer の作成準備と概要 Analyzer with Code Fix Analyzer 実例 ExportMetadataAnalyzer の実装
4. KanColleViewer.PluginAnalyzer 作ったもの
5. KanColleViewer.PluginAnalyzer プラグイン開発支援用 Roslyn Analyzer RC 時代に勉強 1 週間＋コーディング 3 日位で作ったやつ Roslyn とか殆ど無知だった
6. KanColleViewer.PluginAnalyzer プラグイン開発支援用 Roslyn Analyzer 目的: プラグイン開発特有の実装ルールを守らせる • 実装しなければならない Interface • Interface に対応した ExportAttribute の実装 • 本体が要求する Metadata の実装 ソース: https://github.com/Grabacr07/KanColleViewer/tree/develop/source/Analyzers
7. Analyzer with Code Fix Analyzerの 作成準備と概要
8. SDKインストール 新しいプロジェクト > Extensibility > Download the .NET Compiler Platform SDK インストール
9. プロジェクト作成 新しいプロジェクト > Extensibility > Analyzer with Code Fix (NuGet + VSIX)
10. ソリューション構成 Analyzer 本体 Analyzer.Test テスト用プロジェクト Analyzer.Vsix VS 拡張機能 作成用プロジェクト サンプルコード入り
11. プロジェクト構成 (本体) DiagnosticAnalyzer.cs 解析するやつ CodeFixProvider.cs コード修正するやつ tools フォルダ NuGet パッケージ用 PowerShell スクリプト
12. Analyzer with Code Fix とは 要するに 解析 (Analyze) ＆ 修正 (CodeFix)
13. Analyzer with Code Fix の例 DiagnosticAnalyzer で SyntaxTree を解析 CodeFixProvider で SyntaxTree を修正 足りてない！ 追加！
14. Analyzer with Code Fix の例 DiagnosticAnalyzer で SyntaxTree を解析 CodeFixProvider で SyntaxTree を修正 これは一体……？
15. Syntax Visualizer ソースコードの Syntax Tree (構文木)を表示してくれる • Analyzer 作るなら必携 • SDK と一緒にインストール される
16. 参考になるやつ Roslyn Overview · dotnet/roslyn Wiki https://github.com/dotnet/roslyn/wiki/Roslyn%20Overview Samples and Walkthroughs · dotnet/roslyn Wiki https://github.com/dotnet/roslyn/wiki/Samples-and-Walkthroughs neuecc さんとか岩永さんとかの Blog や成果物 色々あるのでググろう
17. Analyzer のインストール方法 作ったAnaylzerの利用
18. 作った Anaylzer の利用 Analyzer インストール方法 • DLL を参照追加してインストール • NuGet パッケージにしてインストール • VSIX にしてインストール ※プロジェクト参照はできないっぽい ※Analyzer が依存している外部アセンブリがあるとちょっと面倒
19. ExportMetadataAnalyzer の実装 Analyzer 実例
20. 作りたいもの プラグイン一覧に表示するための情報は ExportMetadata 属性で指定している
21. 作りたいもの 不足している ExportMetadata 属性があったら補完したい
22. 作りたいもの 解析: 不足している ExportMetadata 属性を検出 修正: 検出した不足属性を追加 で行けそうな気がする……
23. まずはコード解析 DiagnosticsAnalyzer
24. DiagnosticsAnalyzer 解析したいこと クラスに足りてない ExportMetadata 属性を探したい →クラス情報の取得と、その属性の 解析ができればいい気がする
25. DiagnosticsAnalyzer 基本的な解析の流れ 1. 渡された AnalysisContext に解析の起点となる Action を登録 2. その Action 内で解析し、結果を Report する
26. DiagnosticsAnalyzer Action の登録 AnalysisContext のどの Register～Action()を使うべきか…… 何が何やらさっぱりわからない問題 (今でもよく分かってない)
27. DiagnosticsAnalyzer AnalysisContext のどの Register～Action()を使うべきか…… RegisterSyntaxNodeAction 単一ファイルを解析する場合はこれで大体何とかなるっぽい RegisterCompilationAction プロジェクト全体を解析したい場合とかに使えるっぽい RegisterSymbolAction 特定の型とか変数とかを処理したい時に使えるっぽい 今回はこれでいけそう
28. DiagnosticsAnalyzer Syntax をどう解析するか…… RegisterSyntaxNodeAction() で SyntaxKind.ClassDeclaration を指定すれば、受け取った Context から ClassDeclarationSyntax (クラスの情報)が取得できる クラスの情報
29. DiagnosticsAnalyzer クラス情報から属性の情報が欲しい…… ClassDeclarationSyntax の GetAttributes で属性が取れそう IntelliSense とデバッグ実行で頑張って調べる
30. 属性の情報から引数の内容が欲しい…… AttributeSyntax の ArgumentList.Arguments で属性の引数が取れそう DiagnosticsAnalyzer
31. DiagnosticsAnalyzer 属性の情報から引数の内容が欲しい…… AttributeSyntax の ArgumentList.Arguments で属性の引数が取れそう 大体これの繰り返し…… 続きは WEB (GitHub) で
32. 解析結果をどう Report するか…… ReportDiagnostic() でエラーが有ることを通知 DiagnosticDescriptor IDとかカテゴリとかエラーレベルとかメッセージとか Location エラーを出す場所 DiagnosticsAnalyzer ReportDiagnostic() を 呼ばなければ何も起きない
33. DiagnosticsAnalyzer 何を ReportDiagnostic するか…… DiagnosticDescriptor の内容 DiagnosticId : 「エラー一覧」の「コード」とかに出てくるID ExportMetadataMessageFormat : リソースファイルでお好きなメッセージをどうぞ Category : Analyzer の一覧のグループ化あたりで使う名前 DiagnosticSeverity : エラーレベル / Error のが残っているとコンパイルできなくなる
34. 修正対象を解析したらコード修正 CodeFixProvider
35. CodeFixProvider 修正したいこと クラスに足りてない ExportMetadata 属性を足したい
36. CodeFixProvider 修正の流れ 1. 受け取った CodeFixContext から解析結果を受け取る 2. コード修正を行う CodeAction を修正候補として登録
37. CodeFixProvider どう解析結果を受け取るか…… • CodeFixContext からはエラーの位置くらいしかもらえない • だがその位置から問題のある ClassDeclaration は探せる • 解析の時は ClassDeclaration を使って不足属性を検出した • なら解析の時と同じことをもう一度やればいい！
38. CodeFixProvider どう解析結果を受け取るか…… 解析を RegisterSyntaxNodeAction() でやっていれば、 同じロジックで再び ClassDeclaration を解析するだけ
39. CodeFixProvider どうコード修正するか…… 1. Task<Document> を返すメソッドを作る 2. それを元にタイトル等を付加した CodeAction 生成 3. 生成した CodeAction を、修正候補として CodeFixContext に登録 ここがキモ
40. CodeFixProvider Task<Document> の作り方 1. 元 Document (ソースコード)を CodeFixContext から取得 2. SyntaxFactory で新たな SyntaxTree を構築 3. 構築した SyntaxTree で問題の箇所を置換 4. 置換した Document を返す
41. CodeFixProvider Task<Document> の作り方 1. 元 Document (ソースコード)を CodeFixContext から取得
42. CodeFixProvider Task<Document> の作り方 2. SyntaxFactory で新たな SyntaxTree を構築 ※あらゆる Syntax は immutable なので、常に新たなインスタンスを生成するようなコードにしな ければならない点に注意
43. CodeFixProvider Task<Document> の作り方 3. 構築した SyntaxTree で問題の箇所を置換
44. CodeFixProvider Task<Document> の作り方 4. 置換した Document を返す
45. CodeFixProvider Task<Document> の作り方 まとめるとこう
46. 出来上がったもの
47. まとめ
48. まとめ • DiagnosticAnalyzer でコード解析 • CodeFixProvider でコード修正 • 無勉強状態からでも1～2週間くらいあればなんとか作れる • より良い実装方法などは色々あるハズ
49. おわりに • 完璧にしようとするとしんどい • 細かいところで結構ハマる • ググってもあまり情報が出てこない • とりあえずデバッグ実行して片っ端から試すのが良さげ EOF