Skip to content

NextJS中文文档 - Edge

Next.js 提供了两种服务器运行时环境,你可以在应用程序中使用:

  • Node.js 运行时(默认),可以访问所有 Node.js API,用于渲染你的应用程序。
  • Edge 运行时,包含更有限的 API 集合,用于 Middleware

注意事项/nextjs-cn/

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

参考/nextjs-cn/

Edge 运行时支持以下 API:

网络 API

API描述
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表示可读流的读取器
ReadableStreamDefaultReader表示可读流的读取器
TransformStream表示转换流
WritableStream表示可写流
WritableStreamDefaultWriter表示可写流的写入器

加密 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提供对国际化和本地化功能的访问
isFinite确定值是否为有限数
isNaN确定值是否为 NaN
JSON提供将 JavaScript 值转换为 JSON 格式并从 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表示被限制在 255 范围内的 8 位无符号整数的类型化数组
Uint32Array表示 32 位无符号整数的类型化数组
URIError表示全局 URI 处理函数被错误使用时的错误
URL表示提供用于创建对象 URL 的静态方法的对象
URLPattern表示 URL 模式
URLSearchParams表示键/值对的集合
WeakMap表示键/值对的集合,其中键被弱引用
WeakSet表示对象的集合,其中每个对象只能出现一次
WebAssembly提供对 WebAssembly 的访问

Next.js 特定的 Polyfills

环境变量

你可以使用 process.envnext devnext build 中访问环境变量

不支持的 API/nextjs-cn/

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 模块

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

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

unstable_allowDynamic 是一个 glob 模式或 glob 模式数组,忽略特定文件的动态代码评估。glob 模式相对于你的应用程序根文件夹。

请注意,如果这些语句在 Edge 上执行,它们将抛出并导致运行时错误

🎉有任何问题,欢迎联系我

WeChat QR Code
WeChat
QQ QR Code
QQ

赣ICP备2023003243号