上传

优质

小牛编辑

145浏览

2023-12-01

UploadTask jd.uploadFile(Object object)

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

参数

Object object

属性	类型	必填	说明
url	string	是	开发者服务器地址
filePath	string	是	要上传文件资源的路径 (本地路径)
name	string	是	文件对应的 key，开发者在服务端可以通过这个 key 获取文件的二进制内容
header	Object	否	HTTP 请求 Header，Header 中不能设置 Referer
formData	Object	否	HTTP 请求中其他额外的 form data
timeout	number	否	超时时间，单位为毫秒
success	function	否	接口调用成功的回调函数
fail	function	否	接口调用失败的回调函数
complete	function	否	接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数 Object res

属性	类型	说明
data	string	开发者服务器返回的数据
statusCode	number	开发者服务器返回的 HTTP 状态码

返回值

UploadTask 一个可以监听上传进度进度变化的事件和取消上传的对象

UploadTask

方法

UploadTask.abort()

中断上传任务

UploadTask.offHeadersReceived(function callback)

取消监听 HTTP Response Header 事件

参数

function callback HTTP Response Header 事件的回调函数

UploadTask.offProgressUpdate(function callback)

取消监听上传进度变化事件

参数

function callback 上传进度变化事件的回调函数

UploadTask.onHeadersReceived(function callback)

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

参数

function callback HTTP Response Header 事件的回调函数

参数 Object res

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

UploadTask.onProgressUpdate(function callback)

监听上传进度变化事件

参数

function callback 上传进度变化事件的回调函数

参数 Object res

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

示例代码

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

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

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