NNext.js 中文网 GitHub

如何加载和优化脚本

使用内置的 Script 组件优化第三方脚本。

布局脚本#

要为多个路由加载第三方脚本,请导入 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" />
    </>
  )
}
app/dashboard/layout.js
import Script from 'next/script'

export default function DashboardLayout({ children }) {
  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>
  )
}
app/layout.js
import Script from 'next/script'

export default function RootLayout({ children }) {
  return (
    <html lang="en">
      <body>{children}</body>
      <Script src="https://example.com/script.js" />
    </html>
  )
}

要为所有路由加载第三方脚本,请导入 next/script 并将脚本直接包含在自定义的 _app 中:

pages/_app.js
import Script from 'next/script'

export default function MyApp({ Component, pageProps }) {
  return (
    <>
      <Component {...pageProps} />
      <Script src="https://example.com/script.js" />
    </>
  )
}

当访问应用程序中的任意路由时,该脚本都会加载并执行。即使用户在多个页面之间导航,Next.js 也会确保脚本只加载一次。

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

策略#

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

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

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

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

警告: worker 策略尚不稳定,且尚不适用于 App Router。请谨慎使用。

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

该策略仍处于实验阶段,只有在 next.config.js 中启用了 nextScriptWorkers 标志后才能使用:

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

然后,运行开发服务器,Next.js 将指导你安装所需的包以完成设置:

bash · pnpm
pnpm dev
bash · npm
npm run dev
bash · yarn
yarn dev
bash · bun
bun dev

你会看到类似这样的提示:请运行 npm install @qwik.dev/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" />
    </>
  )
}
pages/home.js
import Script from 'next/script'

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

在 Web Worker 中加载第三方脚本时,需要考虑一些权衡。请参阅 Partytown 的 tradeoffs 文档了解更多信息。

使用自定义 Partytown 配置#

尽管 worker 策略无需任何额外配置即可工作,但 Partytown 支持使用配置对象来修改其某些设置,包括启用 debug 模式以及转发事件和触发器。

如果你想添加额外的配置选项,可以将其包含在自定义 _document.js 中使用的 <Head /> 组件内:

pages/_document.js
import { Html, Head, Main, NextScript } from 'next/document'

export default function Document() {
  return (
    <Html>
      <Head>
        <script
          data-partytown-config
          dangerouslySetInnerHTML={{
            __html: `
              partytown = {
                lib: "/_next/static/~partytown/",
                debug: true
              };
            `,
          }}
        />
      </Head>
      <body>
        <Main />
        <NextScript />
      </body>
    </Html>
  )
}

要修改 Partytown 的配置,必须满足以下条件:

  1. 必须使用 data-partytown-config 属性来覆盖 Next.js 使用的默认配置
  2. 除非你决定将 Partytown 的库文件保存在单独的目录中,否则必须在配置对象中包含 lib: "/_next/static/~partytown/" 属性和值,以便让 Partytown 知道 Next.js 在哪里存储必要的静态文件。

注意:如果你使用了资源前缀并希望修改 Partytown 的默认配置,则必须将其包含在 lib 路径中。

查看 Partytown 的配置选项以了解可添加的其他属性的完整列表。

内联脚本#

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

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

或者使用 dangerouslySetInnerHTML 属性:

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

警告:必须为内联脚本指定 id 属性,以便 Next.js 跟踪和优化该脚本。

执行额外代码#

事件处理器可与 Script 组件一起使用,以便在特定事件发生后执行额外代码:

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

这些处理器只有在 Client Component 中导入并使用 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')
        }}
      />
    </>
  )
}
app/page.js
'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 参考,了解更多关于每个事件处理器的信息并查看示例。

在 Pages Router 中,你可以在组件中使用这些处理器,而无需添加 "use client" 指令:

pages/index.tsx
import Script from 'next/script'

export default function Page() {
  return (
    <>
      <Script
        src="https://example.com/script.js"
        onLoad={() => {
          console.log('Script has loaded')
        }}
      />
    </>
  )
}
pages/index.js
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 参考,了解更多关于每个事件处理器的信息并查看示例。

其他属性#

有许多可以分配给 <script> 元素的 DOM 属性并未被 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"
      />
    </>
  )
}
app/page.js
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"
      />
    </>
  )
}
pages/index.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"
      />
    </>
  )
}
pages/index.js
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"
      />
    </>
  )
}
Next.js 中文网