PHPのエラーを理解して適切なエラーハンドリングを学ぼう

Transcript

1. www.bengo4.com PHPのエラーを理解して 適切なエラーハンドリングを学ぶ PHPerKaigi 2022 2022.4.9 namizato
2. 2 2 並里 辰也（ナミザト タツヤ） 自己紹介 弁護士ドットコム株式会社 在籍そろそろ2年 Laravelが好きだったけど2年位あまり追えてない 最近はバスケばかりしてる @namizatork
3. Bengo4.com, Inc. • 一般市民と弁護士を結びつ け、お悩み解決を目指す • 2005年サービス開始 • 利用者数 約1,000万人/ 月 • 累計法律相談数 約100万件 3 弁護士ドットコム というサービス https://www.bengo4.com
4. Bengo4.com, Inc. 弁護士ドットコム Creators’ Blog https://creators.bengo4.com 最新の記事 postcss-preset-envで少し未来のCSSを予習す る デザイナーに優しい HTMLテンプレートの開発方 針をボトムアップで作った話 サービス運用10年以上の重み、弁護士ドットコム のユニットテスト速度改善 弁護士ドットコムサービスのビジネスと共にみるマ イクロサービスの進化 4
5. Bengo4.com, Inc. 目次 • 今回の対象者と話す内容 • エラーについて • エラーハンドリングについて • PHPの例外について • エラーハンドリングを学ぶ • 振り返り 5
6. 今回の対象者と 話す内容 6
7. Bengo4.com, Inc. 今回の対象者と話す内容 • 対象者 ◦ エラーハンドリングという言葉は知ってるけど何をするの？という人 ◦ PHPのエラー？とりあえずいつもググってるよ！という人 • 話す内容 ◦ エラーについて ◦ エラーハンドリングについて ◦ 適切なエラーハンドリング 7
8. Bengo4.com, Inc. （一応）本内容での言葉を統一しておく • エラー（エラー処理） • エラーハンドリング（例外処理） • 例外（Exception） 8
9. エラーについて 9
10. Bengo4.com, Inc. エラーについて 実行中のプログラムが正常に処理を続行できなくなるような問題・事態のこと。 10
11. Bengo4.com, Inc. PHPのエラー • PHPのエラーは大きく分類して、致命的なエラー と 警告・注意 が存在する ◦ 致命的なエラー ▪ 現在の処理を中断する、はよ直せ（怒り） ◦ 警告・注意 ▪ 現在の処理は中断しないけど、直した方がいいよ（ハナホジ） 11
12. Bengo4.com, Inc. PHPの致命的なエラー / 警告・注意 を一部抜粋 • 致命的なエラー ◦ Fatal error（存在しない関数を呼び出すなどで発生） ◦ Parse error（PHPの文法で間違いがあった時などで発生） • 警告・注意 ◦ Warning（存在しないファイルを呼び出した時などで発生） ◦ Notice（定義されていない変数を使用した時などで発生） 12
13. Bengo4.com, Inc. 13 Warning や Notice は php.ini などの設定次第で無視 （いわゆる白い画面のアレを表示しない）することは可能。 バグの発生要因になるので、推奨はしない。
14. エラーハンドリングにつ いて 14
15. Bengo4.com, Inc. エラーハンドリングについて プログラムがエラーを起こした時にすぐに実行を終了せずにあらかじめ用意しておいた 処理を行うこと。 ユーザー操作によって解決できない問題があった場合に対処するための処理。 15
16. Bengo4.com, Inc. PHPのエラーハンドリング 5系から導入された try - catch で記述する。 例外が発生し得る箇所を try {} で囲み、例外が発生した時点で後続する処理は中断 され catch {} で受け取り、例外が発生した時の対応（ハンドリング）を行う。 例外を明示的に（ほとんどはこのケースだと思うが）発生させたい場合は、 該当する箇所で throw を用いる。 16
17. Bengo4.com, Inc. PHPのエラーハンドリング書き方 17
18. PHPの例外について 18
19. Bengo4.com, Inc. 19 実は前述した「PHPのエラー」で紹介した致命的なエラーなどの一部は try - catch で捕捉できません。（方法はあるにはある） ですが、大抵の場合それらを捕捉する必要はありません。 次のページで簡単に PHP の例外について 触れながら説明していきます。
20. Bengo4.com, Inc. PHPの例外（Exception） 5系までは、全ての致命的エラーはエラーハンドリングがで きず処理がそこで中断されてしまいます。 しかし、7系からは Throwable インターフェースが実装さ れ、それを継承した Exception と Error が導入されまし た。そのおかげで致命的エラーの多くが Error をスローす るようになり、捕捉が可能になりました。 右の図（by @ngyuki）は例外の継承関係を図にしたもの です。 20
21. Bengo4.com, Inc. PHPの例外（Exception） しかし、致命的なエラーの全てが Error に実装されたわけ ではないのが現状です。 ですが、先述した通り全てを捕捉する必要はありません。 大抵のエラーはプログラムやFW側が検知してくれているの で、実装者は開発中に起きたエラーを修正するだけで済み ます。そのためそれらをエラーハンドリングする必要はあり ません。 21
22. エラーハンドリングを学 ぶ 22
23. Bengo4.com, Inc. 23 エラーハンドリングというものについては少しは理解できたけど、 必要性は？どういう時に使えばいいの？など疑問が残っていると思います。 なので、一つ一つQ&A方式で説明していきます。
24. Q. エラーハンドリング を使わないとどうなる の？ 24
25. Bengo4.com, Inc. Q. エラーハンドリングを使わないとどうなるの？ 25 Answer 1. エラーの発生箇所や原因の特定が難しくなる 2. エラー発生後も後続の処理が実行されてしまう 3. エラーが起きていることをユーザーが認知できない 詳しい説明は次の質問と繋がるので省きます。
26. Q. エラーハンドリング はどんな時に用いる の？ 26
27. Bengo4.com, Inc. Q. エラーハンドリングはどんな時に用いるの？ 27 Answer 1. エラーの発生箇所や原因の特定をしたい時 2. エラー発生後に後続の処理を中断させて、別の対応をしたい時 3. エラーが起きていることをユーザーに通知したい時
28. Bengo4.com, Inc. エラーの発生箇所や原因の特定をしたい時 28 例外が発生した内容を catch句 で受け取り、メッセージなどをロギングしておけば、 発生箇所や発生日時、原因の特定が容易になる。
29. Bengo4.com, Inc. エラー発生後に後続の処理を中断させて、別の対応をしたい時 29 例外を受け取ったら処理は中断させて、別の対応をしたい時はロギングの時と同様に catch句 の中で行いたい処理を書く。 その際、return をしないと後続してしまうので注意！
30. Bengo4.com, Inc. エラーが起きていることをユーザーに認知したい時 30 こちらも先ほど同様に catch句 で例外を受け取ったら return で呼び出し元かユーザーにエラーを通 知する。 この対応が抜けているとユーザーは処理が問題なく対処されたと認識してしまう。
31. Q. エラーハンドリング を考えるうえで大事な ことは？ 31
32. Bengo4.com, Inc. Q. エラーハンドリングを考えるうえで大事なことは？ 32 Answer 1. 例外を握り潰さない（物理的にではない） 2. エラーハンドリングのスコープは狭く 3. 補足すべき例外とそうでない例外を理解しよう
33. Bengo4.com, Inc. 例外を握り潰さない 33 せっかく例外を throw しても catch句 で何もしなければエラーを無視してるも同然です。 catch句 ではロギングの他にエラーの発生を呼び出し元に伝える、後続処理を行わないために return するなど、要件に応じた対応をしましょう。
34. Bengo4.com, Inc. エラーハンドリングのスコープは小さく 34 様々な例外を全部一つの try {} の中におさめて、catch は全て Exception で拾ってしまっている try {} の範囲が広いと例外が発生した 時の特定が難しくなる。 さらに catch句 は全て Exception で受け取るのではなく、それぞれ適切 な例外クラスを用意して利用しましょ う。
35. Bengo4.com, Inc. 補足すべき例外とそうでない例外 35 • 補足すべき例外 ◦ 例外発生以降も処理が続けられてしまうとデータ不整合など障害に繋がってしまう時 ◦ 例外発生後に呼び出し元やユーザーへの通知、ロギングなどを行いたい時 ◦ 例外発生前に行っている処理や状態をロールバックしたい時 • 補足すべきでない例外 ◦ 開発時に対処できるタイプエラーなどの例外 ◦ 例外が発生しても、その後に回復処理などが行えない時
36. 振り返り 36
37. Bengo4.com, Inc. ここまで学んだエラーハンドリングを振り返る 37 基幹システムにユーザーとポイント情 報をAPIでpostしているが、何らかの エラーになってもユーザーにはポイン トが付与されたままになってしまう。
38. Bengo4.com, Inc. ここまで学んだエラーハンドリングを振り返る 38 基幹システムへのAPIで成功レスポン ス（200）が返ってこなかった場合に、 例外を throw して、 ユーザーに対して付与していたポイン トをロールバック。 その後開発者向けにロギングと通知、 リダイレクトしてユーザーにエラーが あって、ポイントを付与d系なかったこ とを伝える。
39. ご清聴ありがとう ございました。 39