More than 1 year has passed since last update.

【例外処理】専用の例外クラスを作るとエラー後の分岐処理が実装しやすい

Last updated at 2022-07-30Posted at 2022-07-30

1 / 29

CAUTION!

当記事はイベントのLTで発表したものです
システムの開発方針によっては紹介する実装が適さないことがあります
実装例はPHPですが、簡易なコードなのでプログラミング言語を問わずお読みいただけます

※ @error_401さんからコメントを頂きました。ご指摘ありがとうございます！

紹介する実装は保守性が下がる可能性があります
専用の例外クラスを作成する際は、エラーの対象範囲をよく検討してください

自己紹介

Webエンジニア歴4年
主な使用言語はPHP
たまにITイベントにスタッフ参加しています

伝えたいこと

特定エラー専用の例外クラスを作ると、エラー発生後の分岐処理が実装しやすいです！

例外処理とは

プログラムの実行中に発生した問題・エラー（例外）を解決するため処理

例外処理では何を行うのか

ロールバック
画面上へエラーメッセージを表示する
関係者宛にツールやメールで通知する
エラーログに記録する

ロールバック

不安定な状態でデータベースへレコードが保存されるのを防ぐ

画面上へエラーメッセージを表示する

ユーザーへ通知して何かしらの操作を促す

関係者宛にツールやメールで通知する

問題が発生した直後に関係者による何かしらの対応を促す

エラーログに記録する

原因を調査し問題を解決する

結論

次の行動につながる処理を行う
やるべき行動・処理はエラーの種類によって異なる

PHPで例外処理を実装する

基底クラスのみで例外をキャッチする

要件

記事の投稿処理でエラーが発生した場合は画面にエラーメッセージを表示したい

実装

try {
    $article = new Article('hogehoge');
    $article->create();
} catch (Exception $e) {
    return display_message($e->getMessage());
}

return display_message('記事の投稿に成功しました');

解説

エラーの種類を問わず例外が発生した場合は同じ処理を行う
例外は基底クラスによる一律キャッチでOK

要件が追加されたら？

記事のアップロード処理でエラーが発生した場合は担当者へ通知したい
それ以外のエラーはログに記録したい

先述の方法では実装が難しい...

特定エラー専用の例外クラスを追加して例外をキャッチする

実装

try {
    $article = new Article('hogehoge');
    $article->create();
} catch (ArticleUploadException $e) {
    notify_alert($e, debug_backtrace());  # 担当者へ通知
    return display_message($e->getMessage());
} catch (Exception $e) {
    record_log($e, debug_backtrace());    # ログに記録
    return display_message($e->getMessage());
}

return display_message('投稿に成功しました');