做一個類似微博的列表頁,看似簡單,但一旦留言、轉發、刪除、分頁全部疊上去,程式碼很快就長成一團義大利麵。本文記錄一種用「模型/視圖/模板/異步任務」四層切分的組織方式,實作下來大約五個物件、四百行程式碼,可讀性明顯提升。
| 要素 | 組成 |
|---|---|
| 模型 | Reply、Forward |
| 視圖 | CommentEditor、ReplyList、ForwardList |
| 模板 | jQuery.tmpl |
| 異步任務 | jQuery.Deferred |
模型負責產生、過濾、保存、驗證資料,僅此而已。它接收 JSON、回傳異步任務;至於同步或異步完成並不重要。驗證之所以放在這一層,是因為它是與伺服器交互的最後一道門檻。驗證失敗的處理則交給呼叫方決定——可以彈提示,也可以靜默重試。
var Reply = {
cache: {},
fetch: function (data) {
return $.post('/ajax/blog/reply/list', data || {}).success(function (resp) {
resp.ok && resp.list && $.each(resp.list, function (k, v) {
return Reply.cache[v.id] = v;
});
});
},
filter: function (prop, val) {
return $.grep(this.cache, function (r) { return r[prop] === val; });
},
create: function (data) {
var dfd = $.Deferred(), now = $.now();
if ((now - this.create.timestamp) / 1000 < 10) {
dfd.reject({ message: '您發表得太快了,休息一下吧', type: 'warn' });
} else if (!data || !data.sourceid) {
dfd.reject({ message: '非法操作', type: 'error' });
} else if (!data.content) {
dfd.reject({ message: '評論內容不能為空', type: 'warn' });
} else {
this.create.timestamp = now;
dfd = $.post('/ajax/blog/reply/create', data);
}
return dfd.promise();
}
};
Reply.create.timestamp = Forward.create.timestamp = $.now() - 1e4;
注意 create 最後只回傳 promise(),也就是任務的唯讀副本,外部無從竄改狀態。
每個視圖物件持有一個關聯的 jQuery 物件 instance.$el,類似 UI 元件中的 DOM 容器。視圖只有兩個一致的方法:render 從模型取資料並套模板渲染、activate 綁定事件,且所有事件最多委派到 $el 為止。
var ReplyList = function (options) {
var opt = this.opt = $.extend({ el: '', parent: null }, options || {});
this.parent = opt.parent;
this.$el = $(opt.el);
this.activate();
};
ReplyList.prototype = {
render: function () {
var self = this;
Reply.fetch({ page_size: 10, page_num: 1, sourceid: self.parent.getBlogId() })
.done(function (data) {
self.$el.html(self.$list = $.tmpl(tpl_reply_list, data));
});
return self;
},
activate: function () {
this.$el.delegate('a.del', $.proxy(this.del, this));
}
};
這個範例裡 CommentEditor 是父視圖,ReplyList 與 ForwardList 是互斥顯示的兩個子視圖,父子之間互相保存引用,切換時只需替換 sublist。
save: function () {
var self = this, data = { content: self.getContent(), sourceid: self.getBlogId() };
var task_r = Reply.create(data);
var task_f = Forward.create(data);
$.when(task_r, task_f).then(function (t1, t2) {
// 保存成功,更新視圖或關閉
}, function (data) {
Sys.info(data.message, data.type);
});
return self;
}
模板的作用是把 JS 物件直接生成 HTML 片段,還能遍歷集合、套用格式化函式:
var tpl_reply_list = '<ul class="ui-reply-list">
{{each list}}
<li data-id="${id}">
<a class="name" href="/${userid}">${name}:</a>
<p>${content}</p>
<time pubdate>${nicetime(timestamp)}</time>
<a class="del" href="javascript:;">刪除</a>
</li>
{{/each}}
</ul>';
Deferred 直譯是「延遲物件」,理解成「異步任務」更貼切。它維護成功與失敗兩個回呼佇列,狀態可用 isResolved / isRejected 檢查,用 resolve / reject 修改。使用之後,原本三層以上的回呼巢狀被攤平成一層。
在 create 裡包一層自訂任務,比直接把原生 ajax 任務丟出去更好,因為可以把「業務失敗」與「網路失敗」統一收斂:
$.post('/ajax/blog/reply/create', data)
.success(function (json) {
if (json && json.ok) { dfd.resolve(json.list); }
else { dfd.reject({ message: json.message || '獲取失敗', type: 'error' }); }
})
.fail(function () { dfd.reject({ message: '服務暫時不可用', type: 'error' }); });
收穫是可維護性:API 呼叫清楚、沒有兩層以上的 if、沒有兩層以上的回呼、每個函式控制在二十行內。結果是幾乎沒有重複程式碼,所有功能都被妥善打包。這套思路放到今天,把 jQuery.tmpl 換成前端框架的模板、把 Deferred 換成 Promise,分層的精神依然成立。