ちいさくPHPStanをつくってみる

PHPカンファレンス愛媛2026
https://fortee.jp/phpconehime-2026/proposal/7278f413-ea3c-43b6-8e9a-302eca39366e

Transcript

1. ちいさくPHPStanを つくってみる asumikam
2. PHPStan
3. Find Bugs Without Writing Tests • コードを実行せずに潜在的なバグを発見するPHPの 静的解析ツール • 型宣言を活用し、未定義の変数やメソッド、 型の不一致などのエラーを早期に検知 • レベル 0〜10 で、チェックの厳しさを選べる
5. 「カスタムルール」も書ける • PHPStanが用意しているルール群の他に、適用したい ルールを独自につくることができる • ドメインのルールを守らせる用途に使えて嬉しい
6. 例えば 「var̲dumpの禁止」 カスタムルールを書いてみる
8. コード上に 関数呼び出しがきたとき 適用するルール
9. 関数の名前が var̲dump ⇒ エラーにする
10. たったこれだけで *1 実際にそのルールを適用してくれる *1 実際は phpstan.neon の調整も少々あるが瑣末
11. すごい！！
12. なんで！？
13. 分からなければ 読めばいい
14. ファイル数 約2,000 行数 約200,000 * 空行など除く
15. デッカ〜
16. • 最初は、どこから読めばいいかすら分からなかった • 細部（ミクロ）から理解するのではなく、 全体像（マクロ）を先につかんでから本物を読む • 「PHPStan未満」をつくることで、本物を読む際の 道筋にしたい
17. 本物の流れを尊重しつつ 「ちいさくつくる」
18. このトークのゴール PHPStan の内部実装を知らない人が 私の「ちいさくつくる」版を通して PHPStan の内部実装を「ざっくり」知る！
19. あすみ（@asumikam） 🍊 • 株式会社リンケージ • PHPer • アジャイル・スクラム • PHPカンファレンス小田原 主催
20. 本日のおしながき 1 ちいさくつくる 2 PHPStanと比較する
21. #1 ちいさくつくる
22. #1 ちいさくつくる 1. 「ちいさくつくる」の実装をみる 2. 実際のルールを書いてみる
23. #1 ちいさくつくる 1. 「ちいさくつくる」の実装をみる 2. 実際のルールを書いてみる
24. #1 ちいさくつくる 普段どのようにコードを読み進めるか
25. #1 ちいさくつくる
26. #1 ちいさくつくる Userクラス あるかな？
27. #1 ちいさくつくる Userクラス ある✅
28. #1 ちいさくつくる $user は Userクラスのこと🧠
29. #1 ちいさくつくる renameメソッド あるかな？ 引数は1つで あっているかな？
30. #1 ちいさくつくる renameメソッド ある✅ 引数は1つで あってる✅
31. #1 ちいさくつくる removeメソッド あるかな？
32. #1 ちいさくつくる removeメソッド ない！🙅❌
33. #1 ちいさくつくる 頭の中でしていること 観点をもつ そのメソッドは存在するかどうか 構造をよみとる 変数代入・メソッド呼び出し 読みすすめる 上から順に、変数が何かを覚えながら 観点をあてはめる メソッド呼び出ししていたらチェック 伝える 「そのクラスにそのメソッドはないよ」
34. #1 ちいさくつくる 頭の中でしていること 観点をもつ 構造をよみとる 読みすすめる この5つを軸に PHPStan のコードを 「ちいさくつくる」🙂↕ 観点をあてはめる 伝える
35. #1 ちいさくつくる どのくらいちいさくするのか PHPStan ministan ファイル数 約 2,000 8 行数（空行など除く） 約 200,000 220 ministanもそこそこボリュームはあるので トークの中ではふんわり理解できるように解説していきます🌷
36. #1 ちいさくつくる https://github.com/asumikam/ministan
37. #1 ちいさくつくる $ php bin/ministan AnalyzeTarget.php
38. #1 ちいさくつくる 解析対象の ファイル $ php bin/ministan AnalyzeTarget.php
39. #1 ちいさくつくる ministanを みていく $ php bin/ministan AnalyzeTarget.php
41. 構造をよみとる 観点をもつ 観点をあてはめる 読みすすめる 伝える
42. 構造をよみとる 観点をもつ 観点をあてはめる 読みすすめる 伝える
43. #1 ちいさくつくる 「構造をよみとる」をつくる • ソースコードはただの文字の並び • 人間はコードを行ったり来たりしていい感じに読めた • 機械に読ませるとなると一定のルールが必要 • コードを「意味のあるかたまり」に分解する
44. #1 ちいさくつくる AST（抽象構文木） • Abstract Syntax Tree • コードを「意味のあるかたまり」＝「ノード」に分けて、木の形 にしたもの • ノードには種類がある（代入・メソッド呼び出し・変数…） • 「;」や 空白 など、意味に関係ないものは捨てている • PHPStan は php-parser（nikic/php-parser）で AST にしている
45. #1 ちいさくつくる
46. #1 ちいさくつくる
47. #1 ちいさくつくる 全てノード Stmt̲Expression Expr̲Variable Expr̲New Name Expr̲MethodCall Identi er Arg Scalar̲String
48. #1 ちいさくつくる • 文（Stmt）の配列から始まる • 1 行目 0: Stmt̲Expression • 2 行目 1: Stmt̲Expression • AST を親から子へたどるの は、コードを上から1行ずつ、 外側から内側へ読むのと同じ
49. #1 ちいさくつくる • ノードの中に、さらにノードが 入っている（入れ子） • ノード • ノードの配列 • ただの値
50. $ast の中に 解析対象のファイルを ASTにしたものが 入っている
51. 観点をもつ
52. #1 ちいさくつくる 「観点をもつ」をつくる • 導入で見たルールの実装をする • 有効にしたいルールを配列で並べておく • コンストラクタで $ast を渡しておき、ルールの中で定 義（関数やクラス）を探せるようにする • 具体的なRuleがどうなるかは後述
53. 観点をあてはめる
54. #1 ちいさくつくる 「観点をあてはめる」をつくる • ノードを 1 つ受け取り、種類が合うルールでチェックする • 使うルール群は、コンストラクタで受け取っておく • ノードの数だけ何度もチェックするので、見つけたエラー は、その場ですぐに出さずに最後にまとめて「伝える」 • 実際に動くのは「読みすすめる」のタイミング
55. #1 ちいさくつくる
56. #1 ちいさくつくる 適用したいルール群は コンストラクタ引数にある
57. #1 ちいさくつくる 引数にはチェック対象の ノードが渡される想定
58. #1 ちいさくつくる 適用対象のルールをぐるぐる
59. #1 ちいさくつくる 適用対象のルールと渡された ノードの種類が一致したら
60. #1 ちいさくつくる ルールでチェック （ダメならメッセージが 返ってくる）
61. #1 ちいさくつくる 何かしら返ってくれば エラーなので、 $errors に貯めておく
62. #1 ちいさくつくる 「ルールを適用」しながら エラーを貯めておく🙆
63. #1 ちいさくつくる あとでつかうよ
64. 読みすすめる
65. #1 ちいさくつくる 「読みすすめる」をつくる • AST を親から子へ、上から順にたどる • 人間がやっていた「1行ずつ読む」と同じ動き • ノードに着くたびに「観点をあてはめる」を呼ぶ
66. #1 ちいさくつくる
67. #1 ちいさくつくる
68. #1 ちいさくつくる 最初はファイル全体の AST（$ast）が渡される $nodeCallback は先ほどの 「観点をあてはめる」でつくったもの
69. #1 ちいさくつくる $nodes をぐるぐる processNode に渡していく
70. #1 ちいさくつくる
71. #1 ちいさくつくる 観点をあてはめる！！
72. #1 ちいさくつくる ノードは入れ子なので、 子ノードを再帰的にたどる
73. #1 ちいさくつくる
75. 伝える
76. $nodeCallback がエラーを 持っているので聞く
77. 完全に 理解した✨
78. 実際のルールを 書いてみる
79. #1 ちいさくつくる 1. 「ちいさくつくる」の実装をみる 2. 実際のルールを書いてみる
80. #1 ちいさくつくる 「関数・メソッドが存在するか」 をルールとして実装してみる
81. #1 ちいさくつくる 「関数・メソッドが存在するか」 myfunc('xxx') 関数の呼び出し Class::method() クラスの静的メソッドの呼び出し $this->method() クラスの$this経由の呼び出し $some->method() 変数経由のメソッドの呼び出し
82. #1 ちいさくつくる 「関数・メソッドが存在するか」 myfunc('xxx') 関数の呼び出し Class::method() クラスの静的メソッドの呼び出し $this->method() クラスの$this経由の呼び出し $some->method() 変数経由のメソッドの呼び出し
83. #1 ちいさくつくる 存在しない関数のとき、エラーにしたい // <- HERE!!
84. #1 ちいさくつくる ルールを書いてみる
85. #1 ちいさくつくる
86. #1 ちいさくつくる ノードが関数呼び出し だったとき
87. #1 ちいさくつくる ルールを適用する
88. #1 ちいさくつくる チェック対象のノードの 関数名を取得
89. #1 ちいさくつくる コード全体（$ast）から 関数定義を全部取り出す
90. #1 ちいさくつくる 一致する関数を探す 存在すれば OK ✅
91. #1 ちいさくつくる 存在しなければ エラーメッセージ
92. #1 ちいさくつくる PHPStan対応ルール：CallToNonExistentFunctionRule（レベル0〜）
93. #1 ちいさくつくる 「関数・メソッドが存在するか」 myfunc('xxx') 関数の呼び出し Class::method() クラスの静的メソッドの呼び出し $this->method() クラスの$this経由の呼び出し $some->method() 変数経由のメソッドの呼び出し
94. #1 ちいさくつくる 存在しない静的メソッドのとき、エラーにしたい // <- HERE!!
95. #1 ちいさくつくる ルールを書いてみる
96. #1 ちいさくつくる
97. #1 ちいさくつくる ノードが静的呼び出し だったとき
98. #1 ちいさくつくる
99. #1 ちいさくつくる チェック対象のノードの クラス名・メソッド名を取得
100. #1 ちいさくつくる コード全体の クラスたちを取得 →ぐるぐる
101. #1 ちいさくつくる 一致するクラス でなければ continue
102. #1 ちいさくつくる チェック対象のクラスが存在し、 該当のメソッドがあればOK ✅
103. #1 ちいさくつくる 存在しなければ エラーメッセージ
104. #1 ちいさくつくる PHPStan対応ルール：CallStaticMethodsRule（レベル0〜）
105. #1 ちいさくつくる 「関数・メソッドが存在するか」 myfunc('xxx') 関数の呼び出し Class::method() クラスの静的メソッドの呼び出し $this->method() クラスの$this経由の呼び出し $some->method() 変数経由のメソッドの呼び出し
106. #1 ちいさくつくる $thisに存在しないメソッドのとき、エラーにしたい // <- HERE!!
107. #1 ちいさくつくる 仕組みにアップデートが必要 • ASTには「this」という名前がある だけで、クラス名は書かれていない • 擬似変数 $this は文脈によって何が 入っているか変わる • $this に何が入っていたかを 覚えておく係が必要
108. #1 ちいさくつくる 「何が入っていたかを覚えておく」 をイメージしてみる
109. #1 ちいさくつくる ASTを読みすすめるのは 上から下に読んでいくのとほぼ同義
110. #1 ちいさくつくる クラス定義（ノード）に入ったとき 覚えておけば良い 🧠 「this」は 「User」
111. #1 ちいさくつくる その先のコードに到達したとき 覚えておいた値を使えば良い 🧠 「this」は 「User」
112. #1 ちいさくつくる この役割をScopeという
113. #1 ちいさくつくる クラスを覚えておくScopeの実装 ＋ それを利用する実装
114. #1 ちいさくつくる Scopeの実装
115. #1 ちいさくつくる
116. #1 ちいさくつくる クラスに入ったときに 覚えておく🧠
117. #1 ちいさくつくる 聞かれたときに 答えられるようにしておく
118. #1 ちいさくつくる 使うタイミングは 「読みすすめる」とき
119. #1 ちいさくつくる
120. #1 ちいさくつくる $scope を 引数で引き回す 🆕
121. #1 ちいさくつくる $scope を 引数で引き回す 🆕 「観点をあてはめる」 でも使えるように 🙌
122. #1 ちいさくつくる クラス定義に入ったら enterClass の処理 ✅
123. #1 ちいさくつくる 準備ばっちり
124. #1 ちいさくつくる ルールを書いてみる
125. #1 ちいさくつくる ASTをたどっていく過程で、クラスに入ったら Scope に値が保存されている 🧠 「this」は 「User」
126. #1 ちいさくつくる
127. #1 ちいさくつくる メソッド呼び出しの ノードがきたとき
128. #1 ちいさくつくる
129. #1 ちいさくつくる Scopeの出番
130. #1 ちいさくつくる $node->var には 値が this の Expr̲Variable ⇒ User がひける
131. #1 ちいさくつくる あとの処理は今までと一緒 一致するかどうかをみる
132. #1 ちいさくつくる PHPStan対応ルール：CallMethodsRule（レベル0〜）
133. #1 ちいさくつくる 「関数・メソッドが存在するか」 myfunc('xxx') 関数の呼び出し Class::method() クラスの静的メソッドの呼び出し $this->method() クラスの$this経由の呼び出し $some->method() 変数経由のメソッドの呼び出し
134. #1 ちいさくつくる $userが持っていないメソッドのとき、エラーにしたい // <- HERE!!
135. #1 ちいさくつくる 仕組みにアップデートが必要 • クラス定義に入ったときだけ Scope に覚えていた • 同じことを代入のときにもすれば良い
136. #1 ちいさくつくる 変数を覚えておくScopeの実装 ＋ それを利用する実装
137. #1 ちいさくつくる
138. #1 ちいさくつくる クラスのときと同じように 覚えておく🧠
139. #1 ちいさくつくる 「クラス名」の取得 と全く同じ仕組み
140. #1 ちいさくつくる 使うタイミングは 「読みすすめる」とき
141. #1 ちいさくつくる
142. #1 ちいさくつくる 変数を覚えておく処理
143. #1 ちいさくつくる スライドで説明しきれていない部分 • Before • もともとのScope は「親 → 子」に渡すだけ • After • 処理し終わった Scope を返して、次の処理へ引き継ぐ • ただし、クラスの中で分かったことは外に持ち出さない
144. #1 ちいさくつくる Scopeをアップデートするだけで ルールは前のものと一緒で動く
145. #1 ちいさくつくる PHPStan対応ルール：CallMethodsRule（設定によりレベル2〜）
146. #1 ちいさくつくる ふりかえり
148. 解析対象のファイル
149. 構造をよみとる = ASTに分解
150. 観点をもつ = ルールの実装・登録
151. 観点をあてはめる = ノードでルールを選ぶ = エラーを貯める
152. 読みすすめる = Scopeを更新しながら辿る
153. 伝える =エラーがあれば出力
154. #1 ちいさくつくる ふりかえり • PHPStan の中身をちいさくつくった（超特急） • 約20万行 → 220行 • ちいさくしても、流れと登場人物（骨組み）は同じでつくれた • とはいえ、端折ったところはたくさんある • ministan を足がかりに、「本家との差分はどこ？」をみてほしい • 普段使っているルールの実装を見るだけでも、技巧を感じて奥深い
155. #1 ちいさくつくる 免責事項 • ministanは「ちいさくつくる」ことに意識しているた め、意図的に不完全なまま出しています • ほんもののPHPStanと見比べて不完全さを楽しんでくだ さい🤗
156. #1 ちいさくつくる ministan PHPStan 早見表 PHPStan ParserFactory Parser\ RichParser Rule 周辺 Rules\ Rule, LazyRegistry FileAnalyserCallback Analyser\ FileAnalyserCallback NodeScopeResolver Analyser\ NodeScopeResolver Scope Analyser\ MutatingScope NodeFinder Re ection\ Re ectionProvider echo Command\ErrorFormatter\ ErrorFormatter ↔︎ fl fl ministan
157. #2 PHPStanと比較する
158. #2 PHPStanと比較する PHPStanと比較する • ministan は動くが「PHPStan 未満」 • つくってみて気になった「本家はどうしてる？」をみる • なぜ AST を使う？ • どうしてあんなに速く処理できる？ • カスタムルールはどう組み込まれてる？
159. #2 PHPStanと比較する ① なぜ「AST」を使う？ • php-parser は Rector・Psalm など、多くの PHP ツー ルで使われている • ministan でも php-parser をそのまま使った • 「クラスにメソッドがあるか」だけなら、PHP 標準の fl Re ection でも分かるのでは？
160. #2 PHPStanと比較する ①「読み込むと、実行されてしまう」から • Re ection で調べるには、ファイルを require（＝実行）する必要がある • 定義と処理が同じファイルにあると、調べる前に処理が動いてしまう • 実は ministan も最初は Re ection でつくろうとして、ここでつまずき、 AST から定義を探す形にした • 本家も 0.12.26 で、AST から定義を読む「静的リフレクション」に移行 （BetterRe ection） fl fi fl fl fl • 参照: https://phpstan.org/blog/zero-con g-analysis-with-static-re ection
161. #2 PHPStanと比較する ② どうしてあんなに速く処理できる？ • コードが増えればノードが増え、ルールが増えればさら に回る。繰り返し処理は掛け算で増えていく • 自分のプロジェクトで想像すると… ファイル数百 × ノード数百 × ルール数百 • 本家はノードごとに型の推論（Scope の計算）もある
162. #2 PHPStanと比較する ② 速さのひみつ • そのノードに関係するルールだけを取り出す（結果はキャッシュ） • ファイルを 20 個ずつの「ジョブ」に分け、複数のワーカープロセ スで同時に解析 • 変わっていないファイルは解析しない（結果キャッシュ） • さらに最近は：C++ 製の拡張（PHPStan Turbo）や、 pcntl̲fork() でワーカーの起動をはぶく工夫も
163. #2 PHPStanと比較する ③ カスタムルールはどう組み込まれてる？ • ministan ではルールを手で並べていた • 本家では、組み込みのルールと自分で書いたカスタム ルールを、どこで並べている？ • そもそも「レベル」によって有効なルールが変わるの は、どういう仕組み？
164. #2 PHPStanと比較する ③-1 レベルの登録 • 組み込みルールには、「何レベルから有効か」が属性で書いてある • #[RegisteredRule(level: 0)] • レベル N を選ぶと、level ≤ N のルールだけが登録される • src/DependencyInjection/AutowiredAttributeServicesExtension.php • 属性の付いたルールを集めて、レベルで絞って登録しているところ
165. #2 PHPStanと比較する ③-2 カスタムルールの登録 • phpstan.neon の rules: にクラス名を書くと、そのルールが登録される • 登録先は、組み込みルールと同じ「ルール一覧」 • だから本家の中では、組み込みもカスタムも同じように扱われる • src/DependencyInjection/RulesExtension.php • rules: に書かれたクラスを、ルール一覧に追加しているところ
166. ### まとめ
167. このトークのゴール PHPStan の内部実装を知らない人が 私の「ちいさくつくる」版を通して PHPStan の内部実装を「ざっくり」知る！
168. 普段使っているものの中身を知ると できることが増える 怖くなくなる
169. わかると面白い‼
170. 自作していこう
171. 宣伝 PHPカンファレンス小田原2027 2027/04/10 開催
172. 宣伝 個人スポンサー販売開始 2026/10/13
173. Thanks! ありがとうございました Enjoy your PHP Conference Ehime!