如何使用jQuery延迟？

Question

jQuery 1.5带来了新的Deferred对象和附加的方法.when，.Deferred和._Deferred。

对于那些在我注释it的来源之前未使用.Deferred的人

这些新方法的可能用途是什么，我们如何将它们融入模式？

我已经阅读了API和source，所以我知道它的作用。我的问题是我们如何在日常代码中使用这些新功能？

我有一个简单的example缓冲类，它按顺序调用AJAX请求。 （下一个在上一个完成后开始）。

/* Class: Buffer
 *  methods: append
 *
 *  Constructor: takes a function which will be the task handler to be called
 *
 *  .append appends a task to the buffer. Buffer will only call a task when the 
 *  previous task has finished
 */
var Buffer = function(handler) {
    var tasks = [];
    // empty resolved deferred object
    var deferred = $.when();

    // handle the next object
    function handleNextTask() {
        // if the current deferred task has resolved and there are more tasks
        if (deferred.isResolved() && tasks.length > 0) {
            // grab a task
            var task = tasks.shift();
            // set the deferred to be deferred returned from the handler
            deferred = handler(task);
            // if its not a deferred object then set it to be an empty deferred object
            if (!(deferred && deferred.promise)) {
                deferred = $.when();
            }
            // if we have tasks left then handle the next one when the current one 
            // is done.
            if (tasks.length > 0) {
                deferred.done(handleNextTask);
            }
        }
    }

    // appends a task.
    this.append = function(task) {
        // add to the array
        tasks.push(task);
        // handle the next task
        handleNextTask();
    };
};

我正在寻找.Deferred和.when的演示和可能用途。

看到._Deferred的例子也很可爱。

链接到新jQuery.ajax来源的示例是作弊。

Bounty：向我们展示当我们抽象出操作是同步还是异步完成时可用的技术。

Answer 1

我能想到的最佳用例是缓存AJAX响应。以下是Rebecca Murphey's intro post on the topic的修改示例：

var cache = {};

function getData( val ){

    // return either the cached value or jqXHR object wrapped Promise
    return $.when(
        cache[ val ] || 
        $.ajax('/foo/', {
            data: { value: val },
            dataType: 'json',
            success: function( resp ){
                cache[ val ] = resp;
            }
        })
    );
}

getData('foo').then(function(resp){
    // do something with the response, which may
    // or may not have been retrieved using an
    // XHR request.
});

基本上，如果在从缓存中立即返回值之前已经请求了一次。否则，AJAX请求将获取数据并将其添加到缓存中。 $.when / .then并不关心这一点;所有你需要关注的是使用响应，在两种情况下都会传递给.then()处理程序。 jQuery.when()将非承诺/延期处理为已完成的，立即执行链上的任何.done()或.then()。

当任务可能异步或不异步运行时，延迟是完美的，并且您希望从代码中抽象出该条件。

使用$.when助手的另一个真实示例：

$.when($.getJSON('/some/data/'), $.get('template.tpl')).then(function (data, tmpl) {

    $(tmpl) // create a jQuery object out of the template
    .tmpl(data) // compile it
    .appendTo("#target"); // insert it into the DOM

});

Answer 2

这是一个与ehynd's answer中的AJAX缓存略有不同的实现。

如fortuneRice's follow-up question所述，如果请求在其中一个请求返回之前执行，则ehynd的实现实际上并未阻止多个相同的请求。也就是说，

for (var i=0; i<3; i++) {
    getData("xxx");
}

如果之前尚未缓存“xxx”的结果，

很可能会导致3个AJAX请求。

这可以通过缓存请求的Deferreds而不是结果来解决：

var cache = {};

function getData( val ){

    // Return a promise from the cache (if available)
    // or create a new one (a jqXHR object) and store it in the cache.
    var promise = cache[val];
    if (!promise) {
        promise = $.ajax('/foo/', {
            data: { value: val },
            dataType: 'json'
        });
        cache[val] = promise;
    }
    return promise;
}

$.when(getData('foo')).then(function(resp){
    // do something with the response, which may
    // or may not have been retreived using an
    // XHR request.
});

Answer 3

可以使用延迟代替互斥锁。这与多个ajax使用场景基本相同。

<强> MUTEX

var mutex = 2;

setTimeout(function() {
 callback();
}, 800);

setTimeout(function() {
 callback();
}, 500);

function callback() {
 if (--mutex === 0) {
  //run code
 }
}

<强> DEFERRED

function timeout(x) {
 var dfd = jQuery.Deferred();
 setTimeout(function() {
  dfd.resolve();
 }, x);
 return dfd.promise();
}

jQuery.when(
timeout(800), timeout(500)).done(function() {
 // run code
});

仅将Deferred用作互斥锁时，请注意性能影响（http://jsperf.com/deferred-vs-mutex/2）。虽然Deferred提供的便利以及额外的好处非常值得，但在实际（基于用户驱动的事件）使用中，性能影响应该不明显。

Answer 4

这是一个自我宣传的答案，但我花了几个月的时间研究这个并在2012年旧金山举行的jQuery Conference上展示了结果。

以下是该演讲的免费视频：

http://www.confreaks.com/videos/993-jqcon2012-i-promise-to-show-you-when-to-use-deferreds

Answer 5

我一直善用的另一个用途是从多个来源获取数据。在下面的示例中，我将获取现有应用程序中使用的多个独立JSON模式对象，以便在客户端和REST服务器之间进行验证。在这种情况下，我不希望浏览器端应用程序在加载所有模式之前开始加载数据。 $ .when.apply（）。then（）非常适合这个。感谢Raynos关于使用then（fn1，fn2）监视错误情况的指示。

fetch_sources = function (schema_urls) {
    var fetch_one = function (url) {
            return $.ajax({
                url: url,
                data: {},
                contentType: "application/json; charset=utf-8",
                dataType: "json",
            });
        }
    return $.map(schema_urls, fetch_one);
}

var promises = fetch_sources(data['schemas']);
$.when.apply(null, promises).then(

function () {
    var schemas = $.map(arguments, function (a) {
        return a[0]
    });
    start_application(schemas);
}, function () {
    console.log("FAIL", this, arguments);
});     

Answer 6

使用Deferred为任何类型的计算实现缓存的另一个示例（通常是一些性能密集型或长时间运行的任务）：

var ResultsCache = function(computationFunction, cacheKeyGenerator) {
    this._cache = {};
    this._computationFunction = computationFunction;
    if (cacheKeyGenerator)
        this._cacheKeyGenerator = cacheKeyGenerator;
};

ResultsCache.prototype.compute = function() {
    // try to retrieve computation from cache
    var cacheKey = this._cacheKeyGenerator.apply(this, arguments);
    var promise = this._cache[cacheKey];

    // if not yet cached: start computation and store promise in cache 
    if (!promise) {
        var deferred = $.Deferred();
        promise = deferred.promise();
        this._cache[cacheKey] = promise;

        // perform the computation
        var args = Array.prototype.slice.call(arguments);
        args.push(deferred.resolve);
        this._computationFunction.apply(null, args);
    }

    return promise;
};

// Default cache key generator (works with Booleans, Strings, Numbers and Dates)
// You will need to create your own key generator if you work with Arrays etc.
ResultsCache.prototype._cacheKeyGenerator = function(args) {
    return Array.prototype.slice.call(arguments).join("|");
};

以下是使用此类执行某些（模拟重）计算的示例：

// The addingMachine will add two numbers
var addingMachine = new ResultsCache(function(a, b, resultHandler) {
    console.log("Performing computation: adding " + a + " and " + b);
    // simulate rather long calculation time by using a 1s timeout
    setTimeout(function() {
        var result = a + b;
        resultHandler(result);
    }, 1000);
});

addingMachine.compute(2, 4).then(function(result) {
    console.log("result: " + result);
});

addingMachine.compute(1, 1).then(function(result) {
    console.log("result: " + result);
});

// cached result will be used
addingMachine.compute(2, 4).then(function(result) {
    console.log("result: " + result);
});

可以使用相同的底层缓存来缓存Ajax请求：

var ajaxCache = new ResultsCache(function(id, resultHandler) {
    console.log("Performing Ajax request for id '" + id + "'");
    $.getJSON('http://jsfiddle.net/echo/jsonp/?callback=?', {value: id}, function(data) {
        resultHandler(data.value);
    });
});

ajaxCache.compute("anID").then(function(result) {
    console.log("result: " + result);
});

ajaxCache.compute("anotherID").then(function(result) {
    console.log("result: " + result);
});

// cached result will be used
ajaxCache.compute("anID").then(function(result) {
    console.log("result: " + result);
});

您可以在this jsFiddle中使用上述代码。

Answer 7

1）使用它来确保有序执行回调：

var step1 = new Deferred();
var step2 = new Deferred().done(function() { return step1 });
var step3 = new Deferred().done(function() { return step2 });

step1.done(function() { alert("Step 1") });
step2.done(function() { alert("Step 2") });
step3.done(function() { alert("All done") });
//now the 3 alerts will also be fired in order of 1,2,3
//no matter which Deferred gets resolved first.

step2.resolve();
step3.resolve();
step1.resolve();

2）用它来验证应用的状态：

var loggedIn = logUserInNow(); //deferred
var databaseReady = openDatabaseNow(); //deferred

jQuery.when(loggedIn, databaseReady).then(function() {
  //do something
});

Answer 8

您可以使用延迟对象来制作在webkit浏览器中运行良好的流畅设计。 Webkit浏览器将为窗口调整大小的每个像素触发resize事件，这与FF和IE不同，后者仅在每次调整大小时触发事件一次。因此，您无法控制绑定到窗口调整大小事件的函数将执行的顺序。这样的事情解决了这个问题：

var resizeQueue = new $.Deferred(); //new is optional but it sure is descriptive
resizeQueue.resolve();

function resizeAlgorithm() {
//some resize code here
}

$(window).resize(function() {
    resizeQueue.done(resizeAlgorithm);
});

这将序列化代码的执行，以便按照您的意图执行。将对象方法作为回调传递给延迟时要小心陷阱。一旦这样的方法作为延迟回调执行，'this'引用将被引用延迟对象覆盖，并且将不再引用该方法所属的对象。

Answer 9

您还可以将它与任何使用JQuery的第三方库集成。

一个这样的库是Backbone，实际上它将在下一个版本中支持Deferred。我也在blog

上谈过这个问题

Answer 10

我刚刚在实际代码中使用了Deferred。在项目jQuery Terminal中，我有函数exec调用用户定义的命令（就像他输入它并按下回车），我已经将Deferreds添加到API并使用数组调用exec。像这样：

terminal.exec('command').then(function() {
   terminal.echo('command finished');
});

或

terminal.exec(['command 1', 'command 2', 'command 3']).then(function() {
   terminal.echo('all commands finished');
});

命令可以运行异步代码，exec需要按顺序调用用户代码。我的第一个api使用了一对暂停/恢复调用，在新的API中，当用户返回promise时，我将这些调用自动调用。所以用户代码可以使用

return $.get('/some/url');

或

var d = new $.Deferred();
setTimeout(function() {
    d.resolve("Hello Deferred"); // resolve value will be echoed
}, 500);
return d.promise();

我使用这样的代码：

exec: function(command, silent, deferred) {
    var d;
    if ($.isArray(command)) {
        return $.when.apply($, $.map(command, function(command) {
            return self.exec(command, silent);
        }));
    }
    // both commands executed here (resume will call Term::exec)
    if (paused) {
        // delay command multiple time
        d = deferred || new $.Deferred();
        dalyed_commands.push([command, silent, d]);
        return d.promise();
    } else {
        // commands may return promise from user code
        // it will resolve exec promise when user promise
        // is resolved
        var ret = commands(command, silent, true, deferred);
        if (!ret) {
            if (deferred) {
                deferred.resolve(self);
                return deferred.promise();
            } else {
                d = new $.Deferred();
                ret = d.promise();
                ret.resolve();
            }
        }
        return ret;
    }
},

dalyed_commands用于resume函数，该函数使用所有dalyed_commands再次调用exec。

和部分命令功能（我剥离了不相关的部分）

function commands(command, silent, exec, deferred) {

    var position = lines.length-1;
    // Call user interpreter function
    var result = interpreter.interpreter(command, self);
    // user code can return a promise
    if (result != undefined) {
        // new API - auto pause/resume when using promises
        self.pause();
        return $.when(result).then(function(result) {
            // don't echo result if user echo something
            if (result && position === lines.length-1) {
                display_object(result);
            }
            // resolve promise from exec. This will fire
            // code if used terminal::exec('command').then
            if (deferred) {
                deferred.resolve();
            }
            self.resume();
        });
    }
    // this is old API
    // if command call pause - wait until resume
    if (paused) {
        self.bind('resume.command', function() {
            // exec with resume/pause in user code
            if (deferred) {
                deferred.resolve();
            }
            self.unbind('resume.command');
        });
    } else {
        // this should not happen
        if (deferred) {
            deferred.resolve();
        }
    }
}

Answer 11

ehynds的答案不起作用，因为它会缓存响应数据。它应该缓存jqXHR，它也是一个Promise。 这是正确的代码：

var cache = {};

function getData( val ){

    // return either the cached value or an
    // jqXHR object (which contains a promise)
    return cache[ val ] || $.ajax('/foo/', {
        data: { value: val },
        dataType: 'json',
        success: function(data, textStatus, jqXHR){
            cache[ val ] = jqXHR;
        }
    });
}

getData('foo').then(function(resp){
    // do something with the response, which may
    // or may not have been retreived using an
    // XHR request.
});

Julian D.的回答将是正确的，是一个更好的解决方案。