如何优雅地为业务Method收集运行各步骤的调试信息

方案1：轻量调试上下文封装（侵入性极低，改造成本最小） #

不用额外加引用参数，而是在类里封装一个私有调试开关和调试数据容器，再做一个单行动态记录的辅助方法，原有业务逻辑只需要每行后面加一行短调用即可，不会大幅增加代码量：

class YourClass
{
    // 调试开关，可通过配置、方法入参动态控制
    private bool $debugEnabled = false;
    private array $debugData = [];

    // 封装单行调试记录方法
    private function debugRecord(string $step, mixed $data): void
    {
        if ($this->debugEnabled) {
            $this->debugData[$step] = $data;
        }
    }

    // 对外提供获取调试数据的方法，调试模式下调用
    public function getDebugData(): array
    {
        return $this->debugEnabled ? $this->debugData : [];
    }

    // 对外提供开关调试模式的方法
    public function setDebugEnabled(bool $enable): void
    {
        $this->debugEnabled = $enable;
        // 每次开启前清空历史调试数据
        if ($enable) $this->debugData = [];
    }

    // 原业务方法改造后：每步只加1行短调用，几乎不影响原有代码可读性
    public function foo(array $ids)
    {
        $foos = $this->getAllFoos($ids);
        $this->debugRecord('get_all_foos', $foos);

        $foos = $this->sortAllFoos($foos);
        $this->debugRecord('sort_all_foos', $foos);

        $filteredFoos = $this->filterOutsomeFoo($foos);
        $this->debugRecord('filter_foo', $filteredFoos);

        return $filteredFoos;
    }
}

调用方式：

// 正常业务调用，调试模式关闭，无额外性能损耗
$obj = new YourClass();
$result = $obj->foo([1,2,3]);

// 调试场景调用
$obj->setDebugEnabled(true);
$result = $obj->foo([1,2,3]);
$stepData = $obj->getDebugData(); // 直接拿到所有步骤的完整数据

• 优点：改造工作量极小，原有逻辑无感知，调试逻辑和业务逻辑完全解耦，关闭调试模式时无额外性能开销
• 适用场景：中小项目，改造周期短的场景

方案2：事件/钩子机制（解耦程度更高） #

在每一步执行完成后触发对应步骤的事件，调试场景下注册事件监听器收集数据，正常场景下无监听器则不会执行额外逻辑，完全不侵入业务核心逻辑：

// 事件定义（可复用）
class StepExecutedEvent
{
    public function __construct(public string $stepName, public mixed $stepData) {}
}

// 业务方法改造
public function foo(array $ids)
{
    $foos = $this->getAllFoos($ids);
    event(new StepExecutedEvent('get_all_foos', $foos)); // 触发事件

    $foos = $this->sortAllFoos($foos);
    event(new StepExecutedEvent('sort_all_foos', $foos));

    $filteredFoos = $this->filterOutsomeFoo($foos);
    event(new StepExecutedEvent('filter_foo', $filteredFoos));

    return $filteredFoos;
}

调试场景下提前注册监听器即可收集所有步骤数据：

$debugData = [];
Event::listen(StepExecutedEvent::class, function (StepExecutedEvent $event) use (&$debugData) {
    $debugData[$event->stepName] = $event->stepData;
});

$result = $obj->foo([1,2,3]);
// $debugData 就是所有步骤的数据

• 优点：调试逻辑完全和业务代码分离，后续可以扩展更多监听逻辑（比如日志上报、数据校验等）不需要修改业务方法
• 适用场景：中大型项目，本身有事件机制的框架（比如Laravel、Symfony）

方案3：AOP切面编程（零侵入业务代码） #

如果完全不想修改原有业务方法，可以用AOP切入业务方法的执行流程，在每一行代码执行完成后抓取变量，不需要改动原有foo方法的任何代码：
以PHP的Go!AOP扩展为例，只需要定义一个切面，匹配foo方法的执行步骤，抓取中间变量即可。

• 优点：零侵入原有业务代码，完全不需要改动原有方法
• 缺点：需要引入AOP扩展/组件，有一定学习成本，小项目用起来过重

方案4：管道模式重构（适合逻辑步骤较多的复杂方法） #

如果你的业务方法本身步骤很多，可以把每个步骤拆成独立的管道类，用管道模式串联执行，调试的时候直接在管道中间加入数据记录的节点即可：

// 管道调用示例
public function foo(array $ids)
{
    return pipeline($ids)
        ->through([
            GetAllFoos::class,
            SortAllFoos::class,
            FilterOutSomeFoo::class,
        ])
        ->thenReturn();
}

调试场景下直接给管道加一个全局中间件，每个管道执行完成后记录数据即可，不需要修改单个管道的逻辑。

• 优点：代码结构更清晰，后续新增/调整步骤不需要改主方法，调试逻辑可插拔
• 缺点：需要重构原有业务方法，改造工作量较大

内容的提问来源于stack exchange，提问作者Martijn