下载文件资源到本地,客户端直接发起一个 HTTP GET 请求,返回文件的本地临时路径。
OBJECT参数说明:
参数 | 类型 | 必填 | 必填 |
---|---|---|---|
url | String | 是 | 下载资源的 url |
header | Object | 否 | HTTP 请求 Header,header 中不能设置 Referer |
success | Function | 否 | 下载成功后以 tempFilePath 的形式传给页面,res = {tempFilePath: '文件的临时路径'} |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
注:文件的临时路径,在小程序本次启动期间可以正常使用,如需持久保存,需在主动调用 wx.saveFile,才能在小程序下次启动时访问得到。
success返回参数说明:
参数 | 类型 | 说明 |
---|---|---|
tempFilePath | String | 临时文件路径,下载后的文件会存储到一个临时文件 |
statusCode | Number | 开发者服务器返回的 HTTP 状态码 |
示例代码:
wx.downloadFile({ url: 'https://example.com/audio/123', //仅为示例,并非真实的资源 success: function (res) { // 只要服务器有响应数据,就会把响应内容写入文件并进入 success 回调,业务需要自行判断是否下载到了想要的内容 if (res.statusCode === 200) { wx.playVoice({ filePath: res.tempFilePath }) } } });
返回值:
基础库 1.4.0 开始支持,低版本需做兼容处理
返回一个 downloadTask
对象,通过 downloadTask
,可监听下载进度变化事件,以及取消下载任务。
downloadTask
downloadTask 对象的方法列表:
方法 | 参数 | 说明 | 最低版本 |
---|---|---|---|
onProgressUpdate | callback | 监听下载进度变化 | 1.4.0 |
abort | 中断下载任务 | 1.4.0 |
onProgressUpdate 返回参数说明:
参数 | 类型 | 说明 |
---|---|---|
progress | Number | 下载进度百分比 |
totalBytesWritten | Number | 已经下载的数据长度,单位 Bytes |
totalBytesExpectedToWrite | Number | 预期需要下载的数据总长度,单位 Bytes |
示例代码:
const downloadTask = wx.downloadFile({ url: 'http://example.com/audio/123', //仅为示例,并非真实的资源 success: function (res) { wx.playVoice({ filePath: res.tempFilePath }); }, }); downloadTask.onProgressUpdate((res) => { console.log('下载进度', res.progress); console.log('已经下载的数据长度', res.totalBytesWritten); console.log('预期需要下载的数据总长度', res.totalBytesExpectedToWrite); }); downloadTask.abort(); // 取消下载任务
Bug & Tip
tip
: 6.5.3 以及之前版本的 iOS 微信客户端 header
设置无效