SymfonyStopwatch组件_代码执行时间分析【技巧】

1次阅读

Stopwatch::start() 后必须显式调用 stop() 才能获取正确耗时,否则 getDuration() 返回 0;需用 try/finally 确保异常路径下 stop 执行;section 与 event 需区分使用以支持嵌套分析;生产环境默认禁用,须检查 isEnabled() 并合理配置启用开关。

SymfonyStopwatch 组件_代码执行时间分析【技巧】

Stopwatch::start() 之后必须调用 stop() 才能拿到耗时

很多人以为 Stopwatch::start() 一调用,时间就自动记完了,结果 getSectionDuration()getEvent()->getDuration() 返回 0。其实 Stopwatch 是“手动计时器”——不显式 stop(),它就一直跑着,事件状态还是 started

常见错误现象:var_dump($stopwatch->getEvent('api_call')->getDuration()) 输出 0,但日志里明明看到请求花了 300ms。

  • 必须成对使用:start() → 执行逻辑 → stop()
  • 如果逻辑可能抛异常,务必用 try/finally 包裹 stop(),否则异常路径下计时永远悬空
  • 不推荐依赖析构函数或作用域自动结束:Symfony 没有为 StopwatchEvent 实现自动 stop 行为

section 和 event 的区别直接影响嵌套分析能力

section 是命名的计时上下文(比如 'controller'),event 是该 section 内的具体动作(比如 'db_query')。混淆二者会导致 getSectionDuration() 返回 null 或统计错层。

使用场景:想看整个控制器里 DB 查询总耗时?得先 openSection('controller'),再在 DB 调用前后用 start('db_query')/stop('db_query'),最后用 getSectionDuration('controller', 'db_query') 提取子事件总和。

  • start('foo') 默认绑定到当前 section;没 open 过 section 就直接 start,会落在默认匿名 section 里
  • getEvent('foo') 只返回最近一次同名 event,不是累计值;要累计请用 getSectionEvents() + 循环 sum
  • section 名建议用字符串字面量,避免变量拼接导致 name 不一致(比如 $s = 'api'; $sw->start($s.'_call') 容易漏掉下划线)

生产环境默认不启用 Stopwatch,$enabled 参数别忽略

Symfony 的 Stopwatch 在非 debug 模式下默认是 disabled 的——不是“不记录”,而是 isStarted() 始终返回 false,所有 start() 调用静默失败,后续 getDuration() 全是 0。

性能影响:启用后每个 start() 都触发 microtime(true) 调用,高频打点(如循环内)会有可观开销;但单次 HTTP 请求中几十次调用基本无感。

  • 构造时传 true 强制启用:new Stopwatch(true)
  • 检查是否生效:var_dump($stopwatch->isEnabled()),别只信配置文件
  • 不要在生产代码里硬编码 new Stopwatch(true),应通过容器参数或环境变量控制开关

日志输出格式不统一,dump() 和 getEvents() 返回结构差异大

dump($stopwatch) 显示的是美化后的树形结构(含颜色、缩进),而 $stopwatch->getEvents() 返回的是扁平数组,每个元素是 StopwatchEvent 对象,没有嵌套关系。想导出为 JSON 或上报监控系统,直接 dump 会失败。

容易踩的坑:用 json_encode($stopwatch->getEvents()) 报错“Object of class StopwatchEvent is not JSON serializable”。

  • 提取可用字段示例:['name' => $e->getName(), 'duration' => $e->getDuration(), 'category' => $e->getCategory()]
  • getEvent() 返回单个对象,getSectionEvents() 返回该 section 下所有同名 event 数组(注意不是全部 event)
  • 如果需要带层级的原始数据,得自己遍历 getSections() + getSectionEvents() 拼装

真正难的不是怎么打点,是怎么确保每次 start 都有对应的 stop,且名字写对、section 套对、环境开对——漏一个,整条链路的时间就断了。

text=ZqhQzanResources