×
微信小程序开发教程手册文档体验微信小程序微信小程序 框架MINA 目录结构小程序配置逻辑层(App Service)微信小程序 注册程序微信小程序 场景值微信小程序 注册页面微信小程序 路由微信小程序 模块化小程序 API视图层(View)微信小程序 WXML微信小程序 数据绑定微信小程序 列表渲染微信小程序 条件渲染微信小程序 模板微信小程序 事件微信小程序 引用微信小程序 WXS微信小程序 WXS模块微信小程序 变量微信小程序 注释微信小程序 运算符微信小程序 语句微信小程序 数据类型微信小程序 基础类库微信小程序 WXSS微信小程序 组件微信小程序 基础库微信小程序 兼容微信小程序 运行机制性能微信小程序 性能Trace工具微信小程序 优化建议微信小程序 组件

视图容器

wxapp视图容器 viewwxapp视图容器 scroll-viewwxapp视图容器 swiperwxapp视图容器 movable-areawxapp视图容器 cover-view

基础内容

wxapp内容组件 iconwxapp内容组件 textwxapp内容组件 rich-textwxapp内容组件 progress表单组件wxapp表单组件 buttonwxapp表单组件 checkboxwxapp表单组件 formwxapp表单组件 inputwxapp表单组件 labelwxapp表单组件 pickerwxapp表单组件 picker-viewwxapp表单组件 radiowxapp表单组件 sliderwxapp表单组件 switchwxapp表单组件 textarea

导航

wxapp导航 navigator

媒体组件

wxapp媒体组件 audiowxapp媒体组件 imagewxapp媒体组件 videowxapp媒体组件 camera

地图

wxapp地图 map

画布

wxapp画布 canvas

开放数据

wxapp开放数据 open-datawxapp承载网页 web-view

客服会话

wxapp客服会话 contact-buttonAPI网络微信小程序API 发起请求微信小程序API 上传、下载微信小程序API Websocket

媒体

微信小程序API 图片微信小程序API 录音微信小程序API 音频播放控制微信小程序API 音乐播放控制微信小程序API 背景音频播放管理微信小程序API 音频组件控制微信小程序API 视频微信小程序API 视频组件控制微信小程序API 相机组件控制

文件

微信小程序API 文件

数据

微信小程序API 数据缓存

位置

微信小程序API 获取位置微信小程序API 查看位置微信小程序API 地图组件控制设备微信小程序API 系统信息微信小程序API 网络状态微信小程序API 加速度计微信小程序API 罗盘微信小程序API 拨打电话微信小程序API 扫码微信小程序API 剪贴板微信小程序API 蓝牙微信小程序API iBeacon微信小程序API 屏幕亮度微信小程序API 用户截屏事件微信小程序API 振动微信小程序API 手机联系人

界面

微信小程序API 交互反馈微信小程序API 设置导航条微信小程序API 设置置顶信息微信小程序API 导航微信小程序API 动画微信小程序API 位置绘图微信小程序API 绘图·介绍微信小程序API 绘图·坐标系微信小程序API 绘图·渐变微信小程序API 绘图·颜色微信小程序API 绘图上下文微信小程序API 绘图·创建并返回上下文微信小程序API 绘图·绘制画布微信小程序API 绘图·导出图片微信小程序API 绘图·设置填充样式微信小程序API 绘图·设置线条样式微信小程序API 绘图·设置阴影样式微信小程序API 绘图·创建线性渐变微信小程序API 绘图·创建圆形渐变微信小程序API 绘图·创建颜色渐变点微信小程序API 绘图·设置线条宽度微信小程序API 绘图·设置线条端点样式微信小程序API 绘图·设置线条交点样式微信小程序API 绘图·设置最大倾斜微信小程序API 绘图·创建矩形微信小程序API 绘图·填充矩形微信小程序API 绘图·画一个矩形微信小程序API 绘图·clearRect微信小程序API 绘图·填充路径微信小程序API 绘图·描边路径微信小程序API 绘图·开始路径微信小程序API 绘图·关闭路径微信小程序API 绘图·moveTo微信小程序API 绘图·lineTo微信小程序API 绘图·画弧线微信小程序API 绘图·quadraticCurveTo微信小程序API bezierCurveTo微信小程序API 绘图·scale微信小程序API 绘图·rotate微信小程序API 绘图·translate微信小程序API 绘图·设置字号微信小程序API 绘图·绘制文本微信小程序API 绘图·文字对齐微信小程序API 绘图·文字水平对齐微信小程序API 绘图·drawImage微信小程序API 绘图·setGlobalAlpha微信小程序API 绘图·保存/恢复微信小程序API 绘图·draw微信小程序API 绘图·getActions微信小程序API 绘图·clearActions微信小程序API 绘图·measureText微信小程序API 绘图·globalCompositeOperation微信小程序API 绘图·arcTo微信小程序API 绘图·strokeText微信小程序API 绘图·lineDashOffset微信小程序API 绘图·createPattern微信小程序API 下拉刷新

WXML节点信息

微信小程序API WXML节点信息

第三方平台

微信小程序API 第三方平台

开放接口

微信小程序API 登录微信小程序API 签名加密微信小程序API 授权微信小程序API 用户信息微信小程序API 微信支付微信小程序API 模板消息

微信小程序API 客服消息

微信小程序API 接收消息和事件微信小程序API 发送客服消息微信小程序API 转发消息微信小程序API 临时素材接口微信小程序API 接入指引微信小程序API 转发微信小程序API 二维码微信小程序API 收货地址微信小程序API 卡券微信小程序API 设置微信小程序API 微信运动微信小程序API 打开小程序微信小程序API 获取发票抬头微信小程序API 生物认证

数据

常规分析

微信小程序API 数据概况微信小程序API 访问分析微信小程序API 用户画像

自定义分析

微信小程序API 自定义数据上报

更新

微信小程序API getUpdateManager

拓展接口

微信小程序 拓展接口

多线程

微信小程序API createWorker

调试接口

微信小程序API 打开/关闭调试

工具

微信小程序工具 概览微信小程序工具 界面微信小程序工具 设置微信小程序工具 项目预览微信小程序工具 快捷键微信小程序工具 代码编辑微信小程序工具 程序调试微信小程序工具 特殊API的调试微信小程序工具 命令行调用微信小程序工具 HTTP调用微信小程序工具 代码片段微信小程序工具 第三方平台微信小程序工具 创建插件项目微信小程序工具 代码托管微信小程序工具 素材管理微信小程序工具 下载微信小程序工具 细节点微信小程序工具 beta版本下载微信小程序工具 Git版本管理微信小程序工具 体验评分微信小程序工具 npm支持

微信小程序 云开发

微信小程序云开发 基础

微信小程序云开发指引

微信小程序云开发 开发指引微信小程序云开发 控制台微信小程序云开发 初始化微信小程序云开发 数据库微信小程序云开发 存储微信小程序云开发 云函数微信小程序云开发参考信息

微信小程序云开发API 小程序端

微信小程序云开发API 初始化微信小程序云开发 数据库API数据库API database数据库API collection数据库API collection.doc数据库API collection.get数据库API doc.get数据库API collection.add数据库API collection.update数据库API doc.update数据库API doc.set数据库API doc.remove数据库API collection.count数据库API collection.where数据库API collection.orderBy数据库API collection.limit数据库API collection.skip数据库API collection.field数据库API db.command数据库API db.RegExp数据库API db.serverDate数据库API db.Geo数据库API 查询筛选条件数据库API 查询指令数据库API 更新指令数据库API get方法数据库API update数据库API remove微信小程序云开发API 服务端云开发服务端API 初始化云开发服务端API 工具类云开发服务端API 数据库服务端数据库API database服务端数据库API collection服务端数据库API collection.doc服务端数据库API collection.get服务端数据库API doc.get服务端数据库API collection.add服务端数据库API collection.update服务端数据库API collection.remove服务端数据库API doc.update服务端数据库API doc.set服务端数据库API doc.remove服务端数据库API collection.count服务端数据库API collection.where服务端数据库API collection.orderBy服务端数据库API collection.limit服务端数据库API collection.skip服务端数据库API collection.field服务端数据库API db.command服务端数据库API db.RegExp服务端数据库API db.serverDate服务端数据库API db.Geo服务端数据库API 查询筛选条件服务端数据库API 查询指令服务端数据库API 更新指令服务端数据库API db.createCollection服务端数据库API update服务端数据库API remove云开发服务端API 存储服务端存储API uploadFile服务端存储API downloadFile服务端存储API getTempFileURL服务端存储API deleteFile微信小程序开发文档-腾讯云支持微信小程序 联系我们微信小程序 Q&A微信小程序设计规范微信小程序设计规范(1) 友好礼貌微信小程序设计规范(2) 清晰明确微信小程序设计规范(3) 便捷优雅微信小程序设计规范(4) 统一稳定微信小程序设计规范(5) 视觉规范微信小程序源码分享微信小游戏开发手册 

微信小程序API 上传、下载


wx.uploadFile(OBJECT)


将本地资源上传到开发者服务器。如页面通过 wx.chooseImage 等接口获取到一个本地资源的临时文件路径后,可通过此接口将本地资源上传到指定服务器。客户端发起一个HTTPS POST请求,其中Content-Typemultipart/form-data

OBJECT参数说明:

参数 类型 必填 说明
url String 开发者服务器url
filePath String 要上传文件资源的路径
name String 文件对应的key , 开发者在服务器端通过这个key可以获取到文件二进制内容
header Object HTTP 请求 Header,header中不能设置Referer
formData Object HTTP 请求中其他额外的form data
success Function 接口调用成功的回调函数
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

success返回参数说明:

参数 类型 说明
data String 开发者服务器返回的数据
statusCode Number HTTP状态码

示例代码:

wx.chooseImage({
  success:function(res){
    var tempFilePaths = res.tempFilePaths
    wx.uploadFile({
      url: 'http://example.weixin.qq.com/upload', //仅为示例,非真实的接口地址
      filePath: tempFilePaths[0],
      name:"file",
      formData:{
        "user":"test"
      }      success: function(res){        var data = res.data        //do something      }
    })
  }
})

返回值:

基础库 1.4.0 开始支持,低版本需做兼容处理

返回一个uploadTask对象,通过uploadTask,可监听上传进度变化事件,以及取消上传任务。

uploadTask

uploadTask 对象的方法列表:

方法 参数 说明 最低版本
onProgressUpdate callback 监听上传进度变化 1.4.0
abort   中断上传任务 1.4.0

onProgressUpdate 返回参数说明:

参数 类型 说明
progress Number 上传进度百分比
totalBytesSent Number 已经上传的数据长度,单位 Bytes
totalBytesExpectedToSend Number 预期需要上传的数据总长度,单位 Bytes

示例代码:

const uploadTask = wx.uploadFile({
    url: 'http://example.weixin.qq.com/upload', //仅为示例,非真实的接口地址
    filePath: tempFilePaths[0],
    name: 'file',
    formData:{
        'user': 'test'
    },
    success: function(res){
        var data = res.data
        //do something
    }
})

uploadTask.onProgressUpdate((res) => {
    console.log('上传进度', res.progress)
    console.log('已经上传的数据长度', res.totalBytesSent)
    console.log('预期需要上传的数据总长度', res.totalBytesExpectedToSend)
})

uploadTask.abort() // 取消上传任务

Bug & Tip

  1. tip: 最大并发限制是 10 个
  2. tip: 默认超时时间和最大超时时间都是 60s

wx.downloadFile(OBJECT)


下载文件资源到本地。客户端直接发起一个HTTP GET请求,返回文件的本地临时路径。

OBJECT参数说明:

参数 类型 必填 必填
url String 下载资源的 url
header Object HTTP 请求 Header
success Function 下载成功后以 tempFilePath 的形式传给页面,res={tempFilePath:'文件的临时路径'}
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

注:文件的临时路径,在小程序本次启动期间可以正常使用,如需持久保存,需在主动调用 wx.saveFile,在小程序下次启动时才能访问得到。

示例代码:

wx.downloadFile({
  url: 'http://example.com/audio/123', //仅为示例,并非真实的资源
  success: function(res) {
    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

  1. tip: 最大并发限制是 10 个
  2. tip: 默认超时时间和最大超时时间都是 60s
  3. tip: 网络请求的 referer 是不可以设置的,格式固定为 https://servicewechat.com/{appid}/{version}/page-frame.html,其中{appid}为小程序的 appid,{version}为小程序的版本号,版本号为 0 表示为开发版。
  4. tip: 6.5.3 以及之前版本的 iOS 微信客户端header设置无效


分类导航

关注微信下载离线手册

bootwiki移动版 bootwiki
(群号:472910771)