Page 1
実践PHPStan
Practical PHPStan
pixiv Inc.
USAMI Kenta
PHP Conference Okinawa 2022
2022-08-27
Page 15
この発表では知っておくべき機能を雑に取り上げるので本番運用／提案の前にドキュメントを自身でしっかり読み込みましょう。
Page 16
それでもわからないことがあればTwitterかSlackのphpusers-ja#type-safeで尋ねてください
Page 31
外した方がいいPhpStorm設定
arrayとａｒｒａｙ＜ｍｉｘｅｄ＞とmixed[] を混同しない
Page 32
外した方がいいPhpStorm設定
@param とか @returnを執拗に全部埋めてくる
arrayとａｒｒａｙ＜ｍｉｘｅｄ＞とmixed[] を混同しない
Page 39
DNF型
int|A|(B&C)|null
intまたはAまたは「BおよびC」またはnull(一定の制約下で複雑な型も書ける)
Page 41
謎のPHP用語
mixed
任意の(すべての)型を表す型(ほかの言語でのany)
Page 54
外した方がいいPhpStorm設定(再掲)
arrayとａｒｒａｙ＜ｍｉｘｅｄ＞とmixed[] を混同しない
Page 55
外した方がいいPhpStorm設定(再掲)
@param とか @returnを執拗に全部埋めてくる
arrayとａｒｒａｙ＜ｍｉｘｅｄ＞とmixed[] を混同しない
Page 56
型宣言があればPHPDocなくても足りるんじゃないの？
Page 77
型がついていないとはどういうことか
- プログラムで具体的なことをするために、必要な情報が揃っていない
- 今回の場合だと「検索して取得した本の情報を画面に出力する」など
- 配列の中にどのような値が入っているのか内部構造が明示されてない
- 多くの場合、mixed型の場合は具体的な操作をするための情報が欠けている
- PHPStanは値を引数として渡すときに、要求する型に対して
渡す型が十分に絞り込まれていないと容赦なく叱ってくれる
Page 85
配列はひとつ！じゃない！！
- ユーザIDがならんだリスト ［123, 456］
- ユーザIDと名前の対応表 [123 => '野比のび太', 234 => '源静香']
- ユーザを表す構造体 ['id' => 123, 'name' => '野比のび太']
- ユーザを表す構造体がならんだリスト
[['id' => 123, 'name' => '野比のび太'],['id' => 234, 'name' => '源静香'],]
Page 86
配列はひとつ！じゃない！！
list<int>
- ユーザIDがならんだリスト ［123, 456］
- ユーザIDと名前の対応表 [123 => '野比のび太', 234 => '源静香']
- ユーザを表す構造体 ['id' => 123, 'name' => '野比のび太']
- ユーザを表す構造体がならんだリスト
[['id' => 123, 'name' => '野比のび太'],['id' => 234, 'name' => '源静香'],]
Page 87
配列はひとつ！じゃない！！
list<int>
array<int,string>
- ユーザIDがならんだリスト ［123, 456］
- ユーザIDと名前の対応表 [123 => '野比のび太', 234 => '源静香']
- ユーザを表す構造体 ['id' => 123, 'name' => '野比のび太']
- ユーザを表す構造体がならんだリスト
[['id' => 123, 'name' => '野比のび太'],['id' => 234, 'name' => '源静香'],]
Page 88
配列はひとつ！じゃない！！
list<int>
array<int,string>
array{id:int, name:string}
- ユーザIDがならんだリスト ［123, 456］
- ユーザIDと名前の対応表 [123 => '野比のび太', 234 => '源静香']
- ユーザを表す構造体 ['id' => 123, 'name' => '野比のび太']
- ユーザを表す構造体がならんだリスト
[['id' => 123, 'name' => '野比のび太'],['id' => 234, 'name' => '源静香'],]
Page 89
配列はひとつ！じゃない！！
list<int>
array<int,string>
array{id:int, name:string}
- ユーザIDがならんだリスト ［123, 456］
- ユーザIDと名前の対応表 [123 => '野比のび太', 234 => '源静香']
- ユーザを表す構造体 ['id' => 123, 'name' => '野比のび太']
- ユーザを表す構造体がならんだリスト
[['id' => 123, 'name' => '野比のび太'],['id' => 234, 'name' => '源静香'],]
list<array{id:int, name:string}>
Page 90
array-shapes
(またはobject-like arrays)
Page 92
arrayに詳細に型を付ける
fullかpartialのみ
Page 98
型名について
- 型名は一般的に array, int, string, bool などすべて小文字で書く
- クラス名は慣習的に DateTime, App\Book のようなキャメルケース (先
頭と単語区切りを大文字にする)が一般的だが、bookのように小文字も定義可
- そのためツールによっては @return never と書くと App\never と解釈
- これを避けるには @param @return @var に代えて、
@phpstan-param @phpstan-return @phpstan-var にする
Page 102
PHPDocに書ける配列の型について
- 最近は string[] や Book[] のような書かれかたは好まれない
- JavaScript(TypeScript)のように配列/リストと連想配列
(Map/ハッシュテーブル)の区別がない
- list<string>やarray<string,Book>のように書くのが望ましい
- 配列の中身に同じ構造のものが繰り返されるときは array<...>
配列の中身がキーごとに別のデータが格納されるときは array{...}
- この <> と {} のカッコの種類は瞬時に混乱しないようにしておきましょう
Page 103
array-shapes (Object-like arrays)
- array{key: type} keyというキーが入っている連想配列
- array{key?: type} keyというキーが省略されている連想配列
- array{0: typeA, 1: typeB} 長さ2の配列(リスト)
- array{typeA, typeB} この形状ではキーを省略して型だけを列挙できる
- array{} 中に何も入っていない配列(空配列)
Page 119
DTO (Data Transfer Object)
- データを格納して持ち運ぶことを目的としたクラス
- C言語などの構造体(struct)をクラスで表現したものとも考えられる
- 典型的には単なるPOPOで実装できる
- PHP 8.0からはコンストラクタプロモーションで、異様に簡潔に定義できる
- 現代PHPでは小さいイミュータブルなクラスをバンバン切っていく方が
責務が小さく解析もしやすくなるが今回の本題ではないので割愛
Page 130
クラス vs array
- 一般論としては何でも格納できる配列より、クラス定義したオブジェクトの方
が静的解析もしやすく、実行時に意図しない値も紛れにくい
- 特にPHP8ではコンストラクタプロモーションによって定義のハードルが
一気に下がり、名前付き引数によってコード上に意図も込めやすくなった
- クラスは名前を付けて定義するので、似て非なる別のクラスを
いくつも作ることになるとしんどくなってくる
- 単なるデータとして名無しのarray-shapesが良いこともある
Page 146
check & throw
falseが混じる可能性を排除falseだったら関数を抜けることで
Page 163
if/assert vs @var
- if文/assertなどは単純な型宣言よりも詳細に型付けできる
- 本番でassert式の内容を評価するかは設定で制御できる(マニュアル参照)
- 私は無効化しない方が安全だと思います
- @varはarray-shapesなどを使って配列の構造も詳細に型を付けられる。
ただし単なるコメントなので実態に反する型も付けられてしまうので要注意
Page 164
if/assert vs @var の使い分け案
- 変数を生成/取り出した直後に引数としてそのまま渡す場合は、
実装側の責任とする／型宣言による自動型チェックで保証されるので @var
- DBのクエリ結果などは@varで済ませるか、hydratorライブラリを使って
期待通りの構造の配列／クラスにマッピングする
- 変数を生成/取り出した直後にそのオブジェクトのメソッド呼び出しをする
場合は、 assert($var instaceof Foo) のようにチェックしておくことでエラーメッセージがわかりやすくなる
Page 173
期待した型がつかないと思ったら最小のコードをオンラインでチェックしましょう
Page 174
バグの場合もあるし実装してPRを送るチャンスかもしれない
Page 180
現在のPHPStanの仕様上このような型はつけられない
Page 182
そのうち(誰かが実装完了すれば)改善する見込みはある
Page 183
PHPStanの実装は超簡単だとは言えないが仕事でPHPやってたら手を出せないほど難解というほどではない
PHPStan - Visual Studio Marketplace
Error Lens - Visual Studio Marketplace
GitHub - neoclide/coc.nvim: Nodejs extension host for vim & neovim, load extensions like VSCode and host language servers.
GitHub - dense-analysis/ale: Check syntax in Vim/Neovim asynchronously and fix files, with Language Server Protocol (LSP) support
GitHub - emacs-php/phpstan.el: Interface to PHPStan (PHP static analyzer)
GitHub - mattn/efm-langserver: General purpose Language Server