Edge 运行时 (Edge Runtime)

Next.js 提供了两种可在应用程序中使用的服务端运行时:

  • Node.js 运行时(默认),可访问所有 Node.js API,用于渲染您的应用程序。
  • Edge Runtime,包含一组更有限的 API,用于 中间件

注意事项

  • Edge Runtime 不支持所有 Node.js API。某些包可能无法按预期工作。
  • Edge Runtime 不支持增量静态再生 (ISR)。
  • 根据您的部署适配器,两种运行时均可支持 流式传输

参考

Edge Runtime 支持以下 API:

网络 API

API描述
Blob表示一个 blob 对象
fetch获取资源
FetchEvent表示一个 fetch 事件
File表示一个文件
FormData表示表单数据
Headers表示 HTTP 标头
Request表示一个 HTTP 请求
Response表示一个 HTTP 响应
URLSearchParams表示 URL 查询参数
WebSocket表示一个 WebSocket 连接

编码 API

API描述
atob解码 base-64 编码的字符串
btoa将字符串编码为 base-64
TextDecoder将 Uint8Array 解码为字符串
TextDecoderStream可链式调用的流解码器
TextEncoder将字符串编码为 Uint8Array
TextEncoderStream可链式调用的流编码器

流 API

API描述
ReadableStream表示一个可读流
ReadableStreamBYOBReader表示 ReadableStream 的读取器
ReadableStreamDefaultReader表示 ReadableStream 的默认读取器
TransformStream表示一个转换流
WritableStream表示一个可写流
WritableStreamDefaultWriter表示 WritableStream 的写入器

加密 API

API描述
crypto提供对平台加密功能的访问
CryptoKey表示一个加密密钥
SubtleCrypto提供对常见加密原语的访问,如哈希、签名、加密或解密

Web 标准 API

API描述
AbortController允许在需要时中止一个或多个 DOM 请求
Array表示一组值的数组
ArrayBuffer表示一个通用的、固定长度的原始二进制数据缓冲区
Atomics提供原子操作作为静态方法
BigInt表示任意精度的整数
BigInt64Array表示一个 64 位有符号整数的类型化数组
BigUint64Array表示一个 64 位无符号整数的类型化数组
Boolean表示一个逻辑实体,可以有两个值:truefalse
clearInterval取消之前通过 setInterval() 设置的定时重复操作
clearTimeout取消之前通过 setTimeout() 设置的定时重复操作
console提供对浏览器调试控制台的访问
DataView表示 ArrayBuffer 的通用视图
Date以平台无关的格式表示单个时间点
decodeURI解码之前由 encodeURI 或类似例程创建的统一资源标识符 (URI)
decodeURIComponent解码之前由 encodeURIComponent 或类似例程创建的 URI 组件
DOMException表示 DOM 中发生的错误
encodeURI通过将某些字符的每个实例替换为一个、两个、三个或四个表示该字符 UTF-8 编码的转义序列来编码 URI
encodeURIComponent通过将某些字符的每个实例替换为一个、两个、三个或四个表示该字符 UTF-8 编码的转义序列来编码 URI 组件
Error表示尝试执行语句或访问属性时发生的错误
EvalError表示与全局函数 eval() 相关的错误
Float32Array表示一个 32 位浮点数的类型化数组
Float64Array表示一个 64 位浮点数的类型化数组
Function表示一个函数
Infinity表示数学上的无穷大值
Int8Array表示一个 8 位有符号整数的类型化数组
Int16Array表示一个 16 位有符号整数的类型化数组
Int32Array表示一个 32 位有符号整数的类型化数组
Intl提供对国际化 (i18n) 和本地化 (l10n) 功能的访问
isFinite判断一个值是否为有限数
isNaN判断一个值是否为 NaN
JSON提供将 JavaScript 值与 JSON 格式相互转换的功能
Map表示一组值的集合,其中每个值只能出现一次
Math提供对数学函数和常量的访问
Number表示一个数值
Object表示作为所有 JavaScript 对象基础的对象
parseFloat解析字符串参数并返回一个浮点数
parseInt解析字符串参数并返回指定基数的整数
Promise表示异步操作的最终完成(或失败)及其结果值
Proxy表示一个对象,用于定义基本操作(如属性查找、赋值、枚举、函数调用等)的自定义行为
queueMicrotask将微任务加入队列以执行
RangeError表示当一个值不在允许的值集合或范围内时发生的错误
ReferenceError表示引用不存在的变量时发生的错误
Reflect提供可拦截的 JavaScript 操作方法
RegExp表示一个正则表达式,允许匹配字符组合
Set表示一组值的集合,其中每个值只能出现一次
setInterval以固定的时间间隔重复调用函数
setTimeout在指定的毫秒数后调用函数或计算表达式
SharedArrayBuffer表示一个通用的、固定长度的原始二进制数据缓冲区
String表示一个字符序列
structuredClone创建一个值的深拷贝
Symbol表示一个唯一且不可变的数据类型,用作对象属性的键
SyntaxError表示尝试解释语法无效的代码时发生的错误
TypeError表示当一个值的类型不符合预期时发生的错误
Uint8Array表示一个 8 位无符号整数的类型化数组
Uint8ClampedArray表示一个 8 位无符号整数的类型化数组,数值被限制在 0-255 之间
Uint32Array表示一个 32 位无符号整数的类型化数组
URIError表示以错误方式使用全局 URI 处理函数时发生的错误
URL表示一个提供用于创建对象 URL 的静态方法的对象
URLPattern表示一个 URL 模式
URLSearchParams表示一组键/值对的集合
WeakMap表示一组键/值对的集合,其中键是弱引用的
WeakSet表示一组对象的集合,其中每个对象只能出现一次
WebAssembly提供对 WebAssembly 的访问

Next.js 专属 Polyfills

环境变量

你可以使用 process.env 来访问环境变量,无论是在 next dev 还是 next build 模式下。

不受支持的 API

Edge 运行时存在一些限制,包括:

  • 不支持原生 Node.js API。例如,无法读写文件系统。
  • 可以使用 node_modules,只要它们实现了 ES 模块且未使用原生 Node.js API。
  • 不允许直接调用 require。请改用 ES 模块。

以下 JavaScript 语言特性被禁用,将无法工作

API描述
eval执行以字符串形式表示的 JavaScript 代码
new Function(evalString)根据提供的代码字符串创建一个新函数
WebAssembly.compile从缓冲区源编译 WebAssembly 模块
WebAssembly.instantiate从缓冲区源编译并实例化 WebAssembly 模块

在极少数情况下,你的代码可能包含(或导入)一些动态代码评估语句,这些语句在运行时无法被访问且无法通过 treeshaking 移除。
你可以通过中间件配置放宽检查,允许特定文件:

middleware.ts
export const config = {
  unstable_allowDynamic: [
    // 允许单个文件
    '/lib/utilities.js',
    // 使用 glob 模式允许第三方模块 function-bind 中的所有内容
    '**/node_modules/function-bind/**',
  ],
}

unstable_allowDynamic 是一个 glob 或 glob 数组,用于忽略特定文件的动态代码评估检查。这些 glob 路径相对于应用程序的根目录。

请注意,如果这些语句在 Edge 环境中执行,它们会抛出错误并导致运行时故障

On this page