GoLand 2025.2 Help

HTTP 请求与响应参考

响应属性

响应 对象包含有关所接收 HTTP 响应的信息（响应内容、headers、状态等），并提供对嵌套的 headers 与 contentType 对象的访问。

属性

描述

正文 （string | TextStreamResponse | object）

响应内容，可以是字符串、TextStreamResponse 对象或 JSON 对象。

头部 （ResponseHeaders）

响应头存储对象。

状态 （int）

响应状态，例如 200 或 404。

contentType （ContentType）

contentType 对象 ，其中包含 Content-Type 响应头的值信息。

Headers 对象

响应头部 对象用于检索响应头的值信息。

方法

方法

参数

描述

valueOf

headerName （string）

检索 headerName 响应头的第一个值，如果响应头 headerName 不存在，则返回 null。

valuesOf

headerName （string）

检索包含 headerName 响应头所有值的数组。 如果响应头 headerName 不存在，则返回空数组。

ContentType 对象

ContentType 数据对象包含来自 Content-Type 响应头的信息。

属性

属性

描述

mimeType （string）

响应的 MIME 类型，例如： text/plain、 text/xml、 application/json。

charset （string）

响应 charset 的字符串表示，例如 utf-8。

TextStreamResponse 对象

文本流响应 接口用于将响应处理为文本流。 允许您实现以下两种方法：

  • onEachLine(subscriber, onFinish) ：循环处理流中每一行数据。

  • onEachMessage(subscriber, onFinish) ：订阅服务器发送的每条消息。 可用于 WebSocket、GRPC 与通过 WebSocket 的 GraphQL。

参数

参数

在 onEachLine 中的用法

在 onEachMessage 中的用法

订阅者

用于处理流中每一行的函数。 需要两个参数：

  • 行 ：接收的字符串或 JSON 对象，是流的一部分。

  • 取消订阅 ：用于终止当前 每行处理 块执行的函数。 可用于在满足某个条件时停止流处理。

用于处理流中消息的函数。 需要三个参数：

  • 消息 ：接收的字符串或 JSON 对象，是流的一部分。

  • 取消订阅 ：用于终止当前 每条消息处理 块执行的函数。 可用于在满足某个条件时停止流处理。

  • 输出 （可选）：接受一个字符串（消息）并将其参数发送回服务器的函数。

完成时操作

在流结束后执行的函数。

有关如何使用的示例，请参阅 响应处理示例 ，或在 .http 文件中单击 示例 并选择 WebSocket 请求 或 GraphQL 请求。

请求属性

请求 对象包含有关 HTTP 请求的信息，可在预请求脚本与响应处理脚本中使用。

属性

在预请求脚本中使用时

在响应处理脚本中使用时

正文()

通过以下两种方法之一获取的请求 body：

  • 获取原始值() ：以原始格式返回请求体：如果其中包含变量，则显示变量名而非其值。 例如：

    client.log(request.body.getRaw());

  • 尝试获取替换值() ：返回请求体中已知变量替换为其对应值的版本。

    client.log(request.body.tryGetSubstituted());

请求 body 的字符串形式。 例如：

client.log(request.body())

环境

具有 获取(name) 方法，该方法根据 名称 参数获取 环境变量 的值，若变量不存在，则返回 null。

头部

具有两个方法：

  • 全部 ：返回当前请求所有 header 的值组成的数组。

  • 按名称查找(name) ：根据 名称 参数获取指定 header 的值。

该数组的每个元素为一个请求头对象，并包含以下方法：

  • 名称 ：header 名称，例如 Content-Type。

  • 获取原始值 ：以原始格式返回标头值：如果标头包含变量，则显示其名称而非值。

  • 尝试获取替换值() ：返回用所有已知变量值替换后的标头。

数组中的每个元素都是一个请求标头，具有以下方法：

  • 名称 ：标头名称，例如 Content-Type。

  • 值() ：标头值，例如 application/json。

方法

请求中使用的 HTTP 方法（例如 GET 或 POST）。 例如： client.log(request.method)

url()

通过以下两种方法之一获取的请求 URL：

  • 获取原始值() ：以原始格式返回请求 URL：如果 URL 包含变量，则显示其名称而非值。 例如：

    client.log(request.url.getRaw());

  • 尝试获取替换值() ：返回用所有已知变量值替换后的请求 URL。

    client.log(request.url.tryGetSubstituted());

作为字符串的请求 URL。 例如：

client.log(request.url())

变量

具有 获取(name) 方法，可根据其 名称 获取 每个请求的变量 的值，若不存在则返回 null。

迭代()

获取当前迭代的编号（索引）

用于表示集合的变量。

模板值(Integer)

根据索引在循环中获取集合元素的值。

最后修改日期： 2025年 9月 26日
HTTP Client 支持的 JavaScript API响应处理示例