对象 HttpRequest

HttpRequest 是用来处理 HTTP 请求的类， 它允许你创建 HTTP 请求并与服务器交互。你可以使用它来向 Web 服务器发送 GET、POST 以及其它类型的 HTTP 请求

假设我们有一个 key 为 name 的查询参数，我们来根据这个参数返回不同的处理结果：如果参数为空，返回 "Hello world!"；如果参数为 "fibjs"，返回 "Hello fibjs!"；否则返回 "Hello some body!".

代码实现如下：

1
2
3
4
5
6
7
8
9
10
const http = require('http');

var svr = new http.Server(8080, (req) => {
    var name = req.query.get('name');
    var msg = name ? `Hello ${name}!` : 'Hello world!';

    req.response.write(msg);
});

svr.start();

这里我们使用了 req.query 这个 Collection 类型，它代表 HTTP 请求 URL 中的查询参数。

我们向服务程序通过浏览器访问 http://127.0.0.1:8080/?name=fibjs 得到的服务端响应内容是 Hello fibjs!。

继承关系

构造函数

HttpRequest

HttpRequest 构造函数，创建一个新的 HttpRequest 对象

1
new HttpRequest();

常量

TEXT

指定消息类型 1，代表一个文本类型

1
const HttpRequest.TEXT = 1;

---

BINARY

指定消息类型 2，代表一个二进制类型

1
const HttpRequest.BINARY = 2;

成员属性

response

HttpResponse, 获取响应消息对象

1
readonly HttpResponse HttpRequest.response;

---

method

String, 查询和设置请求方法

1
String HttpRequest.method;

---

address

String, 查询和设置请求地址

1
String HttpRequest.address;

---

queryString

String, 查询和设置请求查询字符串

1
String HttpRequest.queryString;

---

cookies

HttpCollection, 获取包含消息 cookies 的容器

1
readonly HttpCollection HttpRequest.cookies;

---

form

HttpCollection, 获取包含消息 form 的容器

1
readonly HttpCollection HttpRequest.form;

---

query

HttpCollection, 获取包含消息 query 的容器

1
readonly HttpCollection HttpRequest.query;

---

protocol

String, 协议版本信息，允许的格式为：HTTP/#.#

1
String HttpRequest.protocol;

---

headers

HttpCollection, 包含消息中 http 消息头的容器，只读属性

1
readonly HttpCollection HttpRequest.headers;

---

keepAlive

Boolean, 查询和设定是否保持连接

1
Boolean HttpRequest.keepAlive;

---

upgrade

Boolean, 查询和设定是否是升级协议

1
Boolean HttpRequest.upgrade;

---

maxHeadersCount

Integer, 查询和设置最大请求头个数，缺省为 128

1
Integer HttpRequest.maxHeadersCount;

---

maxHeaderSize

Integer, 查询和设置最大请求头长度，缺省为 8192

1
Integer HttpRequest.maxHeaderSize;

---

maxBodySize

Integer, 查询和设置 body 最大尺寸，以 MB 为单位，缺省为 64

1
Integer HttpRequest.maxBodySize;

---

socket

Stream, 查询当前对象的来源 socket

1
readonly Stream HttpRequest.socket;

---

value

String, 消息的基本内容

1
String HttpRequest.value;

---

params

NArray, 消息的基本参数

1
readonly NArray HttpRequest.params;

---

type

Integer, 消息类型

1
Integer HttpRequest.type;

---

data

Value, 查询消息的数据，此属性会根据 content-type 返回不同数据，为 text 时，返回文本，为 json 时返回 json，其它时候返回二进制

1
readonly Value HttpRequest.data;

---

body

SeekableStream, 包含消息数据部分的流对象

1
SeekableStream HttpRequest.body;

---

length

Long, 消息数据部分的长度

1
readonly Long HttpRequest.length;

---

stream

Stream, 查询消息 readFrom 时的流对象

1
readonly Stream HttpRequest.stream;

---

lastError

String, 查询和设置消息处理的最后错误

1
String HttpRequest.lastError;

成员函数

hasHeader

检查是否存在指定键值的消息头

1
Boolean HttpRequest.hasHeader(String name);

调用参数:

• name: String, 指定要检查的键值

返回结果:

• Boolean, 返回键值是否存在

---

firstHeader

查询指定键值的第一个消息头

1
String HttpRequest.firstHeader(String name);

调用参数:

• name: String, 指定要查询的键值

返回结果:

• String, 返回键值所对应的值，若不存在，则返回 undefined

---

allHeader

查询指定键值的全部消息头

1
NObject HttpRequest.allHeader(String name = "");

调用参数:

• name: String, 指定要查询的键值，传递空字符串返回全部键值的结果

返回结果:

• NObject, 返回键值所对应全部值的数组，若数据不存在，则返回 null

---

addHeader

添加一个消息头，添加数据并不修改已存在的键值的消息头

1
HttpRequest.addHeader(Object map);

调用参数:

• map: Object, 指定要添加的键值数据字典

---

添加指定名称的一组消息头，添加数据并不修改已存在的键值的消息头

1
2
HttpRequest.addHeader(String name,
    Array values);

调用参数:

• name: String, 指定要添加的键值
• values: Array, 指定要添加的一组数据

---

添加一个消息头，添加数据并不修改已存在的键值的消息头

1
2
HttpRequest.addHeader(String name,
    String value);

调用参数:

• name: String, 指定要添加的键值
• value: String, 指定要添加的数据

---

setHeader

设定一个消息头，设定数据将修改键值所对应的第一个数值，并清除相同键值的其余消息头

1
HttpRequest.setHeader(Object map);

调用参数:

• map: Object, 指定要设定的键值数据字典

---

设定指定名称的一组消息头，设定数据将修改键值所对应的数值，并清除相同键值的其余消息头

1
2
HttpRequest.setHeader(String name,
    Array values);

调用参数:

• name: String, 指定要设定的键值
• values: Array, 指定要设定的一组数据

---

设定一个消息头，设定数据将修改键值所对应的第一个数值，并清除相同键值的其余消息头

1
2
HttpRequest.setHeader(String name,
    String value);

调用参数:

• name: String, 指定要设定的键值
• value: String, 指定要设定的数据

---

removeHeader

删除指定键值的全部消息头

1
HttpRequest.removeHeader(String name);

调用参数:

• name: String, 指定要删除的键值

---

read

从流内读取指定大小的数据，此方法为 body 相应方法的别名

1
Buffer HttpRequest.read(Integer bytes = -1) async;

调用参数:

• bytes: Integer, 指定要读取的数据量，缺省为读取随机大小的数据块，读出的数据尺寸取决于设备

返回结果:

• Buffer, 返回从流内读取的数据，若无数据可读，或者连接中断，则返回 null

---

readAll

从流内读取剩余的全部数据，此方法为 body 相应方法的别名

1
Buffer HttpRequest.readAll() async;

返回结果:

• Buffer, 返回从流内读取的数据，若无数据可读，或者连接中断，则返回 null

---

write

写入给定的数据，此方法为 body 相应方法的别名

1
HttpRequest.write(Buffer data) async;

调用参数:

• data: Buffer, 给定要写入的数据

---

json

以 JSON 编码写入给定的数据

1
Value HttpRequest.json(Value data);

调用参数:

• data: Value, 给定要写入的数据

返回结果:

• Value, 此方法不会返回数据

---

以 JSON 编码解析消息中的数据

1
Value HttpRequest.json();

返回结果:

• Value, 返回解析的结果

---

pack

以 msgpack 编码写入给定的数据

1
Value HttpRequest.pack(Value data);

调用参数:

• data: Value, 给定要写入的数据

返回结果:

• Value, 此方法不会返回数据

---

以 msgpack 编码解析消息中的数据

1
Value HttpRequest.pack();

返回结果:

• Value, 返回解析的结果

---

end

设置当前消息处理结束，Chain 处理器不再继续后面的事务

1
HttpRequest.end();

---

isEnded

查询当前消息是否结束

1
Boolean HttpRequest.isEnded();

返回结果:

• Boolean, 结束则返回 true

---

clear

清除消息的内容

1
HttpRequest.clear();

---

sendTo

发送格式化消息到给定的流对象

1
HttpRequest.sendTo(Stream stm) async;

调用参数:

• stm: Stream, 指定接收格式化消息的流对象

---

readFrom

从给定的缓存流对象中读取格式化消息，并解析填充对象

1
HttpRequest.readFrom(Stream stm) async;

调用参数:

• stm: Stream, 指定读取格式化消息的流对象

---

toString

返回对象的字符串表示，一般返回 "[Native Object]"，对象可以根据自己的特性重新实现

1
String HttpRequest.toString();

返回结果:

• String, 返回对象的字符串表示

---

toJSON

返回对象的 JSON 格式表示，一般返回对象定义的可读属性集合

1
Value HttpRequest.toJSON(String key = "");

调用参数:

• key: String, 未使用

返回结果:

• Value, 返回包含可 JSON 序列化的值