useReportWebVitals

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

传递给 useReportWebVitals 的新函数将以当前可用的指标作为参数被调用。为防止报告重复数据，请确保回调函数引用不会更改（如下面的代码示例所示）。

import { useReportWebVitals } from 'next/web-vitals'
 
const logWebVitals = (metric) => {
  console.log(metric)
}
 
function MyApp({ Component, pageProps }) {
  useReportWebVitals(logWebVitals)
 
  return <Component {...pageProps} />
}

useReportWebVitals

作为钩子参数传递的 metric 对象包含多个属性

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

Web Vitals

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

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

import { useReportWebVitals } from 'next/web-vitals'
 
const handleWebVitals = (metric) => {
  switch (metric.name) {
    case 'FCP': {
      // handle FCP results
    }
    case 'LCP': {
      // handle LCP results
    }
    // ...
  }
}
 
function MyApp({ Component, pageProps }) {
  useReportWebVitals(handleWebVitals)
 
  return <Component {...pageProps} />
}

自定义指标

除了上面列出的核心指标外，还有一些额外的自定义指标，用于测量页面水合和渲染所需的时间

Next.js-hydration：页面开始和完成水合所需的时间长度（以毫秒为单位）
Next.js-route-change-to-render：路由更改后页面开始渲染所需的时间长度（以毫秒为单位）
Next.js-render：路由更改后页面完成渲染所需的时间长度（以毫秒为单位）

您可以单独处理这些指标的所有结果

import { useReportWebVitals } from 'next/web-vitals'
 
function handleCustomMetrics(metrics) {
  switch (metric.name) {
    case 'Next.js-hydration':
      // handle hydration results
      break
    case 'Next.js-route-change-to-render':
      // handle route-change to render results
      break
    case 'Next.js-render':
      // handle render results
      break
    default:
      break
  }
}
 
function MyApp({ Component, pageProps }) {
  useReportWebVitals(handleCustomMetrics)
 
  return <Component {...pageProps} />
}

这些指标适用于所有支持 User Timing API 的浏览器。

将结果发送到外部系统

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

function postWebVitals(metrics) {
  const body = JSON.stringify(metric)
  const url = 'https://example.com/analytics'
 
  // Use `navigator.sendBeacon()` if available, falling back to `fetch()`.
  if (navigator.sendBeacon) {
    navigator.sendBeacon(url, body)
  } else {
    fetch(url, { body, method: 'POST', keepalive: true })
  }
}
 
useReportWebVitals(postWebVitals)

提示：如果您使用Google Analytics，使用 id 值可以手动构建指标分布（以计算百分位数等）。

useReportWebVitals(metric => {
  // Use `window.gtag` if you initialized Google Analytics as this example:
  // https://github.com/vercel/next.js/blob/canary/examples/with-google-analytics
  window.gtag('event', metric.name, {
    value: Math.round(metric.name === 'CLS' ? metric.value * 1000 : metric.value), // values must be integers
    event_label: metric.id, // id unique to current page load
    non_interaction: true, // avoids affecting bounce rate.
  });
}

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