ファイル先頭の use の意味、説明できますか？ 〜PHP の namespace と autoloading の関係を正しく理解しよう〜 / namespace and autoloading in php

2024/03/07～09 開催の「PHPerKaigi 2024」（https://phperkaigi.jp/2024/ ）の発表資料です。

詳細：https://fortee.jp/phperkaigi-2024/proposal/bc88c7e7-0169-4299-a471-9adb1a2e5bcc

2024/03/10 追記：スライド中の「use 演算子」という表現を、適切な「use 文」という表現に修正しました。

Transcript

1. ファイル先頭の use の意味、 説明できますか？ 〜PHP の namespace とautoloading の 関係を正しく理解しよう〜 2024/03/09 PHPerKaigi 2024 @okashoi
2. 発表時には「use 演算子」と表現していましたが、 use は演算子ではなく文であるという旨のフィードバック をいただいたためスライドを修正しました。 2024/03/10 追記
3. 1. はじめに 00:00～02:00 2. use 文とは 02:00～08:00 3. なぜ他ファイルを読み込めるのか 08:00～11:30 4. どうファイル名が解決されるのか 11:30～17:00 5. まとめ 17:00～19:00 6. 自己紹介 19:00～20:00 目次（※時間は目安）
4. 1. はじめに 00:00～02:00 2. use 文とは 02:00～08:00 3. なぜ他ファイルを読み込めるのか 08:00～11:30 4. どうファイル名が解決されるのか 11:30～17:00 5. まとめ 17:00～19:00 6. 自己紹介 19:00～20:00 目次（※時間は目安）
5. フレームワークを使っていると遭遇するコード use App\Models\Flight; // Retrieve a model by its primary key... $flight = Flight::find(1); // Retrieve the first model matching the query constraints... $flight = Flight::where('active', 1)->first(); // Alternative to retrieving the first model matching the query constraints... $flight = Flight::firstWhere('active', 1); 引用元：https://laravel.com/docs/10.x/eloquent#retrieving-single-models
6. 説明できますか？ use App\Models\Flight; // Retrieve a model by its primary key... $flight = Flight::find(1); // Retrieve the first model matching the query constraints... $flight = Flight::where('active', 1)->first(); // Alternative to retrieving the first model matching the query constraints... $flight = Flight::firstWhere('active', 1); 引用元：https://laravel.com/docs/10.x/eloquent#retrieving-single-models
7. 「use って書いたら 　指定したファイルの内容を 　読み込んでくれるんでしょ？」
8. 「use って書いたら 　指定したファイルの内容を 　読み込んでくれるんでしょ？」
9. 1. はじめに 00:00～02:00 2. use 文とは 02:00～08:00 3. なぜ他ファイルを読み込めるのか 08:00～11:30 4. どうファイル名が解決されるのか 11:30～17:00 5. まとめ 17:00～19:00 6. 自己紹介 19:00～20:00 目次（※時間は目安）
10. そもそもこれはファイル名ではない use App\Models\Flight; // Retrieve a model by its primary key... $flight = Flight::find(1); // Retrieve the first model matching the query constraints... $flight = Flight::where('active', 1)->first(); // Alternative to retrieving the first model matching the query constraints... $flight = Flight::firstWhere('active', 1); 引用元：https://laravel.com/docs/10.x/eloquent#retrieving-single-models
11. <?php namespace App\Models; use Illuminate\Database\Eloquent\Model; class Flight extends Model { // } 名前空間 + クラス名 定義元
 引用元：https://laravel.com/docs/10.x/eloquent#eloquent-model-conventions
12. 本来、ファイルパスとは独立した概念 1 ファイル内で複数の名前空間を使うことができる 名前空間の使い方
13. <?php namespace Models { class Flight { public const NAME = 'flight model'; } } namespace Actions { class Flight { public const NAME = 'flight action'; } } namespace { use Models\Flight as FlightModel; use Actions\Flight as FlightAction; echo FlightModel::NAME . PHP_EOL; // flight model echo FlightAction::NAME . PHP_EOL; // flight action } 1ファイル内で こういう書き方をしても 文法上問題ない
14. <?php namespace Models { class Flight { public const NAME = 'flight model'; } } namespace Actions { class Flight { public const NAME = 'flight action'; } } namespace { use Models\Flight as FlightModel; use Actions\Flight as FlightAction; echo FlightModel::NAME . PHP_EOL; // flight model echo FlightAction::NAME . PHP_EOL; // flight action } 1ファイル内で こういう書き方をしても 文法上問題ない
15. <?php namespace Models { class Flight { public const NAME = 'flight model'; } } namespace Actions { class Flight { public const NAME = 'flight action'; } } namespace { use Models\Flight as FlightModel; use Actions\Flight as FlightAction; echo FlightModel::NAME . PHP_EOL; // flight model echo FlightAction::NAME . PHP_EOL; // flight action } 1ファイル内で こういう書き方をしても 文法上問題ない
16. use 文に関する PHP 公式ドキュメント https://www.php.net/manual/ja/language.namespaces.importing.php
17. use 文に関する PHP 公式ドキュメント https://www.php.net/manual/ja/language.namespaces.importing.php “PHP は定数、関数、クラス、インターフェイス、トレイト、列挙型 (Enum)、名前空間のエイリアスやインポートをサポートしています。 エイリアス作成には use 演算子を使用します。” （注）「use 演算子」という表現はドキュメント原文まま
18. use 文に関する PHP 公式ドキュメント https://www.php.net/manual/ja/language.namespaces.importing.php “PHP は定数、関数、クラス、インターフェイス、トレイト、列挙型 (Enum)、名前空間のエイリアスやインポートをサポートしています。 エイリアス作成には use 演算子を使用します。” （注）「use 演算子」という表現はドキュメント原文まま
19. use 文に関する PHP 公式ドキュメント https://www.php.net/manual/ja/language.namespaces.importing.php
20. Flight → App\Models\Flight というエイリアス use App\Models\Flight; // Retrieve a model by its primary key... $flight = Flight::find(1); // Retrieve the first model matching the query constraints... $flight = Flight::where('active', 1)->first(); // Alternative to retrieving the first model matching the query constraints... $flight = Flight::firstWhere('active', 1); 引用元：https://laravel.com/docs/10.x/eloquent#retrieving-single-models
21. Flight → App\Models\Flight というエイリアス use App\Models\Flight as Flight; // Retrieve a model by its primary key... $flight = Flight::find(1); // Retrieve the first model matching the query constraints... $flight = Flight::where('active', 1)->first(); // Alternative to retrieving the first model matching the query constraints... $flight = Flight::firstWhere('active', 1);
22. つまりこのコードは use App\Models\Flight as Flight; // Retrieve a model by its primary key... $flight = Flight::find(1); // Retrieve the first model matching the query constraints... $flight = Flight::where('active', 1)->first(); // Alternative to retrieving the first model matching the query constraints... $flight = Flight::firstWhere('active', 1);
23. こう書いているのと同じ // Retrieve a model by its primary key... $flight = \App\Models\Flight::find(1); // Retrieve the first model matching the query constraints... $flight = \App\Models\Flight::where('active', 1)->first(); // Alternative to retrieving the first model matching the query constraints... $flight = \App\Models\Flight::firstWhere('active', 1);
24. use 文によって簡潔に書ける use App\Models\Flight; // Retrieve a model by its primary key... $flight = Flight::find(1); // Retrieve the first model matching the query constraints... $flight = Flight::where('active', 1)->first(); // Alternative to retrieving the first model matching the query constraints... $flight = Flight::firstWhere('active', 1); 引用元：https://laravel.com/docs/10.x/eloquent#retrieving-single-models
25. • use 文に与えているのはファイルパスではない • 名前空間 + クラス名 • 本来、名前空間とファイルパスは独立した概念 • use 文によってエイリアスが作成できる use 文 まとめ
26. 1. はじめに 00:00～02:00 2. use 文とは 02:00～08:00 3. なぜ他ファイルを読み込めるのか 08:00～11:30 4. どうファイル名が解決されるのか 11:30～17:00 5. まとめ 17:00～19:00 6. 自己紹介 19:00～20:00 目次（※時間は目安）
27. （再掲）そもそもこれはファイル名ではない use App\Models\Flight; // Retrieve a model by its primary key... $flight = Flight::find(1); // Retrieve the first model matching the query constraints... $flight = Flight::where('active', 1)->first(); // Alternative to retrieving the first model matching the query constraints... $flight = Flight::firstWhere('active', 1); 引用元：https://laravel.com/docs/10.x/eloquent#retrieving-single-models
28. 「じゃあどうやって他のファイルの　 定義にアクセスしてるの？」
29. https://getcomposer.org/
30. Composer が自動読み込み機能を提供している https://getcomposer.org/doc/01-basic-usage.md#autoloading
31. Composer が自動読み込み機能を提供している https://getcomposer.org/doc/01-basic-usage.md#autoloading
32. 「そんなの書いた覚えないよ」
33. フレームワークの処理の起点は index.php https://speakerdeck.com/okashoi/index-dot-php-of-each-framework
34. 例）Laravel の public/index.php https://github.com/laravel/laravel/blob/1a4d1dc81f7924259885250d011ffad2472 8cd86/public/index.php#L34
35. 例）Laravel の public/index.php https://github.com/laravel/laravel/blob/1a4d1dc81f7924259885250d011ffad2472 8cd86/public/index.php#L34
36. 例）CakePHP の webroot/index.php https://github.com/cakephp/app/blob/b335138cf00827894131de289f2cd3b69024 2bd1/webroot/index.php#L28
37. 例）CakePHP の webroot/index.php https://github.com/cakephp/app/blob/b335138cf00827894131de289f2cd3b69024 2bd1/webroot/index.php#L28
38. • ファイルの自動読み込みは Composer が提供してくれ ている • vendor/autoload.php だけを読み込めばよい • フレームワークでは index.php にて vendor/autoload.php が読み込まれている なぜ他ファイルを読み込めるのか まとめ
39. 休憩（ここで水をのむ）
40. 1. はじめに 00:00～02:00 2. use 文とは 02:00～08:00 3. なぜ他ファイルを読み込めるのか 08:00～11:30 4. どうファイル名が解決されるのか 11:30～17:00 5. まとめ 17:00～19:00 6. 自己紹介 19:00～20:00 目次（※時間は目安）
41. 「名前空間だけで対象のファイルを 　どうやって見つけてるの？」
42. https://www.php-fig.org/psr/
43. https://www.php-fig.org/psr/psr-4/ PSR-4 にて autoloading の仕様が定義されている ※ PSR それ自体は「仕様（≒文書）」であり、ライブラリなどではない
44. https://www.php-fig.org/psr/psr-4/ PSR-4 にて autoloading の仕様が定義されている
45. https://www.php-fig.org/psr/psr-4/ PSR-4 にて autoloading の仕様が定義されている
46. PSR-4 にて autoloading の仕様が定義されている https://www.php-fig.org/psr/psr-4/
47. https://www.php-fig.org/psr/psr-4/ PSR-4 にて autoloading の仕様が定義されている
48. https://www.php-fig.org/psr/psr-4/ PSR-4 にて autoloading の仕様が定義されている + = + = + = + =
49. PSR-4 にて autoloading の仕様が定義されている https://www.php-fig.org/psr/psr-4/
50. https://www.php-fig.org/psr/psr-4/ PSR-4 にて autoloading の仕様が定義されている
51. PSR-4 にて autoloading の仕様が定義されている https://www.php-fig.org/psr/psr-4/ + = + + = = + =
52. https://getcomposer.org/doc/04-schema.md#psr-4 Composer が PSR-4 形式をサポートしている
53. https://getcomposer.org/doc/04-schema.md#psr-4 Composer が PSR-4 形式をサポートしている namespace prefix base directory
54. 例）Laravel の composer.json https://github.com/laravel/laravel/blob/1a4d1dc81f7924259885250d011ffad2472 8cd86/composer.json#L23-L34
55. <?php namespace App\Models; use Illuminate\Database\Eloquent\Model; class Flight extends Model { // } 例）Laravel の Model app/Models/Flight.php
 引用元：https://laravel.com/docs/10.x/eloquent#eloquent-model-conventions
56. <?php namespace App\Models; use Illuminate\Database\Eloquent\Model; class Flight extends Model { // } 例）Laravel の Model app/Models/Flight.php
 引用元：https://laravel.com/docs/10.x/eloquent#eloquent-model-conventions namespace prefix base directory
57. <?php namespace App\Models; use Illuminate\Database\Eloquent\Model; class Flight extends Model { // } 例）Laravel の Model app/Models/Flight.php
 引用元：https://laravel.com/docs/10.x/eloquent#eloquent-model-conventions
58. <?php namespace App\Models; use Illuminate\Database\Eloquent\Model; class Flight extends Model { // } 例）Laravel の Model app/Models/Flight.php
 引用元：https://laravel.com/docs/10.x/eloquent#eloquent-model-conventions
59. 例）CakePHP の composer.json https://github.com/cakephp/app/blob/b335138cf00827894131de289f2cd3b69024 2bd1/composer.json#L27-L37
60. • PHP-FIG という団体が PSR（PHP Standard Recommendation）を策定している • PSR-4 にて autoloading の仕様が定義されている • namespace prefix と base directory • Composer が PSR-4 にもとづく autoloading をサポー ト（実装）している どうファイル名が解決されるのか まとめ
61. 1. はじめに 00:00～02:00 2. use 文とは 02:00～08:00 3. なぜ他ファイルを読み込めるのか 08:00～11:30 4. どうファイル名が解決されるのか 11:30～17:00 5. まとめ 17:00～19:00 6. 自己紹介 19:00～20:00 目次（※時間は目安）
62. まとめ • autoloading 機能を提供 • autoloading の 1 つの方法として PSR-4 をサポート • PSR-4 の仕様を策定 （ファイル名と名前空間の対応） • 言語機能としての名前空間 • use 文による名前空間の エイリアス
63. まとめ • autoloading 機能を提供 • autoloading の 1 つの方法として PSR-4 をサポート • PSR-4 の仕様を策定 （ファイル名と名前空間の対応） • 言語機能としての名前空間 • use 文による名前空間の エイリアス
64. まとめ • autoloading 機能を提供 • autoloading の 1 つの方法として PSR-4 をサポート • PSR-4 の仕様を策定 （ファイル名と名前空間の対応） • 言語機能としての名前空間 • use 文による名前空間の エイリアス
65. • use 文には他のファイルを読み込む働きはない • PSR-4 という autoloading についての仕様が 定められている • Composer は PSR-4 をサポート（実装）している • 各種フレームワークはインストールした時点で そのあたりの設定がすでに書かれている 全体 まとめ
66. 1. はじめに 00:00～02:00 2. use 文とは 02:00～08:00 3. なぜ他ファイルを読み込めるのか 08:00～11:30 4. どうファイル名が解決されるのか 11:30～17:00 5. まとめ 17:00～19:00 6. 自己紹介 19:00～20:00 目次（※時間は目安）
67. 所属：株式会社ウィルゲート 登壇： 寄稿： 岡田 正平／おかしょい X: @okashoi GitHub: @okashoi PHPerKaigi 2024 シルバースポンサー
69. 時間あまったら話すやつ
70. use 文について余談
71. 余談 use App\Models\Flight as Flight; // Retrieve a model by its primary key... $flight = Flight::find(1); // Retrieve the first model matching the query constraints... $flight = Flight::where('active', 1)->first(); // Alternative to retrieving the first model matching the query constraints... $flight = Flight::firstWhere('active', 1); 引用元：https://laravel.com/docs/10.x/eloquent#retrieving-single-models
72. こう書いても同じだし use App\Models\Flight as FlightModel; // Retrieve a model by its primary key... $flight = FlightModel::find(1); // Retrieve the first model matching the query constraints... $flight = FlightModel::where('active', 1)->first(); // Alternative to retrieving the first model matching the query constraints... $flight = FlightModel::firstWhere('active', 1); 引用元：https://laravel.com/docs/10.x/eloquent#retrieving-single-models
73. あるいは use App\Models\Flight as Flight; // Retrieve a model by its primary key... $flight = Flight::find(1); // Retrieve the first model matching the query constraints... $flight = Flight::where('active', 1)->first(); // Alternative to retrieving the first model matching the query constraints... $flight = Flight::firstWhere('active', 1); 引用元：https://laravel.com/docs/10.x/eloquent#retrieving-single-models
74. こういう書き方もできる use App\Models; // Retrieve a model by its primary key... $flight = Models\Flight::find(1); // Retrieve the first model matching the query constraints... $flight = Models\Flight::where('active', 1)->first(); // Alternative to retrieving the first model matching the query constraints... $flight = Models\Flight::firstWhere('active', 1); 引用元：https://laravel.com/docs/10.x/eloquent#retrieving-single-models