跳到主要内容

发起 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