色んなオートローダーを覗き見る #phpcon_okinawa

PHPカンファレンス沖縄2024の発表資料です
https://fortee.jp/phpcon-okinawa-2024/proposal/92abb418-8735-41d9-bbf8-ffc3109d018b

Transcript

1. 色んなオートローダーを覗き見る PHPカンファレンス沖縄2024 Hideki Kinjyo GitHub: o0h / X: @o0h_ [公開用]
2. 自己紹介 • 金城秀樹 / きんじょうひでき • GitHub: @o0h / 𝕏 : @o0h_ • 好きなFWはCakePHP • アイコンは美味しい鮭親子丼の写真です • 沖縄は23年ぶり16回目くらいです多分！ 
3. このお話は？ 感じてもらいたいこと • 「オートローダーって、種が分かれば単純なんだな！」の気持ち • 「今日のデファクトスタンダードってこうなんだ」 「それ以外の実装もあるんだな」の気持ち 話さない • 詳細な実装方法や利用時の注意点といった細かい事柄 • 資料の「付録」で少し踏み込んでいます 
4. おしながき 1.「オートロード」って何してるの？ 2.モダン・スタンダードの世界 3.ちょっとレトロな世界、各地の方言 4.まとめ 
5. 1. 「オートロード」って何? && 何してるの？ 2. モダン・スタンダードの世界 3. ちょっとレトロな世界、各地の方言 4. まとめ
6. PHPでクラスを使ってみよう！ PHPでなにかのクラスを使いたい時、 どうすれば良いでしょう？
7.  クラス利用の流れ クラスXを利用しようとする 処理を実行 クラスXが存在する？ Fatal Error 何かのクラスを利用しようとした時には、 その定義を利用できる必要がある
8.  クラス利用の流れ クラスXを利用しようとする 処理を実行 クラスXが存在する？ Fatal Error 同じファイルで定義されていれば 問題なく利用できる
9.  クラス利用の流れ クラスXを利用しようとする 処理を実行 クラスXが存在する？ Fatal Error 別ファイルであっても、 読み込んであれば問題なし
10.  クラス利用の流れ クラスXを利用しようとする 処理を実行 クラスXが存在する？ Fatal Error 利用したかったクラス定義が 解決できない場合、致命的なエラーに
11. オートロード？ クラスのオートローディングは、 使おうとしたクラスが存在しなかった時に 遅延読み込みをする仕組み ※ Class, Interface, Trait, Enumで有効
12.  クラス利用の流れ with オートロード クラスXを利用しようとする 処理を実行 クラスXが存在する？ Fatal Error 定義済みクラスが存在しなかった場合に、 事前に決めた方法で解決を試みる ここで 一踏ん張り！
13. spl_autoload_register • 「事前に決めたルール」を登録する方法がspl_autoload_register() • 「要求されたクラス名を引 数にとって何かをする」動 作を記述したコールバック を登録するもの • `__autoload()` 関数は PHP8.0で廃止されました 
14. spl_autoload_register 典型的な実装: 1. 与えられたクラス名に基 づいて、対応するファイ ル名(パス)を割り出す 2. 割り出したパスに対して requireを実行 3. ファイルの新規読み込み により、新しいクラス定 義を解決する  ちゃんと動くコードの例。 ʆ./classes/Command.php` が読み込まれる
15. spl_autoload_register 必須なのは「ファイルを読 み込む」ではなく「クラス を解決する」なので、必ず しもrequire/includeを行わ なくても良い 
16. 1. 「オートロード」って何? && 何してるの？ 2. モダン・スタンダードの世界 〜Composerが提供するオートロード〜 3. ちょっとレトロな世界、各地の方言 4. まとめ
17. この章の話 「最近、オートロードといえばComposer！」 「実際にはどんなことをやってるんだ？？」を概念レベルで話します  アップロードしている資料では、「付録」として実コード(を改変したもの)を用いて解説しています 詳しくはそちらをご覧ください
18. Composerがオートロードを提供するまでの流れ  $ tree -L 3 app app └─ vendor ├─ autoload.php └─ composer ├── ClassLoader.php ├── autoload_real.php └── autoload_static.php 関係するファイルたち
19. Composerがオートロードを提供するまでの流れ  (app/index.php) vendor/autoload.php vendor/composer/ autoload_real.php vendor/composer/ autoload_static.php vendor/composer/ ClassLoader.php 各ファイルの依存関係: 矢印の向きにincludeする
20. 各ファイルの役割  (app/index.php) vendor/autoload.php vendor/composer/ autoload_real.php vendor/composer/ autoload_static.php vendor/composer/ ClassLoader.php \ComposerAutoloaderInitXXX +getLoader() \Composer\Autoload \ComposerStaticInitXXX +getInitializer() \Composer\Autoload \ClassLoader +register() +loadClass()
21. 各ファイルの役割: ClassLoader 実質的なロジックを持つクラス • register: spl_autload_registerによるオートロードの登録を行う • loadClass: クラス名(FQCN)に対応するパスの解決とincludeを行う  vendor/composer/ ClassLoader.php \Composer\Autoload \ClassLoader +register() +loadClass()
22. 各ファイルの役割: ComposerStaticInitXXX 設定データを持つクラス • パスの解決に必要となる名前空間やクラス名とパスの 対応情報を保持していて、 ClasLoaderインスタンスに提供する  vendor/composer/ autoload_static.php \Composer\Autoload \ComposerStaticInitXXX +getInitializer()
23. 各ファイルの役割: ComposerAutloaderInitXXX 手続きの起動 • StaticInit, ClassLoaderを使役し、オートロードの登録手続きを呼び出す • autoload.filesに指定されたファイルのイーガーロードを行う  vendor/composer/ autoload_real.php \ComposerAutoloaderInitXXX +getLoader()
24. 各ファイルの役割: autoload.php AutoloaderInitを読み込み、処理を委譲しているだけ  vendor/autoload.php require_once __DIR__ . '/composer/autoload_real.php'; return ComposerAutoloaderInitXXX::getLoader();
25. 取り上げる3つのオートロード • Composerが提供する 主なオートロードの仕組み • Class Map • PSR-0 • PSR-4 • いずれも、 `loadClass()`内で `findFile()`を用いて 解決する 
26. 取り上げる3つのオートロード  事前知識として、 クラス名(FQCN))とファイルパスの対応を 辞書として保持して、解決に利用する • Composerが提供する 主なオートロードの仕組み • Class Map • PSR-0 • PSR-4 • いずれも、 `loadClass()`内で `findFile()`を用いて 解決する 事前知識として、 ベースとなる名前空間とディレクトリパスの対応を 辞書として保持して、解決に利用する サブディレクトリの位置やファイル名は 命名規則から(＝ルールベースで、動的に)割り出す ComposerStaticInitで 「事前知識」の部分を扱っている
27. Class Map  // in \Composer\Autoload\ ComposerStaticInitXXXX public static $classMap = [ 'Composer\\InstalledVersions' => __DIR__ . '/../composer/InstalledVersions.php', 'Mobile_Detect' => __DIR__ . '/../mobiledetect/mobiledetectlib/Mobile_Detect.php', ]; // in \Composer\Autoload\ClassLoader public function findFile($class) { if (isset($this->classMap[$class])) { return $this->classMap[$class]; } クラス名(FQCN)をキーにして、 自クラスのstatic memberから 該当する{fqcn: path}を探索しパスを解決する
28. PSR-0, PSR-4 • PSR-0/4: 名前空間・クラスと、それに対応させるファイルパスの規則 • Class Mapが「クラスとパス」の対応を利用したのに対し、 「ルートとなる名前空間(名前空間プリフィックス)」と 「対応するディレクトリパス(ベースディレクトリ)」情報を利用する  // in \Composer\Autoload\ClassLoader public function findFile($class) { // தུ $file = $this->findFileWithExtension($class,'.php'); return $file; 命名規則から動的にFQCN->パスを解決する 実装は`findFileWithExtension()`
29. PSR-0, PSR-4: prefix map  public static $prefixDirsPsr4 = [ 'React\\Promise\\' => [0 => __DIR__ . '/..' . '/react/promise/src'], 'Psr\\Log\\' => [0 => __DIR__ . '/..' . '/psr/log/src'], 'Psr\\Container\\' => [0 => __DIR__ . '/..' . '/psr/container/src'], ]; public static $prefixesPsr0 = [ 'D' => [ 'Diff' => [0 => __DIR__ . '/..' . '/phpspec/php-diff/lib'], ], 'H' => [ 'HTMLPurifier' => [0 => __DIR__ . '/..' . '/ezyang/htmlpurifier/library'], ], ]; ComposerStaticInitXXXXがmapを持っている。ClassLoaderに代入される
30. PSR-0: FQCN->パスの変換@findFileWithExtension 1. 名前空間(prefix)からディレクトリのパスを取得 2. 名前空間(prefix)より下位の`\`と全ての`_` を ディレクトリの区切り文字に変換してサブディレクトリとファイル名に 3. {1 + 2 + '.php'}でフルパスを取得  ొ࿥৘ใ($classLoader->prefixesPsr0): 'HTMLPurifier' => [0 => __DIR__ . '/..' . '/ezyang/htmlpurifier/library'] ೖྗ: 'HTMLPurifier_AttrDef_CSS_AlphaValue' ग़ྗ: '/vendor/ezyang/htmlpurifier/library/HTMLPurifier/AttrDef/CSS/AlphaValue.php'
31. PSR-0:公式のサンプル  PSR-0: Autoloading Standard - PHP-FIG https://www.php-fig.org/psr/psr-0/
32. PSR-4: FQCN->パスの変換@findFileWithExtension 1. 名前空間(prefix)からディレクトリのパスを取得 2. 名前空間の区切り文字をディレクトリの区切り文字に変換して サブディレクトリとファイル名に 3. {1 + 2 + '.php'}でフルパスを取得  ొ࿥৘ใ($classLoader->prefixesPsr4): 'React\\Promise\\' => [0 => __DIR__ . '/..' . '/react/promise/src'], ೖྗ: '\React\Promise\Exception\CompositeException' ग़ྗ: '/vendor/react/promise/src/Exception/CompositeException.php'
33. PSR-4:公式のサンプル  PSR-4: Autoloader https://www.php-fig.org/psr/psr-4/
34. セクションのまとめ • Composerのオートロード、Class Map / PSR-4 / PSR-0に対応している • PSR-4 / PSR-0は、名付けのルールは異なるけれども 「ルートの名前空間を定義する」 「サブ名前空間やディレクトリの区切り方のルールがある」 「名前空間とベースクラス名からパスを知る」 と、やっていることは同じ • いずれも「パスを見つけて→ファイルをinclude」をするだけ、単純！ 
35. 1. 「オートロード」って何? && 何してるの？ 2. モダン・スタンダードの世界 3. ちょっとレトロな世界、各地の方言 〜現代、Composer誕生期、Composer以前〜 4. まとめ
36. この章の話 • 「最近、オートロードといえばComposer！」 「それ以外の道や、過去はどうしてたの？」を概念レベルで話します • 目的: Composer/PSR-4だけが唯一の実装でないんだな、と知る 目的でない: Composerより優れた道があるぞ、と提案する 
37. 覗いてみましょう、色々な世界<フレームワーク> Composerのデファクト化以後〜登場前のオートロードの世界を覗きます 1. 最近の有名どころなものたち w/Composer 2. Yii 2 (2014〜) 3. Zend Framework 2 (2012〜) 4. CakePHP 2 (2011〜) ※ Composerの1.0.0-alpha1が2013 ※ PSR-0(SplClassLoader)の提案が2010 
38. 1. Laravel, CakePHP(3+),Slim etc ─今風のFWたち • PSR-4準拠のオートロードに対応している • オートローダーの実装はComposerに依存 • = `composer require``composer create-project`した時点で使える • comopser.jsonのautoload.psr-4フィールドを設定して利用 • index.phpなど、エントリーポイントとなるファイルにおいて `require __DIR__ . '/../vendor/autoload.php'` が記述されるのが一般的 
39. 2. Yii2 • PSR-4準拠/Class Map形式のオートロードに対応している • ただし、Composer由来のオートローダーだけではなく、 FW自前の機能を付与したオートローダーを提供 • ザックリ言うと、FW独自の規則・設定に則っていれば composer.jsonの改変をせずともクラスファイルの読み込みが可能になっている  鍵となる概念: クラスのオートロード | Yii 2.0 決定版ガイド | Yii PHP Framework https://www.yiiframework.com/doc/guide/2.0/ja/concept-autoloading
40. Yii2のオートロード@超ざっくりイメージ 
41. Yii2のオートロード@超ざっくりイメージ  アプリケーションのconfigファイルに、 「エイリアス名」と「ディレクトリパス」を設定する エイリアスを利用したパスの解決が行われる ex)`special\SugoiSuteki` => `{PJ_ROOT}/app/specialSugoiSuteki.php`
42. 3. Zend Framework2 • PSR-0準拠/Class Map形式のオートロードに対応している • 独自のオートローダーを利用 • 「モジュール」と呼ばれる仕組みが提供されているのが特徴的で、 任意のディレクトリ(=ルート名前空間)にMVC一式が格納される 
43. Zend Framework2: モジュールの例 • 同一プロジェクトの中に、 複数の名前空間を簡単に持てる • PSR-4でいうprefixに該当 • アプリケーションに対して 「この名前空間が有効である」を 伝える必要が生じる  $ tree -L 2 app app ├── config ├── module │ ├── Album │ │ ├── Module.php │ │ ├── config │ │ ├── src │ │ └── view │ └── Artist └── public `\Album` ネームスペース `\Artist` ネームスペース
44. モジュール作成の例@ざっくりイメージ 
45. モジュール作成の例@ざっくりイメージ  モジュールごとの構成クラスを作成し、 {ルート名前空間名: ディレクトリパス}を設定する Class Mapを利用する際も、同メソッドの返り値にて設定する
46. 4. CakePHP2 • 独自の遅延読み込み機構を提供 • PHP5.2.8以上をサポートしており、 「spl_autoload_registerは使えるが、名前空間は利用しない」 という制約がある • 開発者が、利用したいクラスを明示的に宣言して登録する 
47. https://book.cakephp.org/2/ja/models.html 
48. https://book.cakephp.org/2/ja/models.html  Class Mapへの登録を行うメソッド
49. https://book.cakephp.org/2/ja/models.html  クラスパス: 名前空間的なもの。 `Model` はフレームワークのデフォルトで設定してあり、 `app/Model` に対応する クラス名 これで、 `AppModel` クラスを利用しようとすると `app/Model/AppModel.php` が遅延読込可能になる
50. App::uses()の実態 
51. 実際にオートローダーを登録しているところ 
52. セクションのまとめ • 「Composer以後」「Composer(PSR-0)誕生期」「Composer以前」 のような、時代に応じて解決方法が異なる雰囲気 • フレームワークが提供したい機能に応じて、 独自のオートローダーを用意して利便性を高めるアプローチもある 
53. 1. 「オートロード」って何? && 何してるの？ 2. モダン・スタンダードの世界他のやつ 3. ちょっとレトロな世界、各地の方言 4. まとめ
54. 最近の開発では・・・ • Composerの提供するオートローダーを利用するのが一般的 • その内容は、Class Map・PSR-4・PSR-0の実装が主となっている • 解剖してみると、とっても単純！ • 事前に「map」を用意してルールベース(文字列置換)でファイルを見つけるだけ 
55. 知っておくと良いこと・知らなくても良いこと • Composerのオートローダーは「PSR-4実装の1つ」にすぎず、 必要に応じて使ったり使わなかったりできる • 例えば「モジュール単位で名前空間を細かく分ける」思想であれば、 `composer.json`を都度いじる(=`dumpautload`を要する)のは面倒かも • 自前で実装すれば、別の方法で名前空間の追加ができる • 「当たり前」で留まらず一歩踏み込むと、細かく工夫もできるかも • 例えば「PSR-4を使っていればOK」から「Class Mapにするか？を考える」など • `composer dumpautoload` の `—optimize`オプションや PHPUnitの`composer.json` によるautoload.classmap指定などの例 
56. まとめ • 『遠回りこそが俺の最短の道だった』という言葉があります • 一見、無駄と思える雑学レベルの知識── 「関係ない実装」「昔の話」が、いつかヒントになるかも知れません • ぜひ、身の回りのことに興味を持ってみましょう！！ • この発表が、誰かの「ちょっと面白そう」のきっかけになれば幸いです！ 
57. おしまい！ お付き合いいただき ありがとうございました!!
58. Appendix 1. 実際のコード(っぽい)で追う Composerのオートロード処理
59. Composerがオートロードを提供するまでの流れ  $ tree -L 2 app app └── vendor ├── autoload.php ├── ClassLoader.php ├── autoload_real.php └── autoload_static.php 関係するファイルたち $3より再掲
60. Composerがオートロードを提供するまでの流れ  (app/index.php) vendor/autoload.php vendor/composer/ autoload_real.php vendor/composer/ autoload_static.php vendor/composer/ ClassLoader.php 各ファイルの依存関係: 矢印の向きにincludeする $3より再掲
61. 各ファイルの役割  (app/index.php) vendor/autoload.php vendor/composer/ autoload_real.php vendor/composer/ autoload_static.php vendor/composer/ ClassLoader.php \ComposerAutoloaderInitXXX +getLoader() \Composer\Autoload \ComposerStaticInitXXX +getInitializer() \Composer\Autoload \ClassLoader +register() +loadClass() $3より再掲
62. 余談: 自動生成されるクラス名について • 記述内容が毎回変わるので、クラス名が動的に変更される • dumpautoload時にsuffixを付与: デフォルトだとcontent-hashの値 • ex)`ComposerStaticInit67574dcf9d425e8bc6c10ce234303952` • • ClassLoaderは変更がない(既存ソースのコピーで作成される) • ComposerAutoloaderInitXXXXX \Composer\Autoload\ComposerStaticInitXXXXX \Composer\Autoload\ClassLoader 
63. Composerのautoloader よくみるアレ 
64. autoload@超ざっくりイメージ 
65. autoload@超ざっくりイメージ  実態は、自動生成された別クラスへのデ リゲーションを行っているだけ
66. autoload_real@超ざっくりイメージ 
67. autoload_real@超ざっくりイメージ  オートロードのための ロジック(クラス)を読み出し＆インスタンス化 ClassLoaderが扱うクラスの情報を読み出 し & オートーローダーの登録
68. autoload_real@超ざっくりイメージ  静的な読み出しの実行(イーガーロード)。 こっちはPHPのオートロードに関係しないので割愛 (see: https://getcomposer.org/doc/04-schema.md#files)
69. ClassLoader::register@超ざっくりイメージ 
70. ClassLoader::register@超ざっくりイメージ  自身が持つメソッドを、 オートロードの手続きとして登録
71. ClassLoader::loadClass@超ざっくりイメージ 
72. ClassLoader::loadClass@超ざっくりイメージ  $class(FQCN)に対応するファイル の存在を確認しつつ 要するに `include` を呼び出しているだけ
73. ClassLoader::findFile@超ざっくりイメージ 
74. ClassLoader::findFile@超ざっくりイメージ  「クラスマップ」形式での探索 {class-name: file-path}形式の 辞書(連想配列)を使った解決 PSR-0, PSR-4対応の探索
75. $this->classMapとは？？？ 
76. [再掲] ClassLoaderへのClass Map(等)の登録部分  autoload_real(先述)の処理。 ClassLoaderが扱うクラスの情報を読み出し & オートーローダーの登録
77. ComposerStaticInit::getInitializer 
78. ComposerStaticInit::$classMap@超ざっくりイメージ 
79. ComposerStaticInit::$classMap@超ざっくりイメージ  FQCNと、vendor配下の絶対パスが紐づいているので、 これを探ってファイル名を引き出す
80. PSR-4周りの登録部分@超ざっくりイメージ 
81. PSR-4周りの登録部分@超ざっくりイメージ  ネームスペース(prefix)と、 vendor配下のディレクトリの絶対パスが紐づいている。 ディレクトリは複数可なので、配列で宣言
82. [再掲] ClassLoader::findFile@超ざっくりイメージ 
83. ファイル探索に至る部分  PSR-0, PSR-4対応の探索
84. PSR-4でのファイル探索処理@超ざっくりイメージ 
85. PSR-4でのファイル探索処理@超ざっくりイメージ  FQCNの`\`(バックスラッシュ)を`/`に変換して、 拡張子(`.php`) を付与する ex)`Psr\Log\LogLevel` => `Psr/Log/LogLevel.php`
86. PSR-4でのファイル探索処理@超ざっくりイメージ  `\`が最後に出てくる位置で、名前空間名とクラス名を分割 ex)`Psr\Log\LogLevel` => `$search = Psr\Log\`
87. PSR-4でのファイル探索処理@超ざっくりイメージ  FQCNからだけでは、 名前空間の「サブ」と「prefix」の 見分けがつかないので セパレータ(`\`)で区切って再帰的 に照合していく
88. PSR-4でのファイル探索処理@超ざっくりイメージ  ディレクトリ名を除いたファイル名を取得する ex)`Psr\Log\LogLevel` => `LogLevel.php`
89. PSR-4でのファイル探索処理@超ざっくりイメージ  {名前空間: ディレクトリパス}の辞書とファイル名を利用して クラスファイルのフルパスを取得 ex)`Psr\Log\LogLevel` => `{PJ_ROOT}/vendor/psr/log/src/LogLevel.php`
90. [復習] ファイル名がわかればincludeできる！ 
91. PSR-0周りの登録部分@超ざっくりイメージ 
92. PSR-0周りの登録部分@超ざっくりイメージ  ネームスペースの先頭1文字目でグルーピング。 ネームスペース(prefix)と、 vendor配下のディレクトリの絶対パスが紐づいている。 ディレクトリは複数可なので、配列で宣言
93. PSR-0でのファイル探索処理@超ざっくりイメージ 
94. PSR-0でのファイル探索処理@超ざっくりイメージ  FQCNの`\`(バックスラッシュ)を`/`に変換して、 拡張子(`.php`) を付与する ex)`HTMLPurifier_Generator` => `HTMLPurifier_Generator.php`
95. PSR-0でのファイル探索処理@超ざっくりイメージ  ネームスペース部分以外のアンダースコアを`/`に変換 ex)`HTMLPurifier_Generator` => `HTMLPurifier/Generator.php`
96. PSR-0でのファイル探索処理@超ざっくりイメージ  {名前空間: ディレクトリパス}の辞書とファイル名を利用して クラスファイルのフルパスを取得 ex)`HTMLPurifier_Generator` => `{PJ_ROOT}/vendor/ezyang/htmlpurifier/library/ HTMLPurifier/Generator.php`