PHP Laravel5.5の例外処理共通化 グローバル参照

Question

お世話になります。
この度、初めてLaravelを使用したWebAppを構築しております。
ある機能を作成するなかで、クラスの構成に悩んでしまい、手も足もでなくなってしまったので、相談させてください。

環境

PHP 7.3.4
Laravel 5.5

前提・実現したいこと

以下のような構成で各Controllerへ処理を振り分けています。
予期せぬExceptionの発生時、App\Exceptions\HandlerでそのExceptionをCatchし、
どの機能でエラーが発生したかのログを共通的に出力したいと考えております。
※ログはLaravel標準のログではなく、DBへ登録しています。
このような場合に、どのようなデザインにすれば良いのか、悩んでおります。

↓---------- [2019/5/25 10:30追記] ----------↓

要件が不足していたようなので、追記いたします。
ControllerからthrowするExceptionを、私の中で以下のように分類おり、それぞれ異なる動作としたいと考えています。
そもそも考え方がおかしい的なご指摘でも、助かります。

1. 各Controllerで発生することが予測できるException

　⇒各Controllerでcatchして、Controllerごとに処理を決定する。(画面上にエラーメッセージ表示等)

1. 自作ExceptionA
2. 自作ExceptionB

　⇒各処理ではcatchせず(またはそのままthrowする)、共通動作を動かしたい。
⇒現在はApp\Exceptions\Handlerのrenderで判定し、共通動作としています。

1. それ以外の予期せぬException

　⇒各処理ではcatchせず(またはそのままthrowする)、共通動作を動かしたい。

上記の、2.3.4.のパターンの場合に、どのControllerで発生したExceptionか？の情報が欲しい。

↑---------- [2019/5/25 10:30追記] ----------↑

私の考え

無理やりやるのであれば、セッションを使うなど思いつくのですが、適切でない気がしています。

私には、各ControllerでExceptionを独自Exceptionでラップし、その中にどの機能かの情報を付与するくらいの案しか思いつきませんでした…。

Laravel のような便利なFrameworkを使用した場合のベストプラクティスが知りたいです。お力添えいただいたけると幸いです。

ソース

HogeController.php

class HogeController extends Controller
{
    public function __construct(HogeService $service)
    {
        $this->service = $service;
        $this->functionId = FunctionIdConst::HOGE;
    }
　　：
}

App\Exception\Handler.php

class Handler extends ExceptionHandler
{
    ：
    public function render($request, Exception $exception)
    {
        if ($exception instanceof MyExceptionA) {
            // 処理A
        } elseif ($exception instanceof MyExceptionB) {
            // 処理B
        } else {
            // ★ここで、ログ出力したい。
        }
    }
}

Answer 1

https://readouble.com/laravel/5.8/ja/errors.html

App\Exceptions\Handlerにcontext()書けば発生時のURLでもコントローラーでもなんでも取得できる。

    protected function context()
    {
        return array_merge(parent::context(), [
            'url'        => url()->full() ?? '',
            'controller' => request()->route()->getActionName() ?? '',
        ]);
    }

これを記録すればいい。

    public function report(Exception $exception)
    {
        $context = self::context();

        parent::report($exception);
    }

Comments

[byth_net]

遅くなりましたが、ご教示ありがとうございます。

上記の内容について、調べてみました。
カレントのControllerのインスタンスかクラスが欲しかったのですが、簡単には取れなさそうですね。
やっぱりそもそもそんなものを取ろうとしているのがおかしいんですかね…。
全体の造りをもう少し見直す必要があると猛省しています…。

Answer 2

laravel二カ月目の自分も気になったので作ってみました。

php artisan make:exception MushokuNeetException

use Illuminate\Http\Request;
class MushokuNeetException extends Exception
{

    public $request;
    public $functionName;

    public function __construct(Request $request, $functionName){
            $this->request = $request;//なんとなく
            $this->functionName = $functionName;
    }
    
    public function report(){
        \Log::info('Error:'.$this->functionName);
        //ここで好き放題ログを吐いた方が良さそう
    }
}

public function shukatsu(){
    throw new MushokuNeetException($request, __FUNCTION__);
}

    public function render($request, Exception $exception)
    {
        if($exception instanceof MushokuNeetException){
            Log::error('無色ニートエクスェプション');
　　　　　　 //ここでログを吐くよりも
        }
    }

ラップをするためのものはartisanで作れるらしい
試しに作ったMushokuNeetExceptionではrender実装までは試してないけど、render実装すればそこで処理終わるんでしょうねきっと

Comments

[byth_net]

回答ありがとうございます。参考になります。

Controllerで必ずExceptionをラップして渡すような動きですかね。
そのうえで、ラッパークラスにでreportメソッドを実装ですか、これはFrameworkの仕組みでどこかから呼び出されるのでしょうか？それとも自分で呼び出す必要がある…？

こうなると、report側でもinstanceofで、元のExceptionの種類を判別し、ログ出力するかどうか決める必要がありそうですね。

[hentaiman]

あなたの言うラップの意味が一般的に使われているラップならですけど、Exceptionのラッパーは回答に書いたMushokuNeetException で、これはartisanコマンドから作れます。
各Controllerから吐き出そうとしている例外の種類がすべて同じで、パラメーターだけ違うのであればどのControllerからもMushokuNeetExceptionをthrowしすればよく、その際に必要なパラメーターだけ渡す（MushokuNeetExceptionで受け取れる）ようにすればいいです。
各Controllerから吐き出そうとしている例外の種類がそれぞれ全く違うものなら、その分だけartisan makeでExceptionをラップしたカスタムExceptionを作るのが適切かなと。

>こうなると、report側でもinstanceofで、元のExceptionの種類を判別し、ログ出力するかどうか決める必要がありそうですね。
必ずログを吐かせたいのならその考え方は不適当で、カスタムExceptionを作る段階でログを吐く処理を組み込んでしまうのが適当です。

それともControllerでラップするというのは、結果に応じて処理を分けるif的な意味合いで言ってますか？

[hentaiman]

>そのうえで、ラッパークラスにでreportメソッドを実装ですか、これはFrameworkの仕組みでどこかから呼び出されるのでしょうか？それとも自分で呼び出す必要がある…？
自分で呼ぶ必要は無い

[byth_net]

コメントへの返信ありがとうございます。
要件を追記させていただきました。
今回のケースだと、hentaimanさんのおっしゃる「各Controllerから吐き出そうとしている例外の種類がそれぞれ全く違うもの」に該当するでしょうか。

追記した4.についても、カスタムExceptionを作成し、2.3.4のカスタムExceptionクラスに、reportメソッドを実装し、ログ出力⇒それ以外の画面に返すなどの動作はrenderメソッドに組み込み
…少しイメージが湧いてきました…！

[hentaiman]

追記の要件に対して
> 各Controllerで発生することが予測できるException
完全に主観で回答しますが
・フロント側に対してURLを変えずにエラー画面を表示させたい
・しかも内部的にはエラーとして扱いたい
・ログの内容は大体同じ（そしてでそれを元に後で調査したわけではない）
・さらにエラーの処理が複雑だ
これらの条件が重なるならカスタムExceptionを作ればいいでしょうが、そうでないなら普通にController内でif分岐して必要に応じてログ出力とエラー画面表示用のviewをreturnすれば良いと思います。
ifが複雑になるならModelクラス作って分離すればいい。

今作ろうとしているシステムは本当に該当の処理をExceptionとして実装する必要がありますか？

[byth_net]

> 今作ろうとしているシステムは本当に該当の処理をExceptionとして実装する必要がありますか？
確かに、そもそもExceptionとする必要はないのかもしれません。
そもそもExceptionとして扱おうと思った経緯が、App\Exceptions\Handlerのrenderで共通的に処理したかったがためなので、その考え方がまずかったのかもと思いました。

>これらの条件が重なるならカスタムExceptionを作ればいいでしょうが、そうでないなら普通にController内でif分岐して必要に応じてログ出力とエラー画面表示用のviewをreturnすれば良いと思います。
なるほど、これまで教えていただいた内容を踏まえると、以下のような形が適当だったのかもしません。
　1.　そのまま各Controllerで処理
　2.3.　そもそもExceptionにすべきではなく、異常発生時に各Controllerで処理(またはその内容を共通化する)
　4.　仕方ないので、各Controllerでキャッチしでどの機能で発生したかの情報を付与し、Handlerで処理する

色々な考えを提示していただきありがとうございます。

[mikkame]

遅レスですがMushokuNeetという命名は冗長じゃないでしょうか？