阅读 2227

换个姿势上传?el-upload + qiniu-js 的实现

关于element-uiel-upload,实际上issue中提到的次数也不少,很多初试者可能 get 不到愉快使用的点,提了issue之后又大多因为规范问题直接被机器人过滤或者关闭。例如最近一次相关的issue是想寻求关于http-request的使用,但也因为规范问题被直接关闭。所以我们就稍微做一个比较接地气的业务类分享。

0. 我们要什么?

这个问题就简单了:首先,我们需要一个好看的皮囊!那Vue基本没得选了,element-uiel-upload很符合口味。其次,我们需要一个有趣的灵魂,我们是使用七牛的对象存储的,但我们的想法是想使用qiniu-js这个官方的SDK。因为el-upload开放了请求方法的自定义,所以我们改造一下。

1. 我们怎么做?

qiniu-js SDK

直接就看文档了。

实际上为什么要直接用七牛的 SDK 而不是组件带的请求方法将就用一下就好呢?这里我有两点可以解释:稳定,懒。七牛放出来的东西肯定更适合他们自己的服务,所以自己安排action啊或者data什么的可能会安排错,那还不如直接按照他们给出的方式来做就行了。比如分片,如果只是从使用角度来看,直接用SDK的话我就不用去关心到底要怎么分,要怎么上传,要怎么结合成一个文件。我只需要让后端把上传策略都做好放出一个token,剩下的就什么都不用做了。还有浏览器方面,既然跟Vue一起使用了,那么琐事webpack已经帮我们处理了,我们根本不用关心。

好了关于安装和引入就跳过了,直接看方法如何调用。简单看它的上传是以观察者形式,通过qiniu.upload注册一个方法,通过该方法进行订阅即上传操作,取消订阅即取消上传操作。而观察者又会拆分出三个方法:next, error, complete,简单说就是管过程,错误以及完成情况。这部分可以直接依据文档写:

const observable = qiniu.upload(file, key, token, putExtra, config)
const subscription = observable.subscribe(next, error, complete) // 上传开始

// subscription.unsubscribe() 这个方法可以取消操作
复制代码

next方法接收一个参数,这个参数包含各种上传进度信息:

const next = ({ total }) => {
  // 
  const {
    loaded, // 已上传大小,单位为字节。
    total,  // 本次上传的总量控制信息,单位为字节
    percent // 当前上传进度,范围:0~100
  } = total
};
复制代码

所以如果你没有什么特殊需求的话,只需要percent能捕获进度就行了。

complete接收一个参数,当上传完整之后,服务器按照配置给你返回的内容,具体显示什么都看自己的后端如何配置。

error顾名思义就是当上传出现错误的时候做出处理,对错误的处理也是因人而异,直接看文档就行。

至此先保留,再看el-upload

el-upload

我建议是去瞟一眼el-upload源码,这样也方便理解,当一个文件拖入或添加到组件的时候,好看的皮囊和有趣的灵魂是如何协调工作的。如果只是想理解上传的方式,只看有出现ajax的两个文件就行:一个是ajax.js还有一个是upload.vue

如果你说:我不想看源码!然后又想能跟你写的请求方法结合,可以!有一个蠢方法:先定义一个方法接收一个参数,这个方法直接向uploadhttp-request进行绑定:

{
  template: `<el-upload :http-request="request" />`
  methods: {
    request(obj) { console.log(obj) }
  }
}
复制代码

至此你就能看到el-upload打包的所有请求信息的了,你就可以根据这个好看的皮囊设计灵魂了。(有一个issue提到关于headerdata的问题,实际上都会包含在这之中)

但我还是建议可以看一下源码,因为你看了源码之后你就会发现一些细节等下可以用到,比如upload.vue133~143这几行代码:

onProgress: e => {
  this.onProgress(e, rawFile);
},
onSuccess: res => {
  this.onSuccess(res, rawFile);
  delete this.reqs[uid];
},
onError: err => {
  this.onError(err, rawFile);
  delete this.reqs[uid];
}
复制代码

而这个时候你就能会知道:噢!我等下可以利用到这个皮囊的进度条显示,成功以及失败的处理。并不需要自己再去引入更多的组件或者更多的回调操作。甚至如果以后不再用“七牛”作为请求方法,组件也可复用不用修改。所以#8291就有点可惜了,如果他还没找到方法的话希望这篇文章可以帮到他。

3. merge

弄清楚之后,就是把他们“揉起来”。对于el-upload能用的信息我们已经清楚,剩下的关于业务上的操作就移步element的官方文档即可。我们来制造灵魂,在此之前注释一下:我们团队是非常强调规范和拥抱classes + TypeScript这种方式的,但写这篇文章的人是比较喜欢直接用JavaScript,而且应该更多人需要的是后者所以本次产出的“渣代码”用JavaScript,那么:

// upload.js

// token 找后端,obj 这里指代从 el-upload 接收到的 object
export const upload = token => obj => {
  const { file } = obj 

  // 关于 key 要怎么处理自行解决,但如果为 undefined 或者 null 会使用上传后的 hash 作为 key.
  const key = "" 
  
  // 因人而异,自行解决
  const putExtra = {},
        config   = {} 

  const observable = qiniu.upload(file, key, token, putExtra, config)

  // 刚刚得到的信息可以使用了,这样可以使用到 el-upload 的进度条
  const next = ({ total }) => obj.onProgress({ percent: total.percent })

  const error = err => obj.onError(err)

  const complete = res => obj.onSuccess(res)

  const subscription = observable.subscribe(next, error, complete)
  return subscription // 返回以方便取消上传操作
}
复制代码
Vue.component('upload', {
  template: `<el-upload :http-request="request" />`
  methods: {
    request(obj) {
      // 你怎么搞到token我不管!
      const uploader = upload(token)
      const subscription = uploader(obj) 
    }
  }
})
复制代码

这是一个抛砖引玉的操作,大致上就只有这样了,剩下全靠爱和定制就完事儿了!

关注下面的标签,发现更多相似文章
评论