項目分享七：客戶端防止表單重複提交

時間 2019-11-06

原文原文鏈接

防止表單數據重複提交，是 APP 常見而又必須具有的功能。客戶端最多見的作法是，當用戶點擊按鈕的時候，首先把按鈕給禁用，待數據徹底提交到服務端後，再讓按鈕處於啓用的狀態。以下圖中的「結算」按鈕。html

道理很簡單，實現起來也不難。可是若是所有代碼都這樣子去寫，未免太煩瑣。咱們看一下 ChiTu Store 是如何封裝的。（注：客戶防止重複提交，不意味着服務端不須要防止重複提交。）jquery

1、結算代碼

打開 App/Module/Shopping/ShoppingCart.html 頁面，咱們找到結算按鈕，結算按鈕綁定到 buy 方法的。git

<button class="btn btn-primary" type="button" data-bind="click:buy, disable:productsCount()<=0">結算（<span data-bind="text:productsCount"></span>）</button>

咱們再來看一下 buy 方法（注：代碼有刪減），值得注意的時候，buy 方法是返回一個 Deferred 對象，也就是 jquery 中的類型爲 JQueryPromise 的對象。關於 Promise 對象，這裏不展開講，不瞭解自行 Google。在後面，我會告訴你們，爲何要返回一個 JQueryPromise 對象。github

    buy = () => {
        var deferred = $.Deferred();
        shopping.createOrder(productIds, quantities)
            .done((order) => {
                app.redirect('Shopping_OrderProducts_' + order.Id());
                deferred.resolve(order);
            })
            .fail((data) => {
                deferred.reject(data);
            });

        return deferred;
    }

2、Click事件的封裝代碼

打開 App/Core/ko.ext.ts 文件，找到關於 click 綁定的代碼。咱們能夠看獲得，上面的實現，又是經過重寫 knockout js 的 click 綁定來實現的。它主要的實現過程，封裝在了 translateClickAccessor 函數中。app

var _click = ko.bindingHandlers.click;
ko.bindingHandlers.click = {
    init: function (element, valueAccessor, allBindings, viewModel, bindingContext) {
        valueAccessor = translateClickAccessor(element, valueAccessor, allBindings, viewModel, bindingContext);
        return _click.init(element, valueAccessor, allBindings, viewModel, bindingContext);
    }
};

關於 translateClickAccessor 函數（代碼有刪減），是這樣子：函數

function translateClickAccessor(element, valueAccessor, allBindings, viewModel, bindingContext) {
    var value = ko.unwrap(valueAccessor());
    if (value == null) {
        return valueAccessor;
    }

    return $.proxy(function () {
        var element = this._element;
        var valueAccessor = this._valueAccessor;
        var allBindings = this._allBindings;
        var viewModel = this._viewModel;
        var bindingContext = this._bindingContext;
        var value = this._value;

        return function (viewModel) {

            var deferred: JQueryPromise<any> = $.Deferred<any>().resolve();

            deferred = deferred.pipe(function () {
                var result = $.isFunction(value) ? value(viewModel, event) : value;
                if (result && $.isFunction(result.always)) {
                    $(element).attr('disabled', 'disabled');
                    $(element).addClass('disabled');
                    result.element = element;

                    result.always(function () {
                        $(element).removeAttr('disabled');
                        $(element).removeClass('disabled');
                    });

                    //===============================================
                    // 超時去掉按鈕禁用，防止 always 不起做用。 
                    setTimeout($.proxy(function () {
                        $(this._element).removeAttr('disabled');
                        $(this._element).removeClass('disabled');
                    }, { _element: element }), 1000 * 20);
                    //===============================================

                  

                    });
                }
                return result;
            });



            return deferred;
        };
    },
        { _element: element, _valueAccessor: valueAccessor, _allBindings: allBindings, _viewModel: viewModel, _bindingContext: bindingContext, _value: value });
}

咱們這來看第一句：var value = ko.unwrap(valueAccessor()) 這句話是獲取綁定到 click 方法的函數的返回值，在咱們這個例子裏，是 JQuery.Deferred 對象。this

爲何咱們要求是 JQuery.Deferred（JQueryPromise）對象？由於 JQueryPromise 有 done，fail，always 等方法，經過這些方法，咱們能夠知道任務是否已經完成。spa

下面這幾行代碼，判斷 click 所綁定方法返回的結果是否爲 JQueryPromise 對象，固然，這種判斷不是百分百準確，可是對於絕大多數狀況來講應該是沒有問題的。只有返回的對象是 JQueryPromise對象，咱們才進行處理（if 邏輯塊代碼）。code

 var result = $.isFunction(value) ? value(viewModel, event) : value;
 if (result && $.isFunction(result.always)) {
      //..........
}

咱們來看一下相關的代碼，下面這段代碼，仍是挺好理解，首先要作的就是在 element 元素（在咱們的例子中，是結算按鈕），加上 disabled 的屬性，而後加上一個 disabled 的 class，當執行完成後，如論是成功仍是失敗，都取消禁用。固然，咱們還要做一個超時的處理，這時的超時設置爲 2 秒。htm

$(element).attr('disabled', 'disabled');
$(element).addClass('disabled');
result.element = element;

result.always(function () {
    $(element).removeAttr('disabled');
    $(element).removeClass('disabled');
});

//===============================================
// 超時去掉按鈕禁用，防止 always 不起做用。 
setTimeout($.proxy(function () {
    $(this._element).removeAttr('disabled');
    $(this._element).removeClass('disabled');
}, { _element: element }), 1000 * 20);
//===============================================