Object 内置对象

对象 HttpsServer

https 服务器对象

https 服务器对象是将 SslServerHttpHandler 组合封装的对象,方便快速搭建服务器,逻辑上相当于:

1 2 3
var svr = new net.SslServer(crt, key, addr, port, new http.Handler(function(req) { ... }));

创建方法:

1 2 3 4
var http = require("http"); var svr = new http.HttpsServer(crt, key, 443, function(req) { ... });

继承关系

构造函数

HttpsServer

HttpsServer 构造函数,在所有本机地址侦听

1 2 3
new HttpsServer(Array certs, Integer port, Handler hdlr);

调用参数:

  • certs: Array, 服务器证书列表
  • port: Integer, 指定 http 服务器侦听端口
  • hdlr: Handler, http 内置消息处理器,处理函数,链式处理数组,路由对象,详见

certs 格式为:

1 2 3 4 5 6 7 8 9
[{ crt: [X509Cert object], key: [PKey object] }, { crt: [X509Cert object], key: [PKey object] } ]

HttpsServer 构造函数

1 2 3 4
new HttpsServer(Array certs, String addr, Integer port, Handler hdlr);

调用参数:

  • certs: Array, 服务器证书列表
  • addr: String, 指定 http 服务器侦听地址,为 "" 则在本机所有地址侦听
  • port: Integer, 指定 http 服务器侦听端口
  • hdlr: Handler, http 内置消息处理器,处理函数,链式处理数组,路由对象,详见

certs 格式为:

1 2 3 4 5 6 7 8 9
[{ crt: [X509Cert object], key: [PKey object] }, { crt: [X509Cert object], key: [PKey object] } ]

HttpsServer 构造函数,在所有本机地址侦听

1 2 3 4
new HttpsServer(X509Cert crt, PKey key, Integer port, Handler hdlr);

调用参数:

  • crt: X509Cert, X509Cert 证书,用于客户端验证服务器
  • key: PKey, PKey 私钥,用于与客户端会话
  • port: Integer, 指定 http 服务器侦听端口
  • hdlr: Handler, http 内置消息处理器,处理函数,链式处理数组,路由对象,详见

HttpsServer 构造函数

1 2 3 4 5
new HttpsServer(X509Cert crt, PKey key, String addr, Integer port, Handler hdlr);

调用参数:

  • crt: X509Cert, X509Cert 证书,用于客户端验证服务器
  • key: PKey, PKey 私钥,用于与客户端会话
  • addr: String, 指定 http 服务器侦听地址,为 "" 则在本机所有地址侦听
  • port: Integer, 指定 http 服务器侦听端口
  • hdlr: Handler, http 内置消息处理器,处理函数,链式处理数组,路由对象,详见

成员属性

verification

Integer, 设定证书验证模式,缺省为 VERIFY_NONE

1
Integer HttpsServer.verification;

ca

X509Cert, 客户端证书验证 ca

1
readonly X509Cert HttpsServer.ca;

forceGZIP

Boolean, 查询和设置是否允强制使用 gzip 压缩输出,缺省为 false

1
Boolean HttpsServer.forceGZIP;

maxHeadersCount

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

1
Integer HttpsServer.maxHeadersCount;

maxBodySize

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

1
Integer HttpsServer.maxBodySize;

serverName

String, 查询和设置服务器名称,缺省为:fibjs/0.x.0

1
String HttpsServer.serverName;

httpStats

Stats, 查询 http 协议转换处理器的工作状态

1
readonly Stats HttpsServer.httpStats;

返回的结果为一个 Stats 对象,结构如下:

1 2 3 4 5 6 7 8 9 10
{ total: 1000, // 总计处理的请求 pendding: 100, // 当前正在处理的请求 request: 10, // 新建的请求 response: 10, // 发送的响应 error: 100, // 发生的错误(不计入 404) error_400: 10, // 发生的请求错误 error_404: 12, // 文件未找到的数量 error_500: 2 // 内部处理错误 }

socket

Socket, 服务器当前侦听的 Socket 对象

1
readonly Socket HttpsServer.socket;

handler

Handler, 服务器当前事件处理接口对象

1
Handler HttpsServer.handler;

stats

Stats, 查询当前服务器运行状态

1
readonly Stats HttpsServer.stats;

返回的结果为一个 Stats 对象,初始化计数器如下:

1 2 3 4 5 6
{ total: 1000, // 总计处理的连接 connections: 100, // 当前正在处理的连接 accept: 10, // 上次查询后新建的连接 close: 10 // 上次查询后关闭的连接 }

成员函数

onerror

设置错误处理器

1
HttpsServer.onerror(Object hdlrs);

调用参数:

  • hdlrs: Object, 指定不同的错误的处理器,key 是错误号,value 是处理器,可以是内置消息处理器,处理函数,链式处理数组,路由对象,详见 mq.Handler

使用方式:

1 2 3 4 5 6
hdlr.onerror({ "404": function(v) { ... }, "500": new mq.Routing(...) })

enableCrossOrigin

允许跨域请求

1
HttpsServer.enableCrossOrigin(String allowHeaders = "Content-Type");

调用参数:

  • allowHeaders: String, 指定接受的 http 头字段

run

运行服务器并开始接收和分发连接,此函数不会返回

1
HttpsServer.run() async;

asyncRun

异步运行服务器并开始接收和分发连接,调用后立即返回,服务器在后台运行

1
HttpsServer.asyncRun();

stop

关闭 socket中止正在运行的服务器

1
HttpsServer.stop() async;

toString

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

1
String HttpsServer.toString();

返回结果:

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

toJSON

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

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

调用参数:

  • key: String, 未使用

返回结果:

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