边缘开发者平台
  • 边缘函数
    • 概述
    • 快速指引
    • 操作指引
      • 函数管理
      • 触发配置
    • Runtime APIs
      • addEventListener
      • Cache
      • Cookies
      • Encoding
      • Fetch
      • FetchEvent
      • Headers
      • Request
      • Response
      • Streams
        • ReadableStream
        • ReadableStreamBYOBReader
        • ReadableStreamDefaultReader
        • TransformStream
        • WritableStream
        • WritableStreamDefaultWriter
      • Web Crypto
      • Web standards
      • Images
        • ImageProperties
    • 示例函数
      • 返回 HTML 页面
      • 返回 JSON
      • Fetch 远程资源
      • 请求头鉴权
      • 修改响应头
      • AB 测试
      • 设置 Cookie
      • 基于请求区域重定向
      • Cache API 使用
      • 缓存 POST 请求
      • 流式响应
      • 合并资源流式响应
      • 防篡改校验
      • m3u8 改写与鉴权
      • 图片自适应缩放
      • 图片自适应 WebP
      • 自定义 Referer 限制规则
      • 远程鉴权
      • HMAC 数字签名
      • 自定义下载文件名
      • 获取客户端 IP
    • 最佳实践
      • 通过边缘函数实现自适应图片格式转换

Response

Response 代表 HTTP 响应,基于 Web APIs 标准 Response 进行设计。
说明
边缘函数中,可通过两种方式获得 Response 对象:
使用 Response 构造函数创建一个 Response 对象,用于 event.respondWith 响应。
使用 fetch 获取请求响应 Response 对象。

构造函数

const response = new Response(body?: string | ArrayBuffer | Blob | ReadableStream | null | undefined, init?: ResponseInit);

参数

参数名称
类型
必填
说明
body
string | ArrayBuffer | Blob | ReadableStream | null | undefined
Response对象的 body 内容。
init
Response对象的初始化配置项。

ResponseInit

参数名称
类型
必填
说明
status
number
响应的状态码。
statusText
string
响应的状态消息,最大长度为 4095,超出长度会被截断。
headers
响应的头部信息。

实例属性

body

// response.body
readonly body: ReadableStream;
响应体,详情参见 ReadableStream

bodyUsed

// response.bodyUsed
readonly bodyUsed: boolean;
标识响应体是否已读取。

headers

// response.headers
readonly headers: Headers;
响应头部,详情参见 Headers

ok

// response.ok
readonly ok: boolean;
标识响应是否成功(状态码在 200-299 范围内)。

status

// resposne.status
readonly status: number;
响应状态代码。

statusText

// resposne.statusText
readonly statusText: string;
响应的状态消息。

url

// response.url
readonly url: string;
响应的 url。

redirected

// response.redirected
readonly redirected: boolean;
标识响应是否为重定向的结果。

redirectUrls

// response.redirectUrls
readonly redirectUrls: Array<String>
所有重定向 URL。

实例方法

注意
获取响应体方法,接收 HTTP body 最大字节数为 1M,超出大小会抛出 OverSize 异常。超出大小时推荐使用 response.body 流式读取,详情参见 ReadableStream

arrayBuffer

response.arrayBuffer(): Promise<ArrayBuffer>;
获取响应体,解析结果为 ArrayBuffer

blob

response.blob(): Promise<Blob>;
获取响应体,解析结果为 Blob

clone

response.clone(copyHeaders?: boolean): Request;
创建响应对象的副本。

参数

属性名
类型
必填
说明
copyHeaders
boolean
开启复制响应头,默认值为 false,取值说明如下。
true
复制原对象的响应头。
false
引用原对象的响应头。

json

response.json(): Promise<object>;
获取响应体,解析结果为 json

text

response.text(): Promise<string>;
获取响应体,解析结果为文本字符串。

formData

response.formData(): Promise<FormData>;
获取响应体,解析结果为 FormData

静态方法

error

Response.error(): Response;
error() 方法返回一个包含网络错误相关信息的新 Response 对象。

redirect

Response.redirect(url: string | URL, status?: number): Response;
redirect() 方法返回一个可以重定向到指定 URL 的 Response 对象。

参数

属性名
类型
必填
说明
url
string
重定向地址
status
number
用于 response 的可选的状态码,允许 301/302/303/307/308, 默认 302

示例代码

addEventListener('fetch', (event) => {
const response = new Response('hello world');
event.respondWith(response);
});

相关参考