http · Magic_sword2

[TOC] # 简介说明 原文链接： - [http](https://github.com/nodejs/node/blob/main/doc/api/http.md) ``` 版本：http 作用：http协议控制模块 ``` # http # *METHODS ***** 解析器支持的 HTTP 方法列表。 # *STATUS_CODES ***** 所有标准 HTTP 响应状态码的集合，以及每个状态码的简短描述 # *globalAgent ***** Agent 的全局实例，作为所有 HTTP 客户端请求的默认值。 # *maxHeaderSize ***** 只读属性，指定 HTTP 消息头的最大允许大小（以字节为单位）。默认为 8KB。。 # *createServer() ***** 创建服务器，不同Worker共享相同Server ### 返回类型 ``` http.Server ``` ### 参数说明 options : * 类型：对象 * 默认值：无 * 描述：拓展原有方法 * 可选值：[ ] fn: * 类型：回调函数 * 默认值：无 * 描述：返回对象IncomingMessage和ServerResponse * 可选值：[ ] ### 示例内容 1. 举例说明 ``` const http = require('http'); const server = http.createServer((req, res) => { res.end(); }); server.listen(8000); ``` # *get() ***** 创建GET请求，用于请求远程主机 ### 返回类型 ``` http.ClientRequest ``` ### 参数说明 url : * 类型：字符串 * 默认值：无 * 描述：请求地址 * 可选值：[ ] options : * 类型：对象 * 默认值：无 * 描述：配置参数 * 可选值：[ ] callback : * 类型：回调函数 * 默认值：无 * 描述：当请求返回时回调的函数，传递参数http.IncomingMessage对象 * 可选值：[ ] ### 示例内容 1. 举例说明 ``` http.get("http://www.baidu.com", (res) => res.pipe(process.stdout)); ``` # *request() ***** Node.js 为每个服务器维护多个连接以发出 HTTP 请求。此函数允许显式地发出请求 ### 返回类型 ``` http.ClientRequest ``` ### 参数说明 url : * 类型：字符串 * 默认值：无 * 描述：请求地址 * 可选值：[ ] options : * 类型：对象 * 默认值：无 * 描述：配置参数 * 可选值：[ ] callback : * 类型：回调函数 * 默认值：无 * 描述：当请求返回时回调的函数，传递参数http.IncomingMessage对象 * 可选值：[ ] # http.ClientRequest # aborted ***** 判断请求是否已经终止 # destroyed ***** 连接是否被销毁 # end() ***** 完成发送请求。如果部分请求主体还未发送，则将它们刷新到流中。如果请求被分块，则发送终止符 '0\r\n\r\n' # destroy() ***** 销毁连接 # flushHeaders() ***** 刷新请求头 # getHeader() ***** 读取请求中的一个请求头。该名称不区分大小写。返回值的类型取决于提供给 request.setHeader() 的参数 # [eve]-on() ***** HTTP的客户端对象事件 ### 参数说明 event: * 类型：字符层 * 默认值：无 * 描述：事件类型 * 可选值：[ abort | connect | continue | information | response | socket | timeout | upgrade ] # http.Server # listen() ***** 服务器开始监听端口 ### 参数说明 port: * 类型：整型 * 默认值：无 * 描述：需要监听的端口号 * 可选值：[ ] # [eve]-on() ***** HTTP的服务端对象事件 ### 参数说明 event: * 类型：字符层 * 默认值：无 * 描述：事件类型 * 可选值：[ request ] # close() ***** 关闭服务端 # http.IncomingMessage # [new]-IncomingMessage() ***** http.Server 或 http.ClientRequest 创建，并分别作为第一个参数传给 'request' 和 'response' 事件。它可用于访问响应状态、消息头、以及数据。 # headers ***** 请求头 # rowHeaders ***** 请求头原始数据 # url ***** 请求路径，包含query参数 # method ***** 请求方法名 # http.ServerResponse # [ext]-stream.Writable() ***** 可写入流 # [new]-ServerResponse() ***** 由 HTTP 服务器在内部创建，而不是由用户创建。它作为第二个参数传给 'request' 事件 # setHeader() ***** 设置响应头 # writeHead() ***** 写入响应头