最近做的是一个前后台分离的项目,而Ueditor上传图片是要与服务器后台交互,所以一直找一个简单的方法,能让ueditor直接上传图片到七牛云,然后ueditor引入图片链接就好了。上传图片不经过自己应用后台,提高系统的吞吐量。
该效果的原理是使用自定义工具触发js上传到七牛云,并添加到ueditor的内容中
效果演示
使用自定义工具栏上传图片到七牛云,先看看演示效果
工具栏上添加了一个插入图片的按钮,这个按钮的图片是上传到到七牛云的,点击这个按钮
出现选择图片按钮,点击打开,这时候就可以看到图片添加到编辑内容区域了
并且这个图片链接是引用七牛云的
实现原理
首先是添加自定义工具栏按钮,需要编写以下几步代码:
注:不要用min.js,否则无法修改源码
(1)启用自定义按钮:在ueditor.config.js配置中添加自定义的按钮名称,这里我取名为qiniuimage
(2)添加自定义按钮到ueditor,在ueditor.all.js中搜btnCmds即可:
(3)添加自定义按钮的注释:注意看文件和对应位置,我都做了标注
(4)自定义按钮图片定义:注意看文件路径,ueditor.css,这里我复制了一下之前图片按钮的样式,这里说明一下,ueditor所有的工具栏按钮图片在一个png里面,默认都加上了background-image属性,所以我直接用了现成的图片,直接指定工具栏所处位置就好了,这里的 -380px 0px 就是image图片标识的位置
(5)添加自定义按钮的相应js事件:这里解释一下,在ueditor.all.js里面通过UE.commands['按钮名']添加按钮响应事件,我直接复制了打印(print)的事件代码修改了下
好,至此按钮添加完成了,现在已经可以在ueditor上看到新定义的按钮了。可以看到,我的js就是触发上传按钮的单击事件,我界面上还有个上传按钮(因为我界面有多个上传图片的地方),具体内容参看后文
注意:必须引用非min.js,即ueditor.all.js
讲到这里我普及一下三个点,针对于对七牛云原生api不熟的
(1) 七牛云上传必须关联一个input为file的按钮,你选择这个按钮,上传完会触发七牛FileUploaded事件,重要的事情说三遍,
必须关联一个input为file的按钮,必须关联一个input为file的按钮,必须关联一个input为file的按钮
(2)上面我这个app.putDataBuffer是我的一个自定义方法,请无视,主要用来保存我的想要添加图片的位置的
(3)流程图
下面来讲解一下如何上传图片到到七牛云,首先根据官方sdk文档,copy了一下代码,并对其中关键部分做了修改
scope.uploader = Qiniu.uploader({
runtimes: 'html5,flash,html4', // 上传模式,依次退化
browse_button: 'pickfiles', // 上传选择的点选按钮,必需
// 在初始化时,uptoken,uptoken_url,uptoken_func三个参数中必须有一个被设置
// 切如果提供了多个,其优先级为uptoken > uptoken_url > uptoken_func
// 其中uptoken是直接提供上传凭证,uptoken_url是提供了获取上传凭证的地址,如果需要定制获取uptoken的过程则可以设置uptoken_func
uptoken: app.getDataBuffer("qiniuToken"), // uptoken是上传凭证,由其他程序生成
// uptoken_url: '/uptoken', // Ajax请求uptoken的Url,强烈建议设置(服务端提供)
//uptoken_func: function(){ // 在需要获取uptoken时,该方法会被调用
// // do something
// return uptoken;
//},
get_new_uptoken: false, // 设置上传文件的时候是否每次都重新获取新的uptoken
// downtoken_url: '/downtoken',
// Ajax请求downToken的Url,私有空间时使用,JS-SDK将向该地址POST文件的key和domain,服务端返回的JSON必须包含url字段,url值为该文件的下载地址
unique_names: true, // 默认false,key为文件名。若开启该选项,JS-SDK会为每个文件自动生成key(文件名)
// save_key: true, // 默认false。若在服务端生成uptoken的上传策略中指定了sava_key,则开启,SDK在前端将不对key进行任何处理
domain: 'http://p357khip9.bkt.clouddn.com', // bucket域名,下载资源时用到,必需
container: 'publish-add-button', // 上传区域DOM ID,默认是browser_button的父元素
max_file_size: '100mb', // 最大文件体积限制
flash_swf_url: 'path/of/plupload/Moxie.swf', //引入flash,相对路径
max_retries: 3, // 上传失败最大重试次数
dragdrop: true, // 开启可拖曳上传
drop_element: 'container', // 拖曳上传区域元素的ID,拖曳文件或文件夹后可触发上传
chunk_size: '4mb', // 分块上传时,每块的体积
auto_start: true, // 选择文件后自动上传,若关闭需要自己绑定事件触发上传
//x_vars : {
// 查看自定义变量
// 'time' : function(up,file) {
// var time = (new Date()).getTime();
// do something with 'time'
// return time;
// },
// 'size' : function(up,file) {
// var size = file.size;
// do something with 'size'
// return size;
// }
//},
init: {
'FilesAdded': function(up, files) {
plupload.each(files, function(file) {
// 文件添加进队列后,处理相关的事情
});
},
'BeforeUpload': function(up, file) {
// 每个文件上传前,处理相关的事情
},
'UploadProgress': function(up, file) {
// 每个文件上传时,处理相关的事情
},
'FileUploaded': function(up, file, info) {
//获取图片链接
var domain = up.getOption('domain');
var res = JSON.parse(info.response);
var sourceLink = domain + "/" + res.key;
if(app.getDataBuffer("picposition") == 'mainPic'){
scope.view.item.mainPic = sourceLink;
}
if(app.getDataBuffer("picposition") == 'content'){
scope.editor.execCommand('inserthtml','<img src="'+sourceLink+'"/>');
}
},
'Error': function(up, err, errTip) {
debugger;
//上传出错时,处理相关的事情
},
'UploadComplete': function() {
//队列文件处理完毕后,处理相关的事情
},
'Key': function(up, file) {
// 若想在前端对每个文件的key进行个性化处理,可以配置该函数
// 该配置必须要在unique_names: false,save_key: false时才生效
var key = "";
// do something with key here
return key
}
}
});
注:这个scope.uploader只是为了保存qiniu的实例,你这么写 var myQiniu = new Qiniu(...)效果完全一样
其中有几个必须字段需要说明下(也就是需要自己定义的地方),
browse_button: 上传图片按钮的ID,点击该按钮触发图片上传
container:上传图片按钮的容器ID(父级domid),点击该dom触发图片上传
uptoken:上传凭证,由后台生成。这里有两个生成策略,一个是一次生成长期使用(我采用的,获取后存在全局中),一个是每个凭证是一次性使用,每次请求都要重新生成。这个根据你们自己的后台逻辑传值
get_new_uptoken:false表示每次上传不重新获取上传凭证
unique_names:true若开启该选项,JS-SDK会为每个文件自动生成key(文件名)
domain:bucket域名,下载资源时用到,必需,这个是后台给的,相当于名字
这里贴一下我的dom结构
<li v-show="!item.mainPic" id="publish-add-button" class="pics addbutton">
<img src="../../images/pic_add.png" @click="openFileDialog" />
<input type="file" style="display: none" id="pickfiles" accept="image/jpeg,image/jpg,image/png" />
</li>
最后一个关键的就是上传成功回调事件了
'FileUploaded': function(up, file, info) {
//获取图片链接
var domain = up.getOption('domain');
var res = JSON.parse(info.response);
var sourceLink = domain + "/" + res.key;
if(app.getDataBuffer("picposition") == 'mainPic'){
scope.view.item.mainPic = sourceLink;
}
if(app.getDataBuffer("picposition") == 'content'){
scope.editor.execCommand('inserthtml','<img src="'+sourceLink+'"/>');
}
},
这里获取的sourceLink就是图片的全路径了,app.getDataBuffer和app.putDataBuffer是获取和设置全局变量的地方。前文我也说过,我界面上有多处上传图片的地方,我用了一个全局变量保存我这次添加图片的位置,然后触发添加图片的按钮,最后上传成功后判断图片应该添加到哪个位置。
最后使用ueditor的exeCommand函数,插入了一段html,这个html就是img
至此,所有功能完成。
总结
通过触发ueditor自定义按钮方式,触发自定义上传图片代码,完美绕过ueditor的上传图片机制(与后台交互),使得图片上传不消耗应用服务器的流量,提高了系统的吞吐量和性能。