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() ***** 寫入響應頭