useReportWebVitals

useReportWebVitals 钩子允许你报告 Core Web Vitals，并且可以与你的分析服务结合使用。

pages/_app.js

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

useReportWebVitals

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

id：当前页面加载上下文中指标的唯一标识符
name：性能指标的名称。可能的值包括特定于 Web 应用程序的 Web Vitals 指标（TTFB、FCP、LCP、FID、CLS）的名称。
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 属性处理所有这些指标的结果。

pages/_app.js

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

自定义指标

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

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

你可以分别处理所有这些指标的结果

pages/_app.js

import { useReportWebVitals } from 'next/web-vitals'
 
function MyApp({ Component, pageProps }) {
  useReportWebVitals((metric) => {
    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
    }
  })
 
  return <Component {...pageProps} />
}

这些指标在所有支持 User Timing API 的浏览器中都有效。

在 Vercel 上使用

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

将结果发送到外部系统

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

useReportWebVitals((metric) => {
  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 })
  }
})

须知：如果你使用 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的更多信息。