HttpResponseBody

HttpResponseBody 是 http 模块响应对象的 body 字段类型.

源码依据: runtime/api/augment/http/ResponseBodyNativeObject.kt, HttpSaveResult.kt.

---

HttpResponseBody

---

[m] string

string()

• returns { string }

读取响应体字符串. 读取完整内容后会自动关闭响应体. 如果请求选项启用了 cacheBody 且内容大小未知或不超过阈值, 结果会被缓存以支持重复读取. 未缓存且响应体已关闭时再次读取会抛出 Response body already closed.

[m] bytes

bytes()

• returns { ByteArray }

读取响应体字节数组. 读取完整内容后会自动关闭响应体. 缓存规则与 string 一致.

[m] json

json()

• returns { * }

读取响应体字符串并使用 JSON.parse 解析. 解析失败时抛出 Failed to parse JSON. Body string may be not in JSON format.

[p] contentType

• { okhttp3.MediaType | null }

响应体内容类型, 来自底层 OkHttp ResponseBody.contentType().

[m] stream

stream()

6.7.0

• returns { java.io.InputStream }

返回响应体输入流. 此方法不会自动关闭响应体, 调用方需要自行关闭流或调用 close.

[m] saveToFile

saveToFile(path, bufferSize?)

6.7.0

• path { string } - 保存目标文件路径, 不可为目录
• [ bufferSize = 8192 ] { number } - 缓冲区大小
• returns { HttpSaveResult }

将响应体直接保存到文件, 避免把大响应整体加载到内存. bufferSize 小于等于 0 时使用默认值 8192. path 指向目录或以 / 结尾时会直接抛出异常. 复制过程中失败不会抛出, 而是返回失败的 HttpSaveResult. 无论成功或失败, 最终都会关闭输入流、输出流和响应体.

let res = http.get('https://example.com/file.zip');
let saved = res.body.saveToFile('./file.zip');
console.log(saved.success, saved.bytesCopied);

[m] close

close()

6.7.0

• returns { void }

显式关闭响应体.

---

HttpSaveResult

---

[p] code

• { number } - 0 表示成功

成功为 0; 通用失败为 -1.

[p] path

• { string | null } - 目标路径

[p] bytesCopied

• { number } - 已写入字节数

[p] success

• { boolean } - 是否成功

[p] error

• { Error | null } - 保存失败时的错误对象

[m] isSuccess

isSuccess()

• returns { boolean }