跳到主要内容

FTP 文件下载 (ftp.download)

声明

下载成败, 下载信息 = ftp.download(URL, 本地文件路径 [, 连接超时秒, 断点续传模式, 分块回调函数, 缓冲区尺寸 ])

参数

  • URL
    文本型,远端文件地址,账号及密码被包含在这一参数中
  • 本地文件路径
    文本型,需要保存到的本地路径
  • 连接超时秒
    实数型,可选参数,连接超时时间,单位秒,默认 10
  • 断点续传模式
    布尔型,可选参数,是否需要支持断点续传,是为 true,否为 false,默认 false
  • 分块回调函数
    函数型,可选参数,分块回调函数,每下载完一个分块都会回调一次这个函数,默认 空函数
    分块回调函数第一个参数为当前下载的信息,回调函数返回 true 则打断这次下载
  • 缓冲区尺寸
    整数型,可选参数,缓冲区大小字节数,默认自动最优配置

返回值

  • 下载成败
    布尔型,连接是否成功
  • 下载信息
    表型 或 文本型,如果连接成功则返回表型下载信息,否则返回连接失败原因文本描述

说明

-- 第二个返回值下载信息结构如下
{
resource_size = 远端资源总字节数,
start_pos = 本次下载从资源的开始的位置,
size_download = 本次下载的字节数,
speed_download = 本次下载的速度 (单位:字节/) ,
}

这个函数适合大文件下载,在传输的过程中停止脚本可能会缓慢
这个函数可能会让出,在这个函数返回之前,其它的 线程 可能会得到运行机会

简单示例

账号密码写在 URL 中,具体 URL 格式如下 (中括号内是可选参数)

ftp://[账号:密码@]地址[:端口]/路径

账号或密码中包含 @:/ 这三个字符可分别用 %40%3A%2F (若还有其它 URL 中不能包含的字符可使用 URLEncode 进行编码) 例如账号是 havonz 密码是 11@@22 参考下例

local done, info = ftp.download("ftp://havonz:11%40%[email protected]/1.zip", "/var/mobile/1.zip")
if (done) then
sys.alert("如果没有意外,已经下载好了")
else
sys.alert("连接失败:"..info)
end

复杂示例

local done, info = ftp.download("ftp://havonz:[email protected]/1.zip", "/var/mobile/1.zip", 10, true, function(binfo)
local percent = math.floor(((binfo.start_pos + binfo.size_download) / binfo.resource_size) * 100)
sys.toast("下载进度 "..percent.."%")
end, 4096 * 1024)
--
if (done) then
if (info.start_pos + info.size_download < info.resource_size) then
sys.alert(
"下载中断\n本次下载 "..info.size_download.." 字节"
.."\n从第 "..info.start_pos.." 字节开始下载"
.."\n平均速度为 "..math.floor(info.speed_download/1024).." kB/s"
.."\n还有剩 "..(info.resource_size - (info.start_pos + info.size_download)).." 字节"
)
else
sys.alert(
"下载完成\n本次下载 "..info.size_download.." 字节"
.."\n从第 "..info.start_pos.." 字节开始下载"
.."\n平均速度为 "..math.floor(info.speed_download/1024).." kB/s"
)
end
else
sys.alert("连接失败:"..info)
end

:上述代码中使用了非本章函数 sys.alertsys.toast