next.js 中文文档

主题

useReportWebVitals 钩子允许您报告 核心 Web 指标，并可以与您的分析服务结合使用。

useReportWebVitals ​

作为钩子参数传递的 metric 对象由多个属性组成：

  • id：当前页面加载上下文中的指标的唯一标识符
  • name：性能指标的名称。可能的值包括 Web 指标 指标的名称（TTFB, FCP, LCP, FID, CLS），特定于 Web 应用程序。
  • delta：指标当前值与前值之间的差异。该值通常以毫秒为单位，表示指标值随时间的变化。
  • entries：与指标关联的 Performance Entries 数组。这些条目提供了有关与指标相关的性能事件的详细信息。
  • navigationType：指示触发指标收集的 导航类型。可能的值包括 "navigate", "reload", "back_forward" 和 "prerender"。
  • rating：指标值的定性评级，提供性能评估。可能的值有 "good", "needs-improvement" 和 "poor"。评级通常通过将指标值与预定义的阈值进行比较来确定，这些阈值表示可接受或次优性能。
  • value：性能条目的实际值或持续时间，通常以毫秒为单位。该值提供了由指标跟踪的性能方面的定量度量。值的来源取决于正在测量的具体指标，并且可以来自各种 Performance API。

Web Vitals ​

Web Vitals 是一组有用的指标，旨在捕捉网页的用户体验。以下所有 Web Vitals 指标都包括在内：

您可以使用 name 属性处理这些指标的所有结果。

在 Vercel 上的使用 ​

Vercel Speed Insights 不使用 useReportWebVitals，而是使用 @vercel/speed-insights 包。 useReportWebVitals 钩子在本地开发中很有用，或者如果您使用不同的服务来收集 Web Vitals。

发送结果到外部系统 ​

您可以将结果发送到任何端点，以测量和跟踪您网站上的真实用户性能。例如：

js
useReportWebVitals((metric) => {
  const body = JSON.stringify(metric)
  const url = 'https://example.com/analytics'

  // 如果可用，使用 `navigator.sendBeacon()`，否则使用 `fetch()`。
  if (navigator.sendBeacon) {
    navigator.sendBeacon(url, body)
  } else {
    fetch(url, { body, method: 'POST', keepalive: true })
  }
})

须知：如果您使用 Google Analytics，使用 id 值可以允许您手动构建度量分布（以计算百分位数等）

js
useReportWebVitals(metric => {
  // 如果您像这个示例一样初始化了 Google Analytics，则使用 `window.gtag`：
  // https://github.com/vercel/next.js/blob/canary/examples/with-google-analytics/pages/_app.js
  window.gtag('event', metric.name, {
    value: Math.round(metric.name === 'CLS' ? metric.value * 1000 : metric.value), // 值必须为整数
    event_label: metric.id, // 当前页面加载的唯一 id
    non_interaction: true, // 避免影响跳出率。
  });
}

阅读更多关于 将结果发送到 Google Analytics。