随着应用复杂度的增加,常常需要在页面中集成第三方脚本(如 Google Analytics、百度站点统计、其他第三方 SDK 等),或者动态加载自定义脚本以优化性能。这些需求在传统的 <script>
标签或 React 的生命周期中往往难以高效实现,而在 Next.js 中,Script
组件便是为此而生,我们下面来深入剖析!
按照前面的惯例,在进入正题之前,我们先来准备一下相关的环境,创建一个项目便于演示后面的内容。
使用命令 npx create-next-app@latest --use-pnpm
创建一个新的项目;具体的项目配置选项如下:
使用自己熟悉的开发者工具打开,并在终端中运行 pnpm dev
的命令行,如下:
在浏览器中访问 http://localhost:3000/ 效果如下:
基本使用
Script 是 Next.js 内置的脚本组件,用于控制加载和执行三方脚本文件。使用基本示例如下:
// src/app/home/page.tsx
import Script from 'next/script';
export default function Home() {
return (
<>
<h1>Welcome to My Site</h1>
<Script src="https://example.com/script.js" />
</>
);
}
上面这段代码是在单个路由的 page.tsx 中使用,也可以在 layout.tsx 中来使用,实现多个路由的脚本加载:
// src/app/home/layout.tsx
import { ReactNode } from 'react';
import Script from 'next/script';
export default function HomeLayout({ children }: { children: ReactNode }) {
return (
<>
<section>{children}</section>
<Script src="https://example.com/script.js" />
</>
)
}
当然也可以在根布局中加载:
import "./globals.css";
import Script from 'next/script';
import type { Metadata } from "next";
import { Geist, Geist_Mono } from "next/font/google";
const geistSans = Geist({
variable: "--font-geist-sans",
subsets: ["latin"],
});
const geistMono = Geist_Mono({
variable: "--font-geist-mono",
subsets: ["latin"],
});
export const metadata: Metadata = {
title: "Create Next App",
description: "Generated by create next app",
};
export default function RootLayout({
children,
}: Readonly<{
children: React.ReactNode;
}>) {
return (
<html lang="en">
<body
className={`${geistSans.variable} ${geistMono.variable} antialiased`}
>
{children}
<Script src="https://example.com/script.js" />
</body>
</html>
);
}
除了上面这些基础的使用姿势外,还有加载策略和内联脚本;我们先来看看这个组件的一些属性,然后在介绍这些属性的时候,再着重看看加载策略和内联脚本的使用姿势。
属性介绍
<Script>
组件没有 Link
组件那么多属性,它只有五个属性:
属性 | 使用示例 | 类型 | 是否必须 |
---|---|---|---|
src | src="https://example.com/script.js" | string | 除非使用内嵌脚本,否则必须填写 |
strategy | strategy="lazyOnload" | string | - |
onLoad | onLoad={onLoadFunc} | function | - |
onReady | onReady={onReadyFunc} | function | - |
onError | onError={onErrorFunc} | function | - |
src 属性
这个属性跟原生的 script 中的 src 一样,可以是外部脚本地址或者内部地址都可以,除非使用内敛脚本,都则都必须传此属性。
外部地址或者内部地址我们这里就不做演示了,重点来看看内联脚本,内联脚本就是像在 <script>
标签中写 JavaScript 代码一样:
import Script from 'next/script';
export default function page() {
return (
<section>
<h1>src Props</h1>
<p id='now'>now: </p>
<Script id='src-props-time-now'>
{`
setInterval(() => {
const now = new Date();
document.getElementById('now').textContent = "now: "+now;
}, 1000);
`}
</Script>
</section>
)
}
效果如下:
可以看到上面代码中 <Script>
组件上分配了一个 id
,它是用来做性能优化的,当使用内联脚本的时候,必须使用分配一个 id
。
除了使用上面这种方式外,还可以使用 dangerouslySetInnerHTML
属性:
import Script from 'next/script'
export default function page() {
return (
<section>
<h1>src Props dangerouslySetInnerHTML</h1>
<p id='now'>now: </p>
<Script id="dangerouslySetInnerHTML" dangerouslySetInnerHTML={{
__html: `
setInterval(() => {
const now = new Date();
document.getElementById('now').textContent = "now: "+now;
}, 1000);
`
}} />
</section>
)
}
效果是一样的,这里就不截图了。
strategy 属性
此属性表示当前脚本的加载策略;一共有四种:
beforeInteractive
: 在可交互前加载,适用于如机器人检测、Cookie 管理等afterInteractive
:默认值,在可交互后加载,适用于如数据统计等lazyOnload
:在浏览器空闲时间加载worker
:(实验性质)通过 web worker 加载
beforeInteractive
在可交互之前加载。beforeInteractive
脚本必须放在根布局(app/layout.tsx
)之中,用于加载整站都需要的脚本,适用于一些在页面具有可交互前需要获取的关键脚本。带有此属性的 Script
组件无论写在哪个位置,它都会被注入到 HTML 文档的 head
标签中:
import "./globals.css";
import Script from "next/script";
import type { Metadata } from "next";
import { Geist, Geist_Mono } from "next/font/google";
const geistSans = Geist({
variable: "--font-geist-sans",
subsets: ["latin"],
});
const geistMono = Geist_Mono({
variable: "--font-geist-mono",
subsets: ["latin"],
});
export const metadata: Metadata = {
title: "Create Next App",
description: "Generated by create next app",
};
export default function RootLayout({
children,
}: Readonly<{
children: React.ReactNode;
}>) {
return (
<html lang="en">
<body
className={`${geistSans.variable} ${geistMono.variable} antialiased`}
>
{children}
<Script src="https://example.com/script.js" strategy="beforeInteractive" />
</body>
</html>
);
}
上面代码中,虽然将 Script
组件写在 body
标签最后,但编译后依然被注入到 head
标签中;如下图:
afterInteractive
在页面可交互后(不一定是完全可交互)后加载,这是 Script
组件默认的加载策略,适用于需要尽快加载的脚本。afterInteractive
脚本可以写在任何页面或者布局中,并且只有当浏览器中打开该页面的时候才会加载和执行。
import Script from 'next/script'
export default function Page() {
return (
<>
<Script src="https://example.com/script.js" strategy="afterInteractive" />
</>
)
}
此策略的应用场景比如:百度站点统计、Google Tag Managers、Analysis 等等。
lazyOnload
此策略在浏览器空闲的时候注入到 HTML 客户端,并在页面所有资源都获取后开始加载。此策略是用于不需要提前加载的后台或者低优先级脚本。lazyOnload
脚本可以写在任何页面或者布局中,并且只有当浏览器中打开该页面的时候才会加载和执行。
import Script from 'next/script'
export default function Page() {
return (
<>
<Script src="https://example.com/script.js" strategy="lazyOnload" />
</>
)
}
不需要立即加载的场景可以使用此策略,比如:
- 网站接入的第三方聊天插件
- 社交属性的小部件
worker
此策略目前是实验性的,还不稳定,并且不能在 app Router 下使用。使用该策略的脚本将开一个 web worker 线程执行,从确保主线程处理关键的代码。它的背后是使用 Partytown 处理。尽管这个策略可以用于任何脚本,但作为一种高级用法,并不保证支持所有第三方脚本。我们这里就先只做了解。
onLoad 属性
一些三方脚本需要在脚本加载完毕后执行 JavaScript 代码以完成实例化或者调用函数。如果使用 afterInteractive
或者 lazyOnload
作为加载策略,则可以在加载完后使用 onLoad
属性执行代码,下面以 lodash 为例:
'use client'
import Script from 'next/script'
export default function Page() {
return (
<>
<Script
src="https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.20/lodash.min.js"
onLoad={() => {
console.log("lodash loaded:", _.sample([1, 2, 3, 4]))
}}
/>
</>
)
}
效果如下:
onLoad
不能在服务端组件中使用,只能在客户端中使用。而且onLoad
不能和beforeInteractive
一起使用,使用onReady
代替。
onReady
某些三方脚本要求用户在脚本完成加载后以及每次组件挂载的时候执行 JavaScript 代码,就比如地图导航。你可以使用 onLoad
属性处理首次加载,使用 onReady
属性处理组件每次重新挂载的时候执行代码:
下面以接入腾讯地图为例:
'use client'
import Script from 'next/script'
export default function Page() {
return (
<>
<div id="container"></div>
<Script
id="google-maps"
src="https://map.qq.com/api/gljs?v=1.exp&key=OB4BZ-D4W3U-B7VVO-4PJWW-6TKDJ-WPB77"
onReady={() => {
const center = new TMap.LatLng(39.984104, 116.307503);
//初始化地图
const map = new TMap.Map("container", {
rotation: 20,//设置地图旋转角度
pitch: 30, //设置俯仰角度(0~45)
zoom: 12,//设置地图缩放级别
center: center//设置地图中心点坐标
});
console.log('map:', map);
}}
/>
</>
)
}
上面是为了演示Script
组件的onReady
属性,如果在项目开发中,建议使用 tlbs-map地图组件库 开发地图业务,它支持 Vue 和 React 框架,能够降低你的开发成本。
效果如下图:
onReady
也不能在服务端组件中使用,只能在客户端中使用。
onError 属性
当脚本加载失败的时候用于捕获错误,此时可以使用 onError
属性处理:
'use client'
import Script from 'next/script'
export default function Page() {
return (
<>
<Script
src="https://example.com/script.js"
onError={(e: Error) => {
console.error('Script failed to load', e)
}}
/>
</>
)
}
效果如下:
onError
不能在服务端组件中使用,只能在客户端中使用。而且 onError
也不能和 beforeInteractive
一起使用。
其他 Props
按照上面表格的整理,看到这里就已经结束了,你是不是也好奇 <script>
原生标签元素上的 async
、defer
、type
等属性怎么用?其实 Next.js 中的的 <Script>
组件也能使用 <script>
标签元素的所有属性,比如使用 nonce
、referrerpolicy
时,Script 会将其转发给底层的 <script>
标签元素。
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"
/>
</>
)
}
下面这段代码定义了一个 TypeScript 接口 ScriptProps
,它扩展了 ScriptHTMLAttributes<HTMLScriptElement>
接口。
export interface ScriptProps extends ScriptHTMLAttributes<HTMLScriptElement> {
strategy?: 'afterInteractive' | 'lazyOnload' | 'beforeInteractive' | 'worker'
id?: string
onLoad?: (e: any) => void
onReady?: () => void | null
onError?: (e: any) => void
children?: React.ReactNode
stylesheets?: string[]
}
想要了解更多底层细节可以看 https://github.com/vercel/next.js/blob/v15.1.5/packages/next/src/client/script.tsx
最佳实践与注意事项
提供优化 Script 组件加载性能的建议(如合理选择加载策略、避免重复加载等)
懒加载
next/script
是 Next.js 提供的专用组件,用于优化脚本的加载方式。它支持多种加载策略,如lazyOnload
,可以将非关键脚本推迟到页面加载完成后加载。import Script from 'next/script'; export default function Page() { return ( <div> <h1>页面内容</h1> <Script src="https://example.com/external.js" strategy="lazyOnload" // 延迟加载脚本 onLoad={() => console.log('Script loaded!')} /> </div> ); }
动态加载第三方脚本
如果你的组件依赖于外部脚本(例如某个第三方库),可以将这些脚本的加载逻辑封装在动态组件中。通过设置
ssr: false
,这些脚本将仅在客户端加载,从而减少服务器端的负载。import dynamic from 'next/dynamic'; const ScriptComponent = dynamic(() => import('@/components/ScriptComponent'), { ssr: false, // 避免在服务器端加载脚本 }); export default function Page() { return ( <div> <h1>content</h1> <ScriptComponent /> </div> ); }
- 避免重复加载
Next.js 会根据 id 属性去重,确保相同的脚本不会重复加载。
<Script id="analytics-script" src="https://example.com/analytics.js" />
使用 Script 组件时需要注意的安全问题(如防止 XSS 攻击)
配置内容安全策略(Content Security Policy,CSP)
内容安全策略(CSP)是一种额外的安全层,用于帮助检测和减少某些类型的攻击,如 XSS 和数据注入攻击。通过配置 CSP,可以限制页面加载的资源来源,从而防止恶意脚本的执行。配置有两种方式:静态配置和动态配置。
a. 静态配置
在 next.config.ts 文件中通过
headers
属性定义静态 CSP,例如:import type { NextConfig } from "next"; const nextConfig: NextConfig = { /* config options here */ async headers() { return [ { source: '/(.*)', headers: [ { key: 'Content-Security-Policy', value: "default-src 'self'; script-src 'self' https://trusted.cdn.com; object-src 'none';", }, ], }, ]; }, }; export default nextConfig;
default-src 'self'
:默认仅允许从当前域加载所有资源。script-src 'self' https://trusted.cdn.com
:脚本仅允许从当前域和可信的 CDN 加载。object-src 'none'
:禁止加载<object>
、<embed>
或<applet>
标签内容。
b. 动态配置
如果需要动态生成 CSP,可以使用 Next.js 的中间件。例如:
import { NextRequest, NextResponse } from 'next/server'; export function middleware(request: NextRequest) { const nonce = Buffer.from(crypto.randomUUID()).toString('base64'); const cspHeader = ` default-src 'self'; script-src 'self' 'nonce-${nonce}' 'strict-dynamic'; style-src 'self' 'nonce-${nonce}'; img-src 'self' blob: data:; font-src 'self'; object-src 'none'; base-uri 'self'; form-action 'self'; frame-ancestors 'none'; upgrade-insecure-requests; `.replace(/\s{2,}/g, ' ').trim(); const response = NextResponse.next({ request: { headers: new Headers(request.headers), }, }); response.headers.set('Content-Security-Policy', cspHeader); return response; }
关于 XSS 相关内容可以访问博客园 feixianxing 分享的网络安全 如何预防XSS 文章:https://www.cnblogs.com/feixianxing/p/18393032/network-safety...
避免内联脚本
尽量避免使用内联脚本,因为它们更容易被 XSS 攻击利用。如果必须使用内联脚本,可以通过 CSP 的 nonce 功能来增强安全性。
输入验证与输出编码
在处理用户输入时,严格验证输入内容,确保只接受预期的字符和格式。同时,在将用户输入显示到页面之前,进行适当的编码,例如使用 DOMPurify 或其他库对内容进行净化。
使用安全的 DOM 操作
避免使用
innerHTML
或其他直接操作 DOM 的方法。推荐使用textContent
或安全的 DOM 操作,以减少 XSS 风险。
总结
Next.js 提供的 Script
组件是优化第三方脚本加载的利器,通过其内置的 strategy
属性,我们可以灵活控制脚本的加载时机,确保性能和用户体验之间的平衡。同时,诸如 onLoad
和 onError
等回调函数,赋予开发者更多脚本管理的能力。正确地使用 Script
组件,不仅能够提升页面加载速度,还能避免因脚本问题导致的用户体验下降。因此,在开发过程中,结合实际需求选择合适的加载策略是提升应用性能的关键一步。
「参考资源」
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。