本文介紹網頁中常見的「圖片上傳後直接生成小圖預覽」功能的實作思路。由於這個功能相當通用,於是把它封裝成一個 ImageUploadView 元件。實作過程中用到了前面幾篇介紹的繼承庫 class.js 與事件管理庫 eventBase.js,同時融入了對職責分離、表現與行為分離的思考。
註:由於演示程式碼都是靜態的,檔案上傳元件是用 setTimeout 模擬的,但呼叫方式與實際工作中的上傳元件完全相同,因此演示完全符合真實的功能需求。
根據演示效果,可歸納出以下需求:
1)初始時上傳區只顯示一個可點擊的上傳按鈕,點擊後把上傳成功的圖片顯示在預覽區。
2)圖片加入預覽區後,可透過刪除按鈕移除。
3)當已上傳圖片數達到上限(例如 4 張),就把上傳按鈕移除。
4)當已上傳圖片數達到上限後,若刪除了某張圖片,要再把上傳按鈕顯示出來。
此外,依經驗還可推得:若頁面為編輯狀態(從資料庫讀出),只要圖片清單不為空,初始時就要顯示圖片,並依清單長度與上傳上限控制按鈕顯示;若頁面為唯讀狀態,初始時就要移除上傳與刪除按鈕。
由於這是表單頁面,圖片上傳後若要提交到後端,需要一個文本域。因此我在靜態頁面就把文本域納入考量,上傳新圖片或刪除圖片後都要同步修改它的值。當時的結構如下:
<div class="holy-layout-am appForm-group appForm-group-img-upload clearfix"> <label class="holy-layout-al">法人身份證電子版</label> <div class="holy-layout-m"> <input id="legalPersonIDPic-input" name="legalPersonIDPic" class="form-control form-field" type="hidden"> <ul id="legalPersonIDPic-view" class="image-upload-view clearfix"> <li class="view-item-add"><a class="view-act-add" href="javascript:;" title="點擊上傳">+</a></li> </ul> </div> </div>
整個上傳區放在一個 ul 裡,並把第一個 li 當作上傳按鈕。結合職責分離的思想,這個功能至少需要三個元件:一個負責檔案上傳、一個負責圖片預覽管理、一個負責文本域值管理。千萬不要把三者耦合在一起,否則元件的可擴展性與可重用性都不高。若元件間需要互動,只需透過回呼函式或發布—訂閱模式定義對外介面即可。
其中文本域值管理很簡單,函式級封裝即可;檔案上傳可直接用 webuploader 等現成外掛;圖片預覽是本文核心,ImageUploadView 對它有 render、append、delItem 三個語義明確的實例方法。按照經驗,通常一個實例方法會定義一對事件(如 render.before 與 render.after),既提供擴展點,又能增加對預設行為的管理。
此外,由於我曾做過上傳影片、音訊、文件等類似功能,因此把這些相似處抽取出來作為一個基類 FileUploadBaseView,讓通用邏輯與 HTML 結構完全分離,只定義 options、行為與通用事件,並留固定介面給子類實作。基類因與 HTML 結構分離而有更大適用範圍,子類則受 HTML 結構限制、適用範圍較小。
相關元件的繼承關係為:ImageUploadView extend FileUploadBaseView extend EventBase(模組化使用 seajs)。
FileUploadBaseView 負責:定義通用 option 與事件管理,並把 render、append、delItem 的主要邏輯抽成需被子類實作的 _render、_append、_delItem。這樣呼叫子類的 render 時實際呼叫父類方法,但執行到 _render 時則呼叫子類方法,藉此統一處理事件派發。注意子類不能覆蓋 render、append、delItem 三個方法,否則得自行處理事件觸發。
define(function (require, exports, module) {
var $ = require('jquery');
var Class = require('mod/class');
var EventBase = require('mod/eventBase');
var DEFAULTS = {
data: [], // 要展示的資料清單,元素須為 object
sizeLimit: 0, // 限制展示元素個數,0 表示不限制
readonly: false, // 是否允許增加與刪除
onBeforeRender: $.noop, onRender: $.noop,
onBeforeAppend: $.noop, onAppend: $.noop,
onBeforeDelItem: $.noop, onDelItem: $.noop
};
var FileUploadBaseView = Class({
instanceMembers: {
init: function (element, options) {
this.base(element);
var opts = this.options = this.getOptions(options);
this.data = resolveData(opts.data);
delete opts.data;
this.sizeLimit = opts.sizeLimit;
this.readOnly = opts.readOnly;
this.on('render.before', $.proxy(opts.onBeforeRender, this));
this.on('render.after', $.proxy(opts.onRender, this));
this.on('append.before', $.proxy(opts.onBeforeAppend, this));
this.on('append.after', $.proxy(opts.onAppend, this));
this.on('delItem.before', $.proxy(opts.onBeforeDelItem, this));
this.on('delItem.after', $.proxy(opts.onDelItem, this));
},
render: function () {
var e;
this.trigger(e = $.Event('render.before'));
if (e.isDefaultPrevented()) return;
this._render();
this.trigger($.Event('render.after'));
},
_render: function () {},
append: function (item) {
var e; if (!item) return;
item = resolveDataItem(item);
this.trigger(e = $.Event('append.before'), item);
if (e.isDefaultPrevented()) return;
this.data.push(item);
this._append(item);
this.trigger($.Event('append.after'), item);
},
_append: function (data) {},
delItem: function (uuid) {
var e, item = this.getDataItem(uuid);
if (!item) return;
this.trigger(e = $.Event('delItem.before'), item);
if (e.isDefaultPrevented()) return;
this.data.splice(this.getDataItemIndex(uuid), 1);
this._delItem(item);
this.trigger($.Event('delItem.after'), item);
},
_delItem: function (data) {}
},
extend: EventBase,
staticMembers: { DEFAULTS: DEFAULTS }
});
return FileUploadBaseView;
});
ImageUploadView 的實作就像填空,幾個重點:它的 DEFAULTS 需擴展父類的 DEFAULTS(新增 onAppendClick 事件並保留父類設定);init 中要呼叫父類 init 完成通用邏輯,最後手動呼叫 render 以在實例化後看到效果。
define(function (require, exports, module) {
var $ = require('jquery');
var Class = require('mod/class');
var FileUploadBaseView = require('mod/fileUploadBaseView');
var DEFAULTS = $.extend({}, FileUploadBaseView.DEFAULTS, {
onAppendClick: $.noop // 點擊上傳按鈕時的回呼
});
var ImageUploadView = Class({
instanceMembers: {
init: function (element, options) {
var $element = this.$element = $(element);
var opts = this.getOptions(options);
this.base(this.$element, options);
if (!this.readOnly) {
var that = this;
that.on('appendClick', $.proxy(opts.onAppendClick, this));
$element.on('click.append', '.view-act-add', function (e) {
e.preventDefault();
that.trigger('appendClick');
});
$element.on('click.remove', '.view-act-del', function (e) {
var $this = $(e.currentTarget);
that.delItem($this.data('uuid'));
e.preventDefault();
});
}
this.render();
},
_render: function () {
var html = [], that = this;
if (!(this.readOnly || (this.sizeLimit && this.sizeLimit <= this.data.length))) {
this._setItemAddHtml();
}
this.data.forEach(function (item) {
html.push(that._getItemRenderHtml(item));
});
this.$element.append($(html.join('')));
},
_append: function (data) {
this.$element.append($(this._getItemRenderHtml(data)));
this._dealWithSizeLimit();
},
_delItem: function (data) {
$('#' + data._uuid).remove();
this._dealWithSizeLimit();
}
},
extend: FileUploadBaseView
});
return ImageUploadView;
});
演示項目結構如下,fileUploadBaseView.js 與 imageUploadView.js 是兩個核心元件,fileUploader.js 用來模擬上傳元件(其實例有 onSuccess 回呼與 openChooseFileWin 方法):
define(function(require, exports, module) {
return function() {
var imgList = ['../img/1.jpg','../img/2.jpg','../img/3.jpg','../img/4.jpg'], i = 0;
var that = this;
that.onSuccess = function(uploadValue){};
this.openChooseFileWin = function(){
setTimeout(function(){
that.onSuccess(imgList[i++]);
if(i == imgList.length) { i = 0; }
}, 1000);
};
};
});
app/regist.js 是演示頁面的邏輯程式碼,關鍵部分已用註解說明:
define(function (require, exports, module) {
var $ = require('jquery');
var ImageUploadView = require('mod/imageUploadView');
var FileUploader = require('mod/fileUploader');
var $legalPersonIDPic = $('#legalPersonIDPic-input'),
data = JSON.parse($legalPersonIDPic.val() || '[]');
var appendImageInputValue = function ($input, item) {
var value = JSON.parse($input.val() || '[]');
value.push(item);
$input.val(JSON.stringify(value));
};
var removeImageInputValue = function ($input, uuid) {
var value = JSON.parse($input.val() || '[]'), index;
value.forEach(function (item, i) {
if (item._uuid === uuid) { index = i; }
});
value.splice(index, 1);
$input.val(JSON.stringify(value));
};
var fileUploader = new FileUploader();
fileUploader.onSuccess = function (uploadValue) {
var item = {url: uploadValue};
legalPersonIDPicView.append(item);
appendImageInputValue($legalPersonIDPic, item);
};
var legalPersonIDPicView = new ImageUploadView('#legalPersonIDPic-view', {
data: data,
sizeLimit: 4,
onAppendClick: function () {
fileUploader.openChooseFileWin();
},
onDelItem: function (data) {
removeImageInputValue($legalPersonIDPic, data._uuid);
}
});
});
ImageUploadView 最終實作起來並不難,但大部分時間都花在對職責分離與行為分離的抽象過程中。這些關於編程思想的觀點只是個人的實際體會——抽象層面的東西,每個人思考方式不同,理解成果也不會相同。寫出來是為了分享與交流,看看有沒有其他朋友也願意分享自己這方面的想法。相信多看別人的思路之後,也能為自己的編程思想帶來鍛鍊的幫助。