如何在PHP助手函数中获取调用它的控制器和方法

composer require spatie/backtrace

// helpers.php

use Spatie\Backtrace\Backtrace;
use Spatie\Backtrace\Frame;
use Illuminate\Support\Facades\Storage;
use Illuminate\Support\Facades\Auth;

function logDatabaseError(\Throwable $exception)
{
    // 创建一个回溯实例
    $backtrace = Backtrace::create();

    // 过滤出负责处理请求的控制器帧
    $controllerResponsible = collect($backtrace->frames())
        ->filter(function (Frame $frame) {
            // 确保帧有类名
            return ($frame->class);
        })
        ->filter(function (Frame $frame) {
            // 检查类是否是App\Http\Controllers\Controller的子类
            // 注意：您的控制器必须继承自 App\Http\Controllers\Controller
            return is_subclass_of($frame->class, \App\Http\Controllers\Controller::class);
        })
        ->first(); // 获取第一个匹配的控制器帧

    $log_string = "时间: " . now()->toDateTimeString() . PHP_EOL;
    $log_string .= "用户ID: " . (Auth::check() ? Auth::user()->id : 'N/A') . PHP_EOL;

    if ($controllerResponsible) {
        $log_string .= "控制器->动作: " . $controllerResponsible->class . "->" . $controllerResponsible->method . PHP_EOL;
    } else {
        $log_string .= "控制器->动作: 未知 (未找到控制器帧)" . PHP_EOL;
    }

    $log_string .= "异常信息: " . $exception->getMessage() . PHP_EOL;
    $log_string .= "堆栈跟踪: " . $exception->getTraceAsString() . PHP_EOL;

    Storage::disk('logs')->append('database.log', $log_string);
}

// App\Http\Controllers\BestControllerEver.php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Support\Facades\DB;
use Illuminate\Database\QueryException;

class BestControllerEver extends Controller
{
    public function writeStuffToDatabase(Request $request)
    {
        try {
            // 模拟一个数据库操作，这里故意触发错误
            DB::table('non_existent_table')->get(); 
        } catch (QueryException $exception) {
            // 直接调用助手函数，无需传递控制器和方法名
            logDatabaseError($exception);
            return response()->json(['error' => '数据库操作失败，已记录日志。'], 500);
        }
        return response()->json(['message' => '数据写入成功。']);
    }
}

composer require spatie/backtrace

// app/Exceptions/Handler.php

namespace App\Exceptions;

use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
use Throwable;
use Spatie\Backtrace\Backtrace as SpatieBacktrace;
use Spatie\Backtrace\Frame as SpatieBacktraceFrame;
use Illuminate\Support\Collection; // 确保引入 Collection

class Handler extends ExceptionHandler
{
    /**
     * 用于存储负责处理请求的控制器帧。
     *
     * @var SpatieBacktraceFrame|null
     */
    public $controllerResponsible = null;

    /**
     * 不应报告的异常类型列表。
     *
     * @var array<int, class-string<Throwable>>
     */
    protected $dontReport = [
        //
    ];

    /**
     * 不应闪存到会话的输入字段列表。
     *
     * @var array<int, string>
     */
    protected $dontFlash = [
        'current_password',
        'password',
        'password_confirmation',
    ];

    /**
     * 注册应用程序的异常处理回调。
     *
     * @return void
     */
    public function register(): void
    {
        $this->reportable(function (Throwable $e) {
            // 为异常创建回溯实例
            $backtraceInstance = SpatieBacktrace::createForThrowable($e);

            // 过滤出负责处理请求的控制器帧
            $controllerResponsible = Collection::make($backtraceInstance->frames()) // 使用 Collection::make 确保兼容性
                ->filter(function (SpatieBacktraceFrame $frame) {
                    return ($frame->class);
                })
                ->filter(function (SpatieBacktraceFrame $frame) {
                    return is_subclass_of($frame->class, \App\Http\Controllers\Controller::class);
                })
                ->first();

            // 将控制器帧存储为类的属性，以便在 context 方法中使用
            $this->controllerResponsible = $controllerResponsible;
        });
    }

    /**
     * 获取用于日志记录的默认上下文变量。
     *
     * @return array<string, mixed>
     */
    protected function context(): array
    {
        $extraContext = [];

        if ($this->controllerResponsible instanceof SpatieBacktraceFrame) {
            $extraContext['controller'] = $this->controllerResponsible->class;
            $extraContext['method'] = $this->controllerResponsible->method;
            $extraContext['controller@method'] = $this->controllerResponsible->class . '@' . $this->controllerResponsible->method;
        }

        // 将自定义上下文与父类的默认上下文合并
        return array_merge(parent::context(), $extraContext);
    }
}

// App\Http\Controllers\BestControllerEver.php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Support\Facades\DB;

class BestControllerEver extends Controller
{
    public function writeStuffToDatabase(Request $request)
    {
        // 模拟一个数据库操作，这里故意触发错误
        // 如果发生 QueryException，它会被全局异常处理器捕获并记录
        DB::table('non_existent_table')->get(); 

        return response()->json(['message' => '数据写入成功。']);
    }
}