責務を分離するための例外設計 - PHPカンファレンス 2024

PHPカンファレンス 2024での登壇資料です。
https://fortee.jp/phpcon-2024/proposal/ac2fa6f2-588f-4faa-a0e2-35e4d8d9f808

Transcript

1. 責務を分離するための 例外設計 梶川 琢馬 @kajitack PHPカンファレンス2024
2. 梶川 琢馬 (Takuma Kajikawa) バックエンドとフロントエンド半々ぐらい。 新卒の頃からPHPにはお世話になってます！ 趣味はトライスロン。 来年オーストラリアのIRONMANレースに出る予定！ 株式会社 TechBowl プロダクトエンジニア @kajitack
3. 業界最強のメンター陣が
 ありとあらゆる お悩みにお答えします。 大手上場企業やベンチャー企業の最前線で活躍している 60社140名以上のトップエンジニアが在籍。 キャリアのことも、技術のことも、まとめて相談できます。 あなたのロールモデルがきっと見つかります。
5. 複数のサービス、無数のクラスの ルールがある A 面談予約を作るときは引数は〇〇とXXが必H A 面談予約をキャンセルする場合は開始前である必要 こういったルールを違反した場合に例外処理を行いたい。 ドメインモデル図 オブジェクトに対する制約
6. 例外処理の方針は 決まったものが特にないので、 チームで話し合いました...! ※例外の使い方は各プロジェクトやライブラリによって違うのであくまでも参考に
7. 21 PHPの例外の型を分類してみ 1 カスタム例外の設Æ Ç1 例外でコードの責務を表現する 今日話すこと
8. PHPの例外の型を分類してみる
9. ) 実装や技術的な問題で起きる例外（技術的な例外 #) ユースケースで想定できる例外（ドメイン例外） エラーの種類
10. 実装や技術的な問題で起きる例外 ユーザーが通常のユースケースとして回避できないエラー。HTTPステータスでいう500系 起きる原 p バr p DBや外部APIなどの接続エラy p データの不整合 対処方) p 個別でcatchせずにFWや共通のハンドラーでcatchするd p プロトコルに対応したエラーコードを返すd p ユーザーに詳細なメッセージは見せないd p 「運営に連絡してください」「アクセスが集中しています。しばらくお待ち下さい」
11. ユースケースで想定できる例外 クライアント側の問題。HTTPステータスでいう400系 起きる原s s ライブラリ特有の制約違t s アプリケーション特有の制約違t s (例) 予約する際の件数制限を超えていた 対処方B s 例外をcatchする場合もある“ s catchしない場合はFWや共通のハンドラーでcatchする。（技術的な例外と同じ扱いT s プロトコルに対応したエラーコードや独自のエラーコードを返す“ s ユーザーに詳細なメッセージを返す“ s (例) 「予約可能な件数を超えています」
12. PHPの例外の型 Throwable RuntimeException 独自例外 LogicException Error Exception 他にもこれらを継承したクラスがたくさん定義されている。 throwできるクラスのinterface
13. PHP内部で投げるErrorと開発者が投げるException Throwable RuntimeException 独自例外 LogicException Error PHPが内部で投げるエラー throwできるクラスのinterface アプリケーションで投げる例外 Exception
14. 技術的な例外と想定可能な例外 Throwable RuntimeException 独自例外 LogicException Error throwできるクラスのinterface 技術的な例外 Exception 想定可能な例外
15. Error 戻り値がintではなくfloatのときにPHPが投げる function int int : int return + ( $a, $b) { $a $b; } ( , ); add add PHP_INT_MAX 1 TypeError 0除算のときにPHPが投げる function int int : int return / ( $a, $b) { $a $b; } ( , ); divide divide 10 0 DivisionByZeroError 直接throw文を書くことがないが、PHP内部で投げるオブジェクト。 「PHPの使い方を間違っている実装ミス」を表す。
16. LogicException コードのロジックに問題があるときに投げる例外。 与えられた引数の条件を満たしてない場合など。 投げられた場合、ロジックの修正が必要だと判断できる。 RutimeException 実行時に予期せぬエラーが発生した場合に投げる例外。 実装が正しくても起きてしまう。 投げられた場合、一時的な障害やデータの不整合が発生し たと判断できる。 ( $reservationId) { ($reservationId ) { ( ); } $reservation :: ($reservationId); ($reservation ) { ( ); } public function int : void if < throw new = if === throw new if === throw new cancelReservation find 1 LogicException Reservation null RuntimeException RuntimeException "IDは1以上である必要があります" "予約が見つかりませんでした。" "すでにキャンセルされています。" // DBからfetchする ($reservation->status 'canceled') { ( ); }
17. 技術的な例外の分類まとめ Error 直接throw文を書くことがないが、PHP内部で投げるオブジェクト。 投げられた場合、ロジックの修正が必要だと判断できる。 LogicException コードのロジックに問題があるときに投げる例外。 投げられた場合、ロジックの修正が必要だと判断できる。 RutimeException 実行時に予期せぬエラーが発生した場合に投げる例外。 投げられた場合、一時的な障害やデータの不整合が発生したと判断できる。
18. GF 例外はcatchしたいものとそうでないものがあ3 F Error/LogicException/RuntimeException はcatchしな ÇF catchしたい場合はカスタム例外を使う PHPの例外の型を分類してみる
19. カスタム例外の設計
20. カスタム例外 通常のユースケースにおいて想定される例外。 呼び出し側で必ず処理するかどうかを判断してほしい ( $reservationId) { $reservation :: ($reservationId); ($reservation ) { ( ); } public function int : void = if === throw new if === throw new cancelReservation find // DBからfetchする Reservation null CouldNotFoundReservation InvalidReservationStatus "予約が見つかりませんでした。" "すでにキャンセルされています。" ($reservation['status'] 'canceled') { ( ); }
21. カスタム例外の設計 S Exceptionを継承す7 S 名前はどのようなケースで起きるかを表A S エラーのメッセージを内部で組み立てるようにす7 S factoryメソッドで生成する final class extends private function string parent:: public static function : return new self -> { ( $message, ) { ($message); } ( $reservationId ) { ( $reservationId ); } } CouldNotFindReservation __construct withId value Exception __construct ReservationId CouldNotFindReservation "予約が見つかりませんでした。ID: { ()}"
22. なぜカスタム例外はExceptionを継承するのか？ B 呼び出され方によって変わるので想定内の例外なのか判断できなV B PHPStormのInspectionでRuntimeExceptionとLogicExceptionを無€ B 無視したいライブリラリの例外も追加できるので便利
23. 必要なカスタム例外は事業ごとに違うので、 チームで議論しながら決める ドメインモデル図 オブジェクトに対する制約
24. カスタム例外のハンドリング ‰ ビジネスロジックを扱う場所でカスタム例外を投げU ‰ 呼び出したユースケース側で表示の仕方を決めU ‰ 対象のオブジェクトが存在しない場t ‰ ルーティングのIDが間違っている→ステータスコードを404のエラーにして返 ‰ データの不整合→ロジックのエラーなので処理しない
25. ライブラリで定義されてるカスタム例外の扱い 3 想定可能であれば、カスタム例外で投げ直すF 3 技術的な例外であればLogicException、RuntimeExceptionなどで投げ( 3 必要な例外をより明確にできる
26. 例外で責務を分離する
27. I 問題がある場合は早く例外を投げて処理を中断すE I メソッド内で解決できない例外は呼び出し側に任せE I 呼び出し側に処理してもらいたい例外は仕様として定義する どこまで責任を持つべきかを例外で表す
28. ( $reservationId) { ($reservationId ) { ( ); } $reservation :: ($reservationId); ($reservation ) { ( ); } public function int : void if < throw new = if === throw new if === throw new cancelReservation find 1 LogicException Reservation null RuntimeException RuntimeException "IDは1以上である必要があります" "予約が見つかりませんでした。" "すでにキャンセルされています。" // DBからfetchする ($reservation->status 'canceled') { ( ); } 問題がある場合は早く中断する Î DBに問い合わせる前にIDのチェックしておµ Î 取得したオブジェクトを操作する前にチェックする
29. 引数自身が例外を投げることでより早く中断できる Before After public function int 　 　 if < throw new ( $reservationId) { ($reservationId ) { 　 　 ( ); } ... cancelReservation 1 LogicException "IDは1以上である必要があります" class public function int if <= throw new -> = { ( $value) { ($value ) { ( ); } value $value; } ReservationId __construct 0 InvalidArgumentException $this "IDは1以上である必要があります。" public function ( $reservationId) { } cancelReservation ReservationId 　 　 // IDのチェックが不要になった W IDがロジック違反かどうかはID自身でチェックすI W IDのコンストラクタが呼ばれた段階で処理を中断できる
30. IDが入力値やルーティングから与えられた場合、 クライアントエラー（想定内の例外）では？ class public function int if <= throw new -> = { ( $value) { ($value ) { ( ); } value $value; } ReservationId __construct 0 InvalidArgumentException $this "IDは1以上である必要があります。" 入力値のチェックはバリデーターで行う。 バリデーション実装のミス（バグ）なので、LogicException（InvalidArgumentException）を投げる。
31. 解決できない例外は呼び出し側に任せる S 呼び出し側で処理してほしい例外はPHPDocの @throws で仕様として宣言する /** * */ // 違反) { @throws public function if throw new MyException MyException () { ( (); } } myLogic try catch { (); } ( $e) { } myLogic MyException // 何かしらの処理 /** * */ @throws public function MyException myLogic () { } myLogicCaller 投げる 処理できる場合はcatchする 処理できない場合は更に呼び出し側に任せる
32. 定義した例外を投げることをテストする ' 戻り値のチェック等と同様に例外が投げられるかをテストすA ' デバッグ時に例外のBreakPointを貼ることもできる #[ ] () { ( ); (); } Test $this MyException public function : void -> ::class XXの場合_例外を発生させる expectException myLogic
33. S 例外の型を使い分けて必要なときだけハンドリングす# S カスタム例外を投げることを明示して、どういうルールがあるかを伝え# S 責務を分離し、必要な処理に集中することができる まとめ
34. 皆さんのプロジェクトではどうしてるか？ぜひ聞かせてください！ ご清聴ありがとうございました！