bootstrap-wysiwyg整合ajaxFileUpload实现图片实时上传刷新

笔者最近因为项目需求，要实现一个前端文本编辑框，附带图片上传实时查看的功能。比较了网上的几款插件，首先是百度的UEitor，笔者发现该框架过于庞大，一个小框架引入如此多的文件并非我想看到的；其次是jQuery的easyUI，虽然我的版的是免费的，可是项目属于公司业务，彷佛用商业版的框架并不妥。考虑到笔者项目的前端主要就是在bootstrap的基础上构建起来的，我最终选用了bootstrap-wysiwyg插件，它很是的精简，轻巧并且扩展性强。

引入bootstrap-wysiwyg而且实现文本编辑功能十分的便捷，可是，我注意到，图片上传是用fileapi实现的。对于大多数网站，虽然用FileApi实现无上传预览用户体验很是好，可是真正存入数据库的时候，咱们仍是但愿可以存储图片的在服务器的静态路径，而并不是字符串化的图片。简而言之，咱们须要对bootstrap-wysiwyg（如下简称WY）作稍许改写。

首先咱们来观察下页面上图片控件，其它的控件略过，查一下源码，很容易发现以下代码：

<div class="btn-group">
	<a class="btn" title="Insert picture (or just drag & drop)" id="pictureBtn">
	<i class="icon-picture"></i></a>
        <input type="file" data-role="magic-overlay" 
            data-target="#pictureBtn"
	    data-edit="insertImage" />
</div>

作一下说明，data-role，data-target属性是bootstrap中预约义的事件，在这里咱们能够理解为布局相关，不用考虑。关键点来了，第三个属性data-edit,bootstrap中并无这一事件，观察bootstrap-wysiwyg.js，能够发现这样一些代码:

toolbar.find('input[type=file][data-' + options.commandRole + ']')
					.change( ...
					...
commandRole : 'edit',

也就是说，该属性实际上是为了方便选择器而实现的，至关于给图片按钮添加了监听器事件。

咱们接着研究一下WY图片预览的实现，第一步，就像上面代码展现的同样，监听器捕捉到fileInput的change事件，作出响应，调用insertFiles函数

restoreSelection();
if (this.type === 'file' && this.files && this.files.length > 0) {
	insertFiles(this.files);
}
saveSelection();
his.value = '';

找到insertFiles函数

insertFiles = function (files) {
				editor.focus();
				$.each(files, function (idx, fileInfo) {
					if (/^image\//.test(fileInfo.type)) {
						$.when(readFileIntoDataUrl(fileInfo)).done(function (dataUrl) {
							execCommand('insertimage', dataUrl);
						}).fail(function (e) {
							options.fileUploadError("file-reader", e);
						});
					} else {
						options.fileUploadError("unsupported-file-type", fileInfo.type);
					}
				});
			}

咱们注意到它使用了jQuery的$.Deferred()方法，先调用了一个readFileIntoDataUrl方法，成功以后经过自封装的execCommand方法实现将图片输出到文本框。该图片其实就是一个<img>标签，只不过src属性是用字符串表示的图片。因此咱们要作的实际上是在监听器触发以后，将文件上传，得到图片的src，再把连接交给以后的execCommand方法。

因为笔者对Deferred并非特别熟悉，因此仍是采用更为一般的callback模式

观察ajaxFileUpload的调用方式:

$.ajaxFileUpload({
				url : ...,
				secureurl : false,
				fileElementId : ...,
				dataType : "json",
				success : function(obj) {
					...
				},
				error : function() {
					...
				}
			});

有两个必选的属性，url和fileElementId，为了保持依赖的正确性，重写ajaxFileUpload是不可取的。可是因为WY的控件是监听器实现的，因此经过函数将参数传过去是不现实的，因此咱们须要本身对输入框定义一些属性来达到目的。

在fileInput中添加一些属性

<input type="file" id="pictureInput" name="picture"
					data-role="magic-overlay" data-target="#pictureBtn"
					data-edit="insertImage" action="..." />

id 用做 fileElementId,name属性也是必须的，主要是为了后台取值指名，action是图片须要提交到的url

在bootstrap-wysiwyg.js中定义一个函数名为uploadFileToServer,函数格式以下:

var uploadFileToServer = function(id, action, callback) {
		$.ajaxFileUpload({
			url : action,
			secureurl : false,
			fileElementId : id,
			dataType : 'json',
			success : function(obj) {
				if (obj.status) {
					callback(obj.imgsrc);
				} else
					options.fileUploadError("server-internal-exception",
							obj.message);
			},
			error : function() {
				options.fileUploadErroe("upload-failure", "");
			}
		});

将insertFiles方法做改写以下:

insertFiles = function(files, id, action) {
			editor.focus();
			$.each(files, function(idx, fileInfo) {
				if (/^image\//.test(fileInfo.type)) {
					/*
					 * $.when(readFileIntoDataUrl(fileInfo)).done(function(dataUrl) {
					 * execCommand('insertimage', dataUrl); }).fail(function(e) {
					 * options.fileUploadError("file-reader", e); });
					 */
					uploadFileToServer(id, action, function(src) {
						execCommand('insertimage', src);
					});
				} else {
					options.fileUploadError("unsupported-file-type",
							fileInfo.type);
				}
			});

同时对监听器作出必定的修改，以便拿到必要的属性

toolbar.find('input[type=file][data-' + options.commandRole + ']')
				.change(
					function() {
							restoreSelection();
								if (this.type === 'file' && this.files
										&& this.files.length > 0) {
									insertFiles(this.files, $(this).attr('id'),
											$(this).attr('action'));
								}
								saveSelection();
								this.value = '';
							});

主要是增长了两个参数位置。

如此，改写便完成了，注意，要确保正确执行，请在控件以前引用ajaxFileUpload.js

2016年1月14日 15:07:59更新：

今天在用的时候发现一个问题，即图片只能上传一次的问题，这是ajaxFileUpload.js的问题，解决方案：

ajaxfileupload.js原文第41行：

var newElement = jQuery(oldElement).clone();

改成:

var newElement = jQuery(oldElement).clone(true);

缘由是ajaxFileUpload默认复制元素而不复制元素事件致使WY的监听器change失效。

另，附上$.Deferred对象的改写方法：

//原文第6行
var uploadFileToServer = function(id, action) {
		var loader = $.Deferred();
		$.ajaxFileUpload({
			url : action,
			secureurl : false,
			fileElementId : id,
			dataType : 'json',
			success : function(json) {
				if (json.status) {
					loader.resolve(json.imgsrc);
				} else {
					loader.reject('server-internal-exception', json.message);
				}
			},
			error : function() {
				loader.reject('upload-failure', '');
			}
		});
		return loader.promise();
	}
	
	//原文100行附近
	insertFiles = function(files, id, action) {
			editor.focus();
			$.each(files,
					function(index, file) {
						if (/^image\//.test(file.type)) {
							$.when(uploadFileToServer(id, action)).done(
									function(src) {
										execCommand('insertimage', src);
									}).fail(function(e, message) {
								options.fileUploadError(e, message);
							});
						} else {
							options.fileUploadError("unsupported-file-type",
									file.type);
						}
					});