跳至主要內容

發起 HEAD 請求 (http.head)

聲明​

HTTP 狀態碼, 返回頭 JSON 文字 = http.head(URL [, 超時秒, 請求頭, URL 不 ESCAPE ])

聲明（命名參數）​

20250625 支援，20260402 以後版本支援進度參數

HTTP 狀態碼, 返回頭 JSON 文字 = http.head{
    url = URL;
    timeout = 超時秒;
    headers = 請求頭;
    params = Query 參數;
    progress = 進度回調函式;
    progress_interval_ms = 進度回調間隔毫秒;
}

參數​

  • URL
    文字型，需要請求的 URL 地址，該方法預設會對 URL 進行 escape 處理，如不需要可參考 URL 不 ESCAPE 參數說明
  • 超時秒
    實數型，可選參數，請求超時時間，單位秒，預設 10
  • 請求頭
    表型，可選參數，發出的請求的頭部資訊，形式 {field1 = value1, field2 = value2, ...}，預設 {}
  • Query 參數
    表型，可選參數，發出的請求的 Query 參數，形式 {field1 = value1, field2 = value2, ...}，預設 {}
  • 進度回調函式
    函式型，可選參數，20260402 以後版本支援。請求進度變化時呼叫，回調函式第一個參數為目前進度資訊
  • 進度回調間隔毫秒
    整數型，可選參數，20260402 以後版本支援。控制進度回調觸發間隔，單位毫秒
  • URL 不 ESCAPE
    布林型，可選參數，true 表示不對 URL 進行 escape 直接請求，預設 false
    對 URL 進行自訂 escape 可參考 lcurl 模組 的 easy:escape、easy:unescape

回傳值​

  • HTTP 狀態碼
    整數型，返回當次請求的 http 狀態碼，請求超時返回 -1
  • 返回頭 JSON 文字
    文字型 或 nil，請求完成返回的 JSON 形式頭部資訊，請求超時返回 nil

說明​

使用 HTTP/1.1 協定的 HEAD 方法請求取得網路資源的頭部資訊
HEAD 協定通常和 GET 請求會獲得同樣的返回頭，但 HEAD 請求不會返回實際主體內容
該函式可能會讓出，在其返回之前，其他 執行緒 可能會得到運行機會

進度回調函式接收的 info 結構如下：

{
    count_of_bytes_sent = 已發送位元組數;
    count_of_bytes_expected_to_send = 預計需要發送位元組數;
    count_of_bytes_received = 已接收位元組數;
    count_of_bytes_expected_to_receive = 預計需要接收位元組數;
}

範例​

local c, h = http.head("https://www.xxtouch.app/测试文本.txt")
if c==200 then -- 如果返回的狀態碼是 HTTP_OK
    sys.alert(h) -- 輸出請求到的頭信息
end

注：上述代碼中使用了非本章函式 sys.alert