跳到主要内容

如何为你的 Next.js 应用程序添加分析功能

Next.js 内置了对测量和报告性能指标的支持。你可以使用 useReportWebVitals hook 来自己管理报告，或者，Vercel 提供了一个托管服务来自动收集和可视化指标。

客户端检测​

对于更高级的分析和监控需求，Next.js 提供了一个 instrumentation-client.js|ts 文件，它在你的应用程序前端代码开始执行之前运行。这对于设置全局分析、错误跟踪或性能监控工具来说是理想的。

要使用它，在你的应用程序根目录中创建一个 instrumentation-client.js 或 instrumentation-client.ts 文件：

instrumentation-client.js
// 在应用程序启动前初始化分析
console.log('分析已初始化')

// 设置全局错误跟踪
window.addEventListener('error', (event) => {
  // 发送到你的错误跟踪服务
  reportError(event.error)
})

自行构建​

pages/_app.js
import { useReportWebVitals } from 'next/web-vitals'

function MyApp({ Component, pageProps }) {
  useReportWebVitals((metric) => {
    console.log(metric)
  })

  return <Component {...pageProps} />
}

查看 API 参考 了解更多信息。

app/_components/web-vitals.js
'use client'

import { useReportWebVitals } from 'next/web-vitals'

export function WebVitals() {
  useReportWebVitals((metric) => {
    console.log(metric)
  })
}
app/layout.js
import { WebVitals } from './_components/web-vitals'

export default function Layout({ children }) {
  return (
    <html>
      <body>
        <WebVitals />
        {children}
      </body>
    </html>
  )
}

由于 useReportWebVitals hook 需要 'use client' 指令，最高性能的方法是创建一个单独的组件，由根布局导入。这会将客户端边界限制在 WebVitals 组件内。

查看 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': {
        // 处理 FCP 结果
      }
      case 'LCP': {
        // 处理 LCP 结果
      }
      // ...
    }
  })

  return <Component {...pageProps} />
}
app/_components/web-vitals.tsx
'use client'

import { useReportWebVitals } from 'next/web-vitals'

export function WebVitals() {
  useReportWebVitals((metric) => {
    switch (metric.name) {
      case 'FCP': {
        // 处理 FCP 结果
      }
      case 'LCP': {
        // 处理 LCP 结果
      }
      // ...
    }
  })
}

自定义指标​

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

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

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

export function reportWebVitals(metric) {
  switch (metric.name) {
    case 'Next.js-hydration':
      // 处理水合结果
      break
    case 'Next.js-route-change-to-render':
      // 处理路由更改到渲染的结果
      break
    case 'Next.js-render':
      // 处理渲染结果
      break
    default:
      break
  }
}

这些指标在所有支持 User Timing API 的浏览器中都可以工作。

将结果发送到外部系统​

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

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 值可以让你手动构建指标分布（计算百分位数等）

useReportWebVitals((metric) => {
  // 如果你像这个例子一样初始化了 Google Analytics，请使用 `window.gtag`：
  // 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
    ), // 值必须是整数
    event_label: metric.id, // 当前页面加载的唯一 id
    non_interaction: true, // 避免影响跳出率。
  })
})

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

最后于 更新