跳至内容

脚本优化

布局脚本

要为多个路由加载第三方脚本,请导入 next/script 并将脚本直接包含在您的布局组件中

app/dashboard/layout.tsx
import Script from 'next/script'
 
export default function DashboardLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return (
    <>
      <section>{children}</section>
      <Script src="https://example.com/script.js" />
    </>
  )
}

当用户访问文件夹路由(例如 dashboard/page.js)或任何嵌套路由(例如 dashboard/settings/page.js)时,会获取第三方脚本。Next.js 将确保脚本**仅加载一次**,即使用户在同一布局中的多个路由之间导航也是如此。

应用程序脚本

要为所有路由加载第三方脚本,请导入 next/script 并将脚本直接包含在您的根布局中

app/layout.tsx
import Script from 'next/script'
 
export default function RootLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return (
    <html lang="en">
      <body>{children}</body>
      <Script src="https://example.com/script.js" />
    </html>
  )
}

当访问应用程序中的任何路由时,此脚本将加载并执行。Next.js 将确保脚本**仅加载一次**,即使用户在多个页面之间导航也是如此。

建议:我们建议仅在特定页面或布局中包含第三方脚本,以最大程度地减少对性能的任何不必要影响。

策略

虽然 next/script 的默认行为允许您在任何页面或布局中加载第三方脚本,但您可以通过使用 strategy 属性来微调其加载行为

  • beforeInteractive:在任何 Next.js 代码之前以及在任何页面水合发生之前加载脚本。
  • afterInteractive:(**默认**)尽早加载脚本,但在页面上发生一些水合后。
  • lazyOnload:在浏览器空闲时间稍后加载脚本。
  • worker:(实验性)在 Web Worker 中加载脚本。

请参阅next/script API 参考文档,以了解有关每种策略及其用例的更多信息。

将脚本卸载到 Web Worker(实验性)

警告:worker 策略尚未稳定,并且尚不适用于app 目录。谨慎使用。

使用 worker 策略的脚本将被卸载并在使用Partytown的 Web Worker 中执行。这可以通过将主线程专门用于应用程序的其余代码来提高网站的性能。

此策略仍处于实验阶段,仅当在 next.config.js 中启用了 nextScriptWorkers 标志时才能使用

next.config.js
module.exports = {
  experimental: {
    nextScriptWorkers: true,
  },
}

然后,运行 next(通常是 npm run devyarn dev),Next.js 将指导您完成安装完成设置所需的软件包。

终端
npm run dev

您将看到如下所示的说明:请通过运行 npm install @builder.io/partytown 安装 Partytown。

设置完成后,定义 strategy="worker" 将自动在您的应用程序中实例化 Partytown 并将脚本卸载到 Web Worker。

pages/home.tsx

import Script from 'next/script'
 
export default function Home() {
  return (
    <>
      <Script src="https://example.com/script.js" strategy="worker" />
    </>
  )
}

在 Web Worker 中加载第三方脚本时,需要考虑许多权衡取舍。有关更多信息,请参阅 Partytown 的权衡取舍 文档。

内联脚本

Script 组件也支持内联脚本,即未从外部文件加载的脚本。可以通过将 JavaScript 代码放在花括号内来编写它们

<Script id="show-banner">
  {`document.getElementById('banner').classList.remove('hidden')`}
</Script>

或者使用dangerouslySetInnerHTML 属性

<Script
  id="show-banner"
  dangerouslySetInnerHTML={{
    __html: `document.getElementById('banner').classList.remove('hidden')`,
  }}
/>

警告:为了让 Next.js 跟踪和优化脚本,必须为内联脚本分配id 属性。

执行其他代码

可以使用 Script 组件的事件处理程序在某个事件发生后执行其他代码。

  • onLoad:脚本加载完成后执行代码。
  • onReady:脚本加载完成后以及每次组件挂载时执行代码。
  • onError:如果脚本加载失败,则执行代码。

这些处理程序仅在导入next/script 并在客户端组件(其中"use client" 定义为第一行代码)内使用时才有效。

app/page.tsx
'use client'
 
import Script from 'next/script'
 
export default function Page() {
  return (
    <>
      <Script
        src="https://example.com/script.js"
        onLoad={() => {
          console.log('Script has loaded')
        }}
      />
    </>
  )
}

请参阅next/script API 参考,以了解有关每个事件处理程序的更多信息并查看示例。

其他属性

许多 DOM 属性可以分配给<script> 元素,但 Script 组件未使用这些属性,例如nonce自定义数据属性。包含任何其他属性都会自动将其转发到包含在 HTML 中的最终优化后的<script> 元素。

app/page.tsx
import Script from 'next/script'
 
export default function Page() {
  return (
    <>
      <Script
        src="https://example.com/script.js"
        id="example-script"
        nonce="XUENAJFW"
        data-test="script"
      />
    </>
  )
}