程序开发API如何将本地资源上传到服务器

网友投稿 168 2024-07-14

上传

#uploadFile

基础库1.3.9开始支持,iOS版本2.1.23,Android版本2.1.38

小程序开发API如何将本地资源上传到服务器

uploadFile(Object object)

将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求,其中 content-type 为multipart/form-data。

调用后返回 UploadTask。

参数

Object object

属性类型默认值必填说明
urlstring
开发者服务器地址
filePathstring
要上传文件资源的路径
namestring
文件对应的 key,开发者在服务端可以通过这个 key 获取文件的二进制内容
headerObject
设置请求的 header,header 中不能设置 Referer
formDataObject
HTTP 请求中其他额外的 form data
timeoutnumber
超时时间,单位为毫秒
successfunction
接口调用成功的回调函数
failfunction
接口调用失败的回调函数
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)

object.success 回调函数

参数

Object res

属性类型说明
datastring开发者服务器返回的数据
statusCodenumber开发者服务器返回的 HTTP 状态码

示例代码

ft.chooseImage({
  success(res) {
    const tempFilePaths = res.tempFilePaths
    ft.uploadFile({
      url: 'https://example.weixin.qq.com/upload', // 仅为示例,非真实的接口地址
      filePath: tempFilePaths[0],
      name: 'file',
      formData: {
        user: 'test'
      },
      success(res) {
        const data = res.data        // do something
      }
    })
  }})
        已复制代码

#UploadTask.abort

基础库2.4.2开始支持,iOS版本2.13.59,Android版本2.13.34

UploadTask.abort()

中断请求任务

示例代码

const task = ft.request({
  // some params})// 中断请求task.abort()
        已复制代码

#UploadTask.onHeadersReceived

基础库2.4.2开始支持,iOS版本2.13.59,Android版本2.13.34

UploadTask.onHeadersReceived(function callback)

监听 HTTP Response Header 事件,会比请求完成事件更早。

参数

function callback

Header Received 事件的回调函数

回调函数参数

Object res

属性类型说明
headerObject开发者服务器返回的 HTTP Response Header

#UploadTask.offHeadersReceived

基础库2.4.2开始支持,iOS版本2.13.59,Android版本2.13.34

UploadTask.offHeadersReceived(function callback)

取消监听 HTTP Response Header 事件。

参数

function callback

Header Received 事件的回调函数

#UploadTask.onProgressUpdate

基础库2.4.2开始支持,iOS版本2.13.59,Android版本2.13.34

UploadTask.onProgressUpdate(function callback)

监听-进度变化事件。

参数

function callback

Progress Update 事件的回调函数

回调函数参数

Object res

属性类型说明
progressnumber上传进度百分比
totalBytesSentnumber已经上传的数据长度,单位 Bytes
totalBytesExpectedToSendnumber预期需要上传的数据总长度,单位 Bytes

示例代码

const task = ft.uploadFile({
  // some params})// 监听进度变化task.onProgressUpdate((res) => {
  this.setData({
    progress: res.progress  })})
        已复制代码

#UploadTask.offProgressUpdate

基础库2.4.2开始支持,iOS版本2.13.59,Android版本2.13.34

UploadTask.offProgressUpdate(function callback)

取消监听-进度变化。

参数

function callbackProgress Update 事件的回调函数

#Websocket

#sendSocketMessage

ft.sendSocketMessage(Object object)

通过 WebSocket 连接发送数据。需要先 ft.connectSocket,并在 ft.onSocketOpen 回调之后才能发送。

参数

Object object

属性类型默认值必填说明
datastring/ArrayBuffer
需要发送的内容
successfunction
接口调用成功的回调函数
failfunction
接口调用失败的回调函数
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)

示例代码

let socketOpen = falselet socketMsgQueue = []ft.connectSocket({
  url: 'test.php'})ft.onSocketOpen(function(res) {
  socketOpen = true
  for (let i = 0; i < socketMsgQueue.length; i++){
    sendSocketMessage(socketMsgQueue[i])
  }
  socketMsgQueue = []})function sendSocketMessage(msg) {
  if (socketOpen) {
    ft.sendSocketMessage({
      data:msg    })
  } else {
    socketMsgQueue.push(msg)
  }}
        已复制代码

#onSocketOpen

ft.onSocketOpen(function callback)

监听 WebSocket 连接打开事件

参数

function callback

WebSocket 连接打开事件的回调函数

参数

属性类型说明
headerobject连接成功的 HTTP 响应 Header

#onSocketMessage

ft.onSocketMessage(function callback)

监听 WebSocket 接受到服务器的消息事件

参数

function callback

WebSocket 接受到服务器的消息事件的回调函数

参数

Object res

属性类型说明
datastring/ArrayBuffer服务器返回的消息

#onSocketError

ft.onSocketError(function callback)

监听 WebSocket 错误事件

参数

function callback

WebSocket 错误事件的回调函数

参数

#Object res
属性类型说明
errMsgstring错误信息

#onSocketClose

ft.onSocketClose(function callback)

监听 WebSocket 连接关闭事件

参数

function callback

WebSocket 连接关闭事件的回调函数

参数

#Object res
属性类型说明
codenumber一个数字值表示关闭连接的状态号,表示连接被关闭的原因。
reasonstring一个可读的字符串,表示连接被关闭的原因。

#connectSocket

SocketTask ft.connectSocket(Object object)

创建一个 WebSocket 连接。使用前请注意阅读相关说明。

参数

Object object

属性类型默认值必填说明最低版本
urlstring
开发者服务器 wss 接口地址
headerObject
HTTP Header,Header 中不能设置 Referer
protocolsArray.<string>
子协议数组1.4.0
tcpNoDelaybooleanfalse建立 TCP 连接的时候的 TCP_NODELAY 设置2.4.0
perMessageDeflatebooleanfalse是否开启压缩扩展2.8.0
timeoutnumber
超时时间,单位为毫秒2.10.0
successfunction
接口调用成功的回调函数
failfunction
接口调用失败的回调函数
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)

返回值

SocketTask

WebSocket 任务

示例代码

ft.connectSocket({
  url: 'wss://example.qq.com',
  header:{
    'content-type': 'application/json'
  },
  protocols: ['protocol1']})
        已复制代码

#closeSocket

ft.closeSocket(Object object)

关闭 WebSocket 连接

参数

Object object

属性类型默认值必填说明
codenumber1000(表示正常关闭连接)一个数字值表示关闭连接的状态号,表示连接被关闭的原因。
reasonstring
一个可读的字符串,表示连接被关闭的原因。这个字符串必须是不长于 123 字节的 UTF-8 文本(不是字符)。
successfunction
接口调用成功的回调函数
failfunction
接口调用失败的回调函数
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)

示例代码

ft.connectSocket({
  url: 'test.php'})//注意这里有时序问题,//如果 ft.connectSocket 还没回调 ft.onSocketOpen,而先调用 ft.closeSocket,那么就做不到关闭 WebSocket 的目的。//必须在 WebSocket 打开期间调用 ft.closeSocket 才能关闭。ft.onSocketOpen(function() {
  ft.closeSocket()})ft.onSocketClose(function(res) {
  console.log('WebSocket 已关闭!')})
        已复制代码

#SocketTask

WebSocket 任务,可通过 ft.connectSocket() 接口创建返回

方法

  • SocketTask.send(Object object)
    通过 WebSocket 连接发送数据

  • SocketTask.close(Object object)
    关闭 WebSocket 连接

  • SocketTask.onOpen(function callback)
    监听 WebSocket 连接打开事件

  • SocketTask.onClose(function callback)
    监听 WebSocket 连接关闭事件

  • SocketTask.onError(function callback)
    监听 WebSocket 错误事件

  • SocketTask.onMessage(function callback)
    监听 WebSocket 接受到服务器的消息事件


版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。

上一篇:小程序开发API之下载请求(附代码示例)
下一篇:小程序开发API网络之TCP通信(附代码示例)
相关文章

 发表评论

暂时没有评论,来抢沙发吧~