PHPのspl_autoload_register()で実現するクラスの自動読み込み(オートロード)入門
はじめに
PHPでは、別のスクリプトファイル内で定義されたクラスを利用する際、従来は include や require 文を使ってファイルを明示的に読み込む必要がありました。
しかし、PHPにはオートロード(自動読み込み)という便利な仕組みが備わっています。この機能を利用すると、明示的な読み込み文を書かなくても、クラスが実際に使用されるタイミング(インスタンス生成時など)で、PHPがそのクラス定義ファイルを自動的にロードしてくれます。
自動読み込みを実現するには、spl_autoload_register() 関数を使います。この関数に登録したコールバックは複数個設定でき、PHPパーサーはエラーを発生させる前に、登録済みのすべてのオートローダーに対してクラスやインターフェースを読み込む最後のチャンスを与えます。
基本構文
spl_autoload_register(function ($class_name) {
include $class_name . '.php';
});この例では、クラス名と同じ名前の .php ファイルを探して読み込むシンプルなオートローダーを登録しています。クラスが初めて使用されるときに、対応する .php ファイルから自動的にロードされます。
オートロードの使用例
次の例では、2つのクラス(test1 と test2)をオートローダーに登録し、それぞれのインスタンスを生成しています。
サンプルコード
<?php
spl_autoload_register(function ($class_name) {
include $class_name . '.php';
});
$obj = new test1();
$obj2 = new test2();
echo "objects of test1 and test2 class created successfully";
?>実行結果
上記のコードを実行すると、次のような出力が得られます。
objects of test1 and test2 class created successfully
ファイルが見つからない場合のエラー
一方、対応するクラス定義を含む .php ファイルが存在しない場合は、次のような警告および致命的エラーが表示されます。
Warning: include(): Failed opening 'test10.php' for inclusion (include_path='C:\xampp\php\PEAR') in line 4 PHP Fatal error: Uncaught Error: Class 'test10' not found
このように、オートローダーのデフォルト動作では未定義クラスへのアクセス時にエラーが発生するため、実運用では次に紹介する例外処理との組み合わせが有効です。
例外処理を組み合わせたオートロード
オートローダーの中でファイルの存在を事前にチェックし、見つからない場合に例外をスローすることで、より安全で扱いやすいエラーハンドリングが可能になります。
サンプルコード
<?php
spl_autoload_register(function($className) {
$file = $className . '.php';
if (file_exists($file)) {
echo "$file included\n";
include $file;
} else {
throw new Exception("Unable to load $className.");
}
});
try {
$obj1 = new test1();
$obj2 = new test10();
} catch (Exception $e) {
echo $e->getMessage(), "\n";
}
?>実行結果
このコードでは、test10.php が存在しないため、catch ブロックで捕捉された例外メッセージが出力されます。
Unable to load test10.
このように file_exists() による存在確認と try-catch 構文を組み合わせることで、存在しないクラスファイルを読み込もうとした際の挙動を柔軟に制御できます。
まとめ
- spl_autoload_register() を使うと、include / require 文なしでクラスを自動的に読み込める
- オートローダーは複数登録可能で、クラス使用時に順番に呼び出される
- 例外処理と組み合わせれば、ファイル不在時のエラーも安全にハンドリングできる
大規模なプロジェクトでは、さらにPSR-4規約に準拠したComposerのオートローダーを利用するのが一般的ですが、その基礎となるのが本記事で紹介した spl_autoload_register() の仕組みです。ぜひ理解しておきましょう。
-
PHPのget_class_methods()関数とは?使い方をわかりやすく解説
get_class_methods()関数の概要PHPのget_class_methods()関数は、指定したクラスに定義されているメソッド名の一覧を取得するための関数です。引数に渡されたクラス(name_of_class)に定義されたすべてのメソッド名を配列として返し、エラーが発生した場合はNULLを返します。構文get_class_methods(class)パラメータname_of_class − メソッド名を取得したいクラス名を文字列またはオブジェクトで指定します。必須パラメータです。戻り値get_class_methods()関数は、name_of_c
-
PHPのclass_exists()関数とは?使い方とサンプルコードをわかりやすく解説
概要PHPのclass_exists()関数は、指定したクラスがすでに定義されているかどうかをチェックするための関数です。クラスが定義済みであればTRUEを、未定義であればFALSEを返します。プラグインの読み込みや条件分岐によるクラスの動的な利用など、柔軟なプログラミングに役立ちます。構文class_exists(class, autoload)パラメータclass − 存在を確認したいクラスの名前。autoload − デフォルトでオートロード機構(__autoload / spl_autoload_call)を呼び出すかどうか。省略した場合のデフォルト値はTRUE