基于vue-simplemde实现图片拖拽、粘贴功能的一些思考

前言

项目使用的是vue框架，需要一个markdown的编辑框，就在npm上找了一下，发现simplemde挺不错的，由于我比较懒，就顺便在npm又搜了一下，找到了vue-simplemde这个package，那就开始使用它吧。

但是这个vue-simplemde不支持图片拖拽上传、粘贴上传，也不能说是因为这个vue-simplemde，因为vue-simplemde只是对simplemde的基础上封装成一个Vue插件。所以最后还是由于simplemde没有提供相关的功能，但是为了用户体验考虑，这个功能时必要的，除非不使用markdown编辑器。而去使用富文本编辑器，那样的话，项目很多的代码都要进行更改。所以就在网上查了文章，及在github上查了一些代码。下面将进行分析

拖拽

拖拽的API核心是drop这个事件，就是当我们从桌面拖动一个文件到浏览器里时，松开的时候，而触发的事件名。

我们都知道，你随便拖动一个图片到浏览器里，会直接打开这个图片，这是因为浏览器默认你拖动文件到浏览器里时，将打开这个文件，所以，我们需要阻止原生的操作。

我们现在先写一段代码，让其屏蔽掉默认事件

window.addEventListener("drop", e => {
  e = e || event
  if (e.target.className === 'CodeMirror-scroll') { // 如果进入到编辑器的话，将阻止默认事件
    e.preventDefault()
  }
}, false)
复制代码

CodeMirror-scroll这个Class就是simplemde编辑框的Class名称。

现在我们拖拽文件到这个编辑框，然后松掉，不会出现任何反应。如果在编辑框之外的地方，还是会继续触发默认事件。

下面就是获取simplemde方法，给他drop事件处理方法。

// 假设页面一共有三个编辑窗口，所以需要循环监听事件
[ this.$refs.simplemde1,
  this.$refs.simplemde2,
  this.$refs.simplemde3
].map(({simplemde}) => {
  simplemde.codemirror.on('drop', (editor, e) => {
    if (!(e.dataTransfer && e.dataTransfer.files)) {
      // 弹窗说明，此浏览器不支持此操作
      return
    }

    let dataList = e.dataTransfer.files
    let imageFiles = [] // 要上传的文件实例数组

    // 循环，是因为可能会同时拖动几个图片文件
    for (let i = 0; i < dataList.length; i++) {
    // 如果不是图片，则弹窗警告 仅支持拖拽图片文件
      if (dataList[i].type.indexOf('image') === -1) {
        // 下面的continue，作用是，如果用户同时拖动2个图片和一个文档，那么文档不给于上传，图片照常上传。
        continue
      }
      imageFiles.push(dataList[i])  // 先把当前的文件push进数组里，等for循环结束之后，统一上传。
    }
    // uploadImagesFile方法是上传图片的方法
    // simplemde.codemirror的作用是用于区分当前的图片上传是处于哪个编辑框
    this.uploadImagesFile(simplemde.codemirror, imageFiles)
    // 因为已经有了下面这段代码，所以上面的屏蔽默认事件代码就不用写了
    e.preventDefault()
  })
})
复制代码

诈一看，代码好像有点多，那是因为注释的原因，下面是没有注释的代码。你可以根据下面的代码，有自己的见解和理解：

[ this.$refs.simplemde1,
  this.$refs.simplemde2,
  this.$refs.simplemde3
].map(({simplemde}) => {
  simplemde.codemirror.on('drop', (editor, e) => {
    if (!(e.dataTransfer && e.dataTransfer.files)) {
      return
    }
    let dataList = e.dataTransfer.files
    let imageFiles = []
    for (let i = 0; i < dataList.length; i++) {
      if (dataList[i].type.indexOf('image') === -1) {
        continue
      }
      imageFiles.push(dataList[i])
    }
    this.uploadImagesFile(simplemde.codemirror, imageFiles)
    e.preventDefault()
  })
})
复制代码

粘贴

粘贴的API是paste方法，这个不像上面一样，粘贴不需要禁止默认事件，因为我们可以看到，你复制一个图片，到浏览器里按下ctrl+v的时候，是不会发生任何变化的，所以没用必要禁止默认事件。

下面是代码:

simplemde.codemirror.on('paste', (editor, e) => { // 粘贴图片的触发函数
  if (!(e.clipboardData && e.clipboardData.items)) {
    // 弹窗说明，此浏览器不支持此操作
    return
  }
  try {
    let dataList = e.clipboardData.items
    if (dataList[0].kind === 'file' && dataList[0].getAsFile().type.indexOf('image') !== -1) {
      this.uploadImagesFile(simplemde.codemirror, [dataList[0].getAsFile()])
    }
  } catch (e) {
    // 弹窗说明，只能粘贴图片
  }
})
复制代码

之所以这里写上try...catch方法，是因为如果你粘贴的时候，如果是一个文件，items将是空的，而在下面的if循环里，使用dataList[0].kind。也就是e.clipboardData.items[0].kind。当item为空时，还去访问一个不存的kind属性时，就会报错了。所以这里需要使用try...catch方法进行判断。

dataList[0].getAsFile().type.indexOf('image') !== -1这个句话是判断，粘贴的东西确认是图片，而不是其他东西。

if里的上传图片，不一样的地方是[dataList[0].getAsFile()]，因为为了统一格式，方便uploadImagesFile函数进行处理，我加上了[]，使之成为数组。dataList[0].getAsFile()就是获取文件实例了。

上传

上传就有一点麻烦了：

uploadImagesFile (simplemde, files) {
  // 把每个文件实例使用FormData进行包装一下，然后返回一个数组
  let params = files.map(file => {
    let param = new FormData()
    param.append('file', file, file.name)
    return param
  })

  let makeRequest = params => {
    return this.$http.post('/Api/upload', params)
  }
  let requests = params.map(makeRequest)

  this.$http.spread = callback => {
    return arr => {
      return callback.apply(null, arr)
    }
  }

  // 服务端返回的格式是{state: Boolean, data: String}
  // state为false时，data就是返回的错误信息
  // state为true时，data是图片上传后url地址，这个地址是针对网站的绝对路径。如下：
  // /static/upload/2cfd6a50-3d30-11e8-b351-0d25ce9162a3.png
  Promise.all(requests)
    .then(this.$http.spread((...resps) => {
      for (let i = 0; i < resps.length; i++) {
        let {state, data} = resps[i].data
        if (!state) {
          // 弹窗显示data的错误信息
          continue
        }
        let url = `![](${location.origin + data})`  // 拼接成markdown语法
        let content = simplemde.getValue()
        simplemde.setValue(content + url + '\n')  // 和编辑框之前的内容进行拼接
      }
    }))
}
复制代码

因为我是把axiox封装成vue插件来使用，这样会导致，this.$http是实例化后的，而不是他本身。 axios维护者说的解决方案是，重新引入axios包，来使用。但是我觉得没有必要。axios.all内部是Promise.all。axios.spread实现代码比较少，就直接拿过来，重新赋值给axios就好了

所以上面有段代码是

Promise.all(requests)
  .then(this.$http.spread((...resps) => {
    // code
  })
复制代码

把这段代码翻译一下就是

axios.all(requests)
  .then(axios.spread((...resps) => {
    // code
  })
复制代码

关于这个问题，请看下官方的解释：axios-all-is-not-a-function-inside-vue-component。也可以看下axios的代码：axios.js#L45-L48

这个问题，暂时就不深究了，我们回到刚刚的话题上。

上面我说到当state为true时，data是文件相对于网站的绝对路径，如: /static/upload/2cfd6a50-3d30-11e8-b351-0d25ce9162a3.png

如果我们需要进行拼接一下，所以就有了![](${location.origin + data})这段代码进行拼接。最后的两行是获取指的获取之前的内容，然后在追加url地址。

结尾

下面是最终的效果图，因为掘金无法上传gif图片。所以就直接附上动态图连接: 7xppwd.com1.z0.glb.clouddn.com/2b971f90-3d…

完整代码：Subject.vue#L378-L465

参考 && 感谢

skecozo作者的laravel-demo项目里的部分代码

Lemon作者的《simplemde 实现拖拽、粘贴图片上传》文章

f-loat作者的vue-simplemde项目

wescossick作者的simplemde项目