如何识别调用的控制器和方法？

哈喽！今天心血来潮给大家带来了《如何识别调用它的控制器和方法》，想必大家应该对文章都不陌生吧，那么阅读本文就都不会很困难，以下内容主要涉及到，若是你正在学习文章，千万别错过这篇文章~希望能帮助到你！

动态获取调用方信息的挑战

在复杂的应用中，我们常常会创建通用的助手函数来处理重复逻辑，例如日志记录、数据格式化等。当这些助手函数被多个控制器或服务调用时，有时需要知道具体是哪个控制器和方法触发了该助手函数，以便进行更精确的日志记录或错误追踪。直接通过参数传递虽然可行，但会增加函数的签名复杂性，且可能在调用链深层时变得冗余。PHP的debug_backtrace函数提供了获取程序执行堆栈信息的能力，但原始的debug_backtrace操作起来相对繁琐，尤其是在解析堆栈帧以识别控制器和方法时。

解决方案一：在助手函数中直接使用 Spatie/Backtrace

为了简化堆栈追踪的复杂性，我们可以利用 spatie/backtrace 这个强大的PHP库。它封装了debug_backtrace的细节，提供了更易于使用的API来导航和解析调用堆栈。

1. 安装 Spatie/Backtrace

首先，通过 Composer 将 spatie/backtrace 安装到您的 Laravel 项目中：

composer require spatie/backtrace

2. 修改助手函数

假设我们有一个 logDatabaseError 助手函数，用于记录数据库查询异常。我们可以在其中集成 spatie/backtrace 来获取调用方的控制器和方法。

// helpers.php
use Spatie\Backtrace\Backtrace;
use Spatie\Backtrace\Frame as SpatieBacktraceFrame;
use Illuminate\Support\Facades\Storage;
use Illuminate\Support\Facades\Auth;

if (!function_exists('logDatabaseError')) {
    function logDatabaseError (\Illuminate\Database\QueryException $exception) {
        // 创建一个回溯实例
        $backtrace = Backtrace::create();

        // 过滤回溯帧，找到第一个继承自 App\Http\Controllers\Controller 的类
        $controllerResponsible = collect($backtrace->frames())
            ->filter(function (SpatieBacktraceFrame $frame) {
                return (bool) $frame->class; // 确保帧有类名
            })
            ->filter(function (SpatieBacktraceFrame $frame) {
                // 检查该类是否是控制器或其子类
                return is_subclass_of($frame->class, \App\Http\Controllers\Controller::class);
            })
            ->first(); // 获取第一个匹配的控制器帧

        $log_string = "TIME: " . now()->toDateTimeString() . PHP_EOL;
        $log_string .= "User ID: " . (Auth::check() ? Auth::user()->id : 'Guest') . PHP_EOL;

        if ($controllerResponsible) {
            $log_string .= "Controller->Action: " . $controllerResponsible->class . "->" . $controllerResponsible->method . PHP_EOL;
        } else {
            $log_string .= "Controller->Action: Not found or not a Controller method" . PHP_EOL;
        }
        $log_string .= "Exception: " . $exception->getMessage() . PHP_EOL;
        $log_string .= "File: " . $exception->getFile() . " Line: " . $exception->getLine() . PHP_EOL;
        $log_string .= "Trace: " . $exception->getTraceAsString() . PHP_EOL; // 包含完整的异常堆栈

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

3. 控制器中的调用示例

在控制器中，您只需像往常一样调用助手函数，无需传递额外的参数：

// 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('my_unavailable_table')->get();
        }
        catch (QueryException $exception) {
            logDatabaseError($exception); // 助手函数会自动识别调用方
            return response()->json(['error' => 'Database operation failed.'], 500);
        }
        return response()->json(['message' => 'Data written successfully.']);
    }
}

注意事项：

• 控制器继承： 您的控制器必须继承自 App\Http\Controllers\Controller，以便 is_subclass_of 函数能够正确识别。
• 性能考量： 频繁地在运行时生成和解析完整的堆栈回溯可能会带来轻微的性能开销。对于非性能敏感的错误日志场景，这通常不是问题。

解决方案二：高级全局异常处理（推荐）

对于更系统化的错误追踪，尤其是在 Laravel 应用中，将控制器和方法信息集成到全局异常处理机制中是更优雅和推荐的做法。这样可以避免在每个 try-catch 块中重复调用回溯逻辑，并与 Laravel 强大的日志系统无缝集成。

1. 安装 Spatie/Backtrace (如果尚未安装)

composer require spatie/backtrace

2. 修改 app/Exceptions/Handler.php

我们将修改 Laravel 的异常处理器，以便在报告异常时捕获控制器和方法信息，并将其添加到日志上下文中。

// 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;

class Handler extends ExceptionHandler
{
    /**
     * 用于在 reportable 闭包和 context 方法之间传递控制器信息。
     * @var SpatieBacktraceFrame|null
     */
    public $controllerResponsible = null;

    /**
     * 不应报告的异常类型列表。
     *
     * @var array>
     */
    protected $dontReport = [
        //
    ];

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

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

            // 过滤回溯帧，找到第一个继承自 App\Http\Controllers\Controller 的类
            $controllerResponsible = collect($backtraceInstance->frames())
                ->filter(function (SpatieBacktraceFrame $frame) {
                    return (bool) $frame->class;
                })
                ->filter(function (SpatieBacktraceFrame $frame) {
                    return is_subclass_of($frame->class, \App\Http\Controllers\Controller::class);
                })
                ->first();

            $this->controllerResponsible = $controllerResponsible; // 将结果存储到实例属性中
        });
    }

    /**
     * 获取用于日志记录的默认上下文变量。
     *
     * @return array
     */
    protected function context()
    {
        $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);
    }
}

3. 控制器中的调用示例

使用这种方法，您可以从控制器中移除冗余的 try-catch 块，让异常自动冒泡到全局异常处理器。

// 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) {
        // 直接执行数据库操作，无需 try-catch 捕获 QueryException
        // 任何 QueryException 将被全局异常处理器捕获并处理
        DB::table('my_unavailable_table')->get();

        return response()->json(['message' => 'Data written successfully.']);
    }
}

4. 日志输出示例

当发生 QueryException 时，Laravel 的默认日志（例如 storage/logs/laravel.log）将自动包含 controller 和 method 信息：

[2023-10-27 10:30:00] local.ERROR: SQLSTATE[42S02]: Base table or view not found: 1146 Table 'your_database.my_unavailable_table' doesn't exist (Connection: mysql, SQL: select * from `my_unavailable_table`) {"exception":"[class]","file":"[path]","line":123,"controller":"App\\Http\\Controllers\\BestControllerEver","method":"writeStuffToDatabase","controller@method":"App\\Http\\Controllers\\BestControllerEver@writeStuffToDatabase"}

这种高级解决方案的优势：

• 代码整洁： 控制器代码更简洁，无需为每个潜在的异常编写 try-catch 块。
• 集中管理： 所有异常处理逻辑集中在 Handler.php 中，易于维护和扩展。
• 与Laravel日志系统集成： 自动将关键信息注入到 Laravel 的默认日志上下文，与现有日志工具无缝配合。

总结

无论是直接在助手函数中利用 spatie/backtrace 进行即时回溯分析，还是通过修改 Laravel 的全局异常处理器来实现更统一、自动化的日志增强，这两种方法都有效地解决了从助手函数内部获取调用方控制器和方法的需求。对于简单的、局部性的追踪需求，方案一足够；而对于需要全面、系统化错误追踪和日志记录的生产环境，方案二无疑是更健壮和推荐的选择，它能显著提升应用的可维护性和错误排查效率。请务必确保您的控制器正确继承了 Laravel 的基类控制器，以便回溯机制能准确识别。

到这里，我们也就讲完了《如何识别调用的控制器和方法？》的内容了。个人认为，基础知识的学习和巩固，是为了更好的将其运用到项目中，欢迎关注golang学习网公众号，带你了解更多关于的知识点！