Expo Router 集成

编辑页面

通过启用 EAS Observe 的 Expo Router 集成来跟踪每个路由的渲染和交互时间。


For the complete documentation index, see llms.txt. Use this file to discover all available pages.

EAS Observe 为 Expo Router 提供了一个可选集成,用于收集按路由标记的每路由指标(例如 /(tabs)/sessions/[sessionId])。这样你就可以在仪表盘中按路由比较导航性能,而不只是查看应用整体汇总。

前提条件

Prerequisites

3 requirements

1.

Expo SDK 56 或更高版本

Expo Router 集成适用于 SDK 56 及更高版本。在更早的 SDK 上,expo-observe 仍会跟踪应用级指标,但不会发出按路由的导航事件。

2.

应用中已使用 EAS Observe

按照 开始使用 安装 expo-observe 并创建你的第一个 构建。

3.

应用中已安装 Expo Router

该集成在运行时依赖 expo-router。如果未安装该包,集成将静默地不执行任何操作。

1

启用集成

警告 必须在挂载前启用该集成,且不能在运行时切换。应用已挂载后调用 configure(),或在会话中途切换该标志,都会抛出错误。

在任何屏幕挂载之前,于模块作用域中使用 expo-router 集成标志调用 Observe.configure()

src/app/_layout.tsx
import { Observe } from 'expo-observe'; Observe.configure({ integrations: { 'expo-router': true }, });

2

在你的屏幕中调用 useObserve()

使用 useObserve() Hook 获取一个会自动限定到当前路由的 markInteractive。发出的事件会附带该屏幕的路由模式标签。

src/app/(tabs)/index.tsx
import { useObserve } from 'expo-observe'; import { useEffect } from 'react'; export default function Home() { const { markInteractive } = useObserve(); useEffect(() => { markInteractive(); }, [markInteractive]); return (/* 你的屏幕内容 */); }

信息 如果集成被禁用,或者未安装 expo-routeruseObserve() 会回退到全局的 Observe.markInteractive。无论集成状态如何,你都可以保留这个 Hook。

指标

按路由首屏渲染(cold_ttr

衡量内容: 从发出导航动作(例如点击链接)到目标屏幕第一次获得焦点所用的时间。对于应用启动后的第一次聚焦,测量从 JS bundle 加载开始计算,并且事件包含 isAppLaunch: true

在单个会话中,每个屏幕实例最多发出一次。

事件参数:

参数类型描述
routeNamestring路由模式,例如 /(tabs)/sessions/[sessionId]
urlstring该导航解析后的 pathname。
routeParamsobject解析后的路由参数(例如 { sessionId: 'abc' })。
isAppLaunchboolean当以进程启动为基准测量时为 true,后续导航为 false

按路由热渲染(warm_ttr

衡量内容:cold_ttr 相同,但适用于在获得焦点之前已经渲染过的屏幕,通常是因为它们通过 <Link prefetch /> 预加载,或者用户返回到了这些屏幕。

事件参数:

参数类型描述
routeNamestring路由模式,例如 /(tabs)/sessions/[sessionId]
urlstring该导航解析后的 pathname。
routeParamsobject解析后的路由参数(例如 { sessionId: 'abc' })。

按路由可交互时间(tti

衡量内容: 从发出导航动作到在目标屏幕上调用 markInteractive() 的时间。每次导航只记录第一次调用,因此可以安全地多次调用 markInteractive()

事件参数:

参数类型描述
routeNamestring路由模式,例如 /(tabs)/sessions/[sessionId]
urlstring解析后的 pathname。
routeParamsobject解析后的路由参数。
...any通过 markInteractive({ params: { ... } }) 传入的任何自定义参数。

说明与故障排查

  • routeName 是一个模式(/(tabs)/sessions/[sessionId]),而不是解析后的 URL(/sessions/abc)。这样可以让不同参数值下的指标保持稳定,仪表盘也能将它们归为同一组。解析后的值仍可在事件的 urlrouteParams 中获取。
  • 调用 router.prefetch() 不算作用户导航,也不会触发 cold_ttrwarm_ttr 的测量。随后用户对该路由发起的下一次导航会发出 warm_ttr,因为该屏幕已经渲染过了。
  • 只有在运行时安装了 expo-router 时,该集成才会激活。如果未安装,useObserve()ObserveRoot 仍可正常工作,但不会发出按路由的导航指标。
  • 必须在挂载前通过 Observe.configure({ integrations: { 'expo-router': true } }) 启用该集成。在应用挂载后再切换它会抛出错误。
  • 如果 markInteractive() 记录了 Calling markInteractive on unmounted screenNo metadata available for the current screen,说明该调用是在屏幕组件之外运行,或是在卸载之后才运行。请将调用移到屏幕组件内部的 useEffect 中。
  • 有关 EAS Observe 的常规问题,请参阅 故障排查