useReportWebVitals

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

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

网页核心指标

网页核心指标是一组有用的指标，旨在捕捉网页的用户体验。以下网页核心指标都包含在内

您可以使用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} />
}

这些指标适用于所有支持用户计时 API的浏览器。

在 Vercel 上使用

Vercel 速度洞察不使用useReportWebVitals，而是使用@vercel/speed-insights包。useReportWebVitals钩子在本地开发中很有用，或者如果您使用其他服务来收集 Web 指标。

将结果发送到外部系统

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

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的信息。