PHPの名前空間（namespace）

PHP勉強会in広島 Vol.4の登壇資料

Transcript

1. PHPの名前空間（ namespace） 2025年7月26日 PHP勉強会in広島Vol.4 株式会社GoQSystem 橋口凌
2. 「名前空間」とは何か？ 名前空間とは何でしょう ? 広義の「名前空間」とは、項目をカプセル化するもののことです。 これは多くの場面で見られる抽象概念です。 たとえば、たいていの OS はディレクトリでファイルをグループ化します。 この場合、ディレクトリがその中のファイルの名前空間として機 能しています。 具体的に言うと、 foo.txt というファイルは /home/greg と /home/other の両方に存在することが可能ですが、それ らふたつの foo.txt を同じディレクトリに配置することはできません。 さらに、/home/greg ディレクトリの外から foo.txt にアクセス するには、ディレクトリ名をファイル名の前につけて /home/greg/foo.txt としなければなりません。 プログラミングの世界における名 前空間も、この延長線上にあります。 引用：名前空間の概要（ PHPマニュアル：https://www.php.net/manual/ja/language.namespaces.rationale.php） 簡単にいうと、「住所のようなもの」です。
3. 「名前空間」とは何か？ 名前空間のない世界 // User.php（ECサイト用） class User { public function purchase() { } } // User.php（ブログ用） class User { // Fatal error: Cannot redeclare class public function writePost() { } } // index.php require_once 'models/User.php'; require_once 'models/Product.php'; require_once 'models/Order.php'; require_once 'controllers/UserController.php'; require_once 'controllers/ProductController.php'; // ... 数十個のrequire文
4. 「名前空間」とは何か？ PHPは同じ名前のクラス名は定義できない？ uuser.php <?php class User { public function getName() { return "John Doe"; } public function getEmail() { return "john.doe@example.com"; } } john.php
5. 「名前空間」とは何か？ PHPは同じ名前のクラス名は定義できない？ uuser.php <?php class User { public function getName() { return "Jane Doe"; } public function getEmail() { return "jane.doe@example.com"; } } jane.php
6. 「名前空間」とは何か？ PHPは同じ名前のクラス名は定義できない？ study.php <?php require_once 'jane.php'; require_once 'john.php'; $user = new User(); echo "Name: " . $user->getName() . "\n"; echo "Email: " . $user->getEmail() . "\n"; // Fatal error: Cannot redeclare class User // (previously declared in /var/www/html/uuser.php:3) // in /var/www/html/user.php on line 3 ご覧の通り、PHPでは同じクラス名を使うことはできません。
7. 「名前空間」とは何か？ PHPは同じ名前の関数は定義できない？ <?php function getGreeting() { return 'おはよう'; } someone.php anyone.php <?php function getGreeting() { return 'こんばんわ'; }
8. 「名前空間」とは何か？ PHPは同じ名前の関数は定義できない？ study.php ご覧の通り、PHPでは同じ関数名を使うことはできません。 <?php require_once 'someone.php'; require_once 'anyone.php'; echo getGreeting(); // Fatal error: Cannot redeclare function getGreeting() // (previously declared in /var/www/html/someone.php:3) // in /var/www/html/anyone.php on line 3
9. 名前空間を定義する 名前空間とは、文字通り名前の空間のことで、ここからここまでのコードが ◦◦という空間に属していると定め ることができます。空間が違えば、同じクラス名や関数名を定義して使うことができます。 名前空間という仕組みは、 PHP5.3.0で導入されたそうです。 namespace 名前空間名;
10. 名前空間を定義する namespaceは最初に記述する必要があります。 namespaceよりも前に書くことができるのは、 declare文のみです。 phpやhtml文の一番はじめに記述します。 <?php namespace 名前空間; class 最初にnamespaceは記述() {} <?php require_once "だめ.php"; namespace 名前空間;
11. 名前空間に属する関数を使うには？ 名前空間に属する関数を呼ぶときは、 ◦◦の名前空間にある関数だよと記述する必要があります。 最初に名前空間名を記述した後に \ （バックスラッシュ）を記述し、その後に関数名を記述します。 名前空間名\関数名; クラスと関数名の話しをしていますが、以下も同様です。 - 関数 - クラス - インターフェイス - 定数（const） 上述した4つ以外は、名前空間の影響を受けません。
12. 実際に名前空間を使ってみる 最初にエラーが発生した、 someone.phptとanyone.phpで名前空間を定義します。 <?php namespace Someone; function getGreeting() { return 'おはよう'; } <?php namespace Anyone; function getGreeting() { return 'こんばんわ'; }
13. 実際に名前空間を使ってみる study.phpでAnyoneという名前空間にある getGreeting()関数が呼ばれ、「こんばんわ」が表示されます。 今 回、名前空間名をファイル名と同じく命名しましたが、名前空間名は任意で決められますので、ファイル名と 関係ない名前空間名にすることも可能です。 <?php require_once 'someone.php'; require_once 'anyone.php'; echo Anyone\getGreeting(); // echo こんばんわ;
14. ひとつのファイルに複数の名前空間を定義できる？ 先ほどは、一つのファイルに一つの名前空間を定義しましたが、一つのファイルに複数の名前空間を定義す ることが可能です。複数の名前空間を定義するには、 2つの方法があります。 namespaceで名前空間を宣言した後に記述した関数などは、その名前空間に属します。 その後にまた namespace で名前空間を宣言すれば、その名前空間に属します。 <?php namespace Study; function getGreeting() { return 'こんにちは'; } namespace Rest; function getGreeting() { return 'おやすみ'; }
15. ひとつのファイルに複数の名前空間を定義できる？ study.phpで関数を呼ぶときに適切に名前空間名を記述すれば、それぞれの関数を呼ぶことができます。実 行すると「こんにちは」と「おやすみ」が表示されます。 <?php require_once 'namespaces.php'; echo Study\getGreeting(); echo "\n"; echo Rest\getGreeting(); // こんにちは // おやすみ 名前空間を続けて記述する方法を紹介しましたが、 この方法は、どこまでがどの名前空間かわかりにくい ので推奨されません。
16. ひとつのファイルに複数の名前空間を定義できる？ もう一つのやり方がブラケット記法です。波括弧で囲むことで名前空間を定義することが可能です。 波括弧内に記述した関数などは、その名前空間に属します。 <?php namespace Study { function getGreeting() { return 'こんにちは'; } } namespace Rest { function getGreeting() { return 'おやすみ'; } }
17. ひとつのファイルに複数の名前空間を定義できる？ 先ほどと同じように、 study.phpで関数を呼ぶときに適切に名前空間名を記述すれば、それぞれの関数を呼 ぶことができます。実行すると「こんにちは」と「おやすみ」が表示されます。 <?php require_once 'namespaces.php'; echo Study\getGreeting(); echo "\n"; echo Rest\getGreeting(); // こんにちは // おやすみ 先ほどの方法より、わかりやすくなっていますが、 なるべく一つのファイルでは一つの名前空間にするのが わかりやすいです。
18. 名前空間の外側で命令文を書くことができるのか？ 先ほどの記述の最後に echo 文を追記すると、Fatal errorになります。 先ほどの方法より、わかりやすくなっていますが、 なるべく一つのファイルでは一つの名前空間にするのが わかりやすいです。 <?php namespace Study { function getGreeting() { return 'こんにちは '; } } namespace Rest { function getGreeting() { return 'おやすみ'; } } echo "Hello"; // Fatal error: No code may exist outside of namespace {} // in /var/www/html/namespaces.php on line 14
19. 複数のファイルで同じ名前空間を使える？ one.phpとtwo.phpで以下のclass Oneを定義します。 <?php namespace One; class One { public function __construct() { echo "One class instantiated.\n"; } }
20. 複数のファイルで同じ名前空間を使える？ study.phpで利用しようとすると、 two.phpのOneはすでにone.phpで宣言されているので利用できないと Fatal errorが発生します。 <?php require_once 'one.php'; $one = new One\One(); require_once 'two.php'; $two = new One\One(); // One class instantiated. // Fatal error: Cannot redeclare class One\One (previously declared // in /var/www/html/one.php:3) in /var/www/html/two.php on line 3 同じ名前空間になるので、同名の関数などは定義できません。しかし、名前は一般的なものであれば重 複する可能性は大いにあります。サブ名前空間を利用することで解消します。
21. サブ名前空間とは？ 名前空間は、ディレクトリ構造の概念と同じく階層を持たせて記述することが可能です。「 \」で区切ってサブ名 前空間を記述できます。 名前空間\サブ名前空間\サブ名前空間 <?php namespace One\Goq; class One { public function __construct() { echo "One class instantiated.\n"; } }
22. サブ名前空間とは？ one.phpの名前空間をOne\Goq、two.phpの名前空間をOne\Systemに変更します。 <?php namespace One\System; class One { public function __construct() { echo "One class instantiated.\n"; } }
23. サブ名前空間とは？ study.phpを書き換えて利用します。先ほどは Fatal errorが発生しましたが、この場合は同じクラスでも問題 なく利用可能です。 <?php require_once 'one.php'; $one = new One\Goq\One(); require_once 'two.php'; $two = new One\System\One(); // One class instantiated. // One class instantiated.
24. 名前空間の記述について 今まで関数を呼ぶ側には、名前空間を指定しませんでした。関数を呼ぶ側にも、 namespace を記述すること が可能です。実際に関数を呼ぶ側にも同じ名前空間を宣言して確かめてみましょう。 name.phpでnamespace Nameを定義して、先ほどの someone.phpのgetGreeting()を利用します。 <?php namespace Name; require_once 'someone.php'; echo Someone\getGreeting(); echo "\n"; // Fatal error: Uncaught Error: Call to undefined function Name\Someone\getGreeting() // in /var/www/html/name.php:4 Stack trace: #0 {main} thrown // in /var/www/html/name.php on line 4
25. 名前空間の記述について undefined functionと表示されています。よくみると Name\Someone\getGreeting()となっており、意図する、 Someone\getGreeting()を使えていません。 名前空間はディレクトリ構造のように階層によって指定方法が異なります。名前空間の指定方法には - 非修飾形式 - 修飾形式 - 完全修飾形式 この3つがあります。 // Fatal error: Uncaught Error: Call to undefined function Name\Someone\getGreeting() // in /var/www/html/name.php:4 Stack trace: #0 {main} thrown // in /var/www/html/name.php on line 4
26. 名前空間の記述について 非修飾形式 はディレクトリ構造で言うところの同ディレクトリ内からの指定になります。 呼び出す側と呼び出される側が同じ名前空間にある場合、関数などを呼び出すのに名前空間の記述は必 要ありません。 <?php namespace Name; function getGreeting() { return "こんにちは"; } <?php namespace Name; require_once 'hello.php'; echo getGreeting(); echo "\n"; // こんにちは
27. 名前空間の記述について 修飾形式 はディレクトリ構造で言うところの ドキュメント相対パスです。 hello.phpの名前空間をName\Helloに 変更します。name.phpはNameのnamespaceを記述します。ディレクトリ構造でいうところの、 name.phpは hello.phpの空間より１つ上の階層に位置することになります。 <?php namespace Name\Hello; function getGreeting() { return "こんにちは"; } <?php namespace Name; require_once 'hello.php'; echo Hello\getGreeting(); echo "\n"; // こんにちは
28. 名前空間の記述について 完全修飾形式 はディレクトリ構造で言うところの ルート相対パスです。hello.phpは先ほどと同じく、 Name\Helloの名前空間。name.phpでは\Name\Hello\getGreeting()と指定します。 <?php namespace Name\Hello; function getGreeting() { return "こんにちは"; } <?php namespace Name; require_once 'hello.php'; echo \Name\Hello\getGreeting(); echo "\n"; // こんにちは
29. ここまでの内容でPHPの名前空間の使い方は理解できたのではないかと思います。 なぜ名前空間が必要なのか？ 1. 名前の衝突を防ぐ 2. プレフィックス地獄を防ぐ 3. グローバル空間の汚染を防ぐ -> 小規模な個人開発レベルであれば、なくてもどうにかなります。 大規模プロジェクトなどでは「チーム開発で名前の調整が必要」「サードパーティライブラリとの競合」「コード の可読性低下」などの負担を下げるためにも、名前空間が必要です。 最初の方に小出ししましたが、 PHP5.3（2009年）PHPには名前空間が追加されています。 これはSymfony、Zendなど大規模フレームワークの登場により、必要不可欠になったからだそうです。 名前空間をよく理解して、良い開発体験を！！ まとめ