記事の内容
この記事では、PHPの例外処理について説明します。
PHPのバージョンは、7系です。
Exceptionとは何か?
プログラムの実行中に発生するエラーのことを例外といいます。
PHPでは、この例外をExceptionクラスで扱います。
Exceptionは例外の内容を表すメッセージや、プログラムのどこで例外が発生したかなどの情報を持ちます。
具体的には、こういったことが例外と言われます。
- データベースに接続ができない
- Web APIにアクセスできない
- ファイルシステムのI/Oエラー
Exceptionの種類
定義済みの例外
Exception
すべてのユーザー例外の基底クラスとなります。
ErrorException
エラー例外です。
Error
PHPのすべての内部エラーの基底クラスです。
ArgumentCountError
ユーザー定義の関数あるいはメソッドに渡された引数が少なすぎる場合にスローされます。
ArithmeticError
数学的な操作でエラーが発生した場合にスローされます。
AssertionError
assert()によるアサーションが失敗したときにスローされます。
DivisionByZeroError
数値をゼロで割ろうとした場合にスローされます。
CompileError
コンパイルエラーが起きた時にスローされます。
ParseError
eval()を呼んだときなどのPHPコードのパースに失敗した場合にスローされます。
TypeError
TypeError がスローされるのは、以下の三つの場合です。
まず、関数に渡された引数の型が、関数の宣言時に指定された型と一致しない場合。
次に、関数の戻り値の型が、関数の宣言時に指定された型と一致しない場合。
そして、PHP 組み込みの関数に渡す引数の数を間違えた場合 (これは、strict モードの場合に限ります)。
Standard PHP Library(SPL)例外
BadFunctionCallException
未定義の関数をコールバックが参照したり、引数を指定しなかったりした場合にスローされる例外です。
BadMethodCallException
未定義のメソッドをコールバックが参照したり、引数を指定しなかったりした場合にスローされる例外です。
DomainException
定義したデータドメインに値が従わないときにスローされる例外です。
InvalidArgumentException
引数の型が期待する型と一致しなかった場合にスローされる例外です。
LengthException
長さが無効な場合にスローされる例外です。
LogicException
プログラムのロジック内でのエラーを表す例外です。
この類の例外が出た場合は、自分が書いたコードを修正すべきです。
OutOfBoundsException
値が有効なキーでなかった場合にスローされる例外です。
これは、コンパイル時には検出できないエラーです。
OutOfRangeException
無効なインデックスを要求した場合にスローされる例外です。
これは、コンパイル時に検出しなければなりません。
OverflowException
いっぱいになっているコンテナに要素を追加した場合にスローされる例外です。
RangeException
プログラムの実行時に範囲エラーが発生したことを示すときにスローされる例外です。
通常は、アンダーフローやオーバーフロー以外の計算エラーが発生したことを意味します。
RuntimeException
実行時にだけ発生するようなエラーの際にスローされます。
UnderflowException
空のコンテナ上で無効な操作 (要素の削除など) を試みたときにスローされる例外です。
UnexpectedValueException
いくつかの値のセットに一致しない値であった際にスローされる例外です。
これが発生する例としては、ある関数が別の関数をコールしていて、 その関数の返り値が特定の型や値である (そして計算やバッファ関連のエラーがない) ことを想定している場合があります。
Exceptionの使用方法
例外を投げるには、「throw」というキーワードを使います。
そして、その例外を捕捉するには、例外が投げられるコードをtryブロックで囲み、それに対応するcatchブロックを記述します。
そして、finallyは、例外が起きても起きなくても、必ず実行されます。
なお、tryの中にある「throw」が発生した場合、「throw」以降のプログラムは読み込まれません。
では、実際に例を見ていきたいと思います。
基本的なtryの使い方
ネストしたtryの使い方
tryは、ネストして使うこともできます。
一度、catchした例外を改めてthrowする時もあります。
一度、例外を補足した上で、何からの修正を施した上で、さらにプログラムを実行したい時に使います。
その時には、tryをさらにtryで囲ってやります。
独自の例外クラスを作成する方法
既存の例外クラスを継承して、独自の例外クラスを作成することもできます。
Exceptionクラスを継承
別のクラスを継承
上記で説明したように、例外クラスはException以外にも多くあります。
そして、その他のクラスを継承して、独自の例外クラスを作成することができます。
ここでは、LogicExceptionを継承して独自の例外クラスを作成しています。
複数の例外クラスを扱う場合には、catchを書く際に必ず子供の例外クラスから書くようにしましょう。
そうしないと、全ての例外を親例外クラスである「Exception」がcatchしてしまうので、細かく例外処理を記述する意味がなくなってしまいます。