281

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

对于没有使用.Deferred过的人,我已经注释了它的来源

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

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

我有一个按顺序调用 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();
    };
};

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

也很高兴看到._Deferred.

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

当我们抽象出一个操作是同步完成还是异步完成时,我对哪些技术可用特别感兴趣。

4

11 回答 11

215

我能想到的最佳用例是缓存 AJAX 响应。这是Rebecca Murphey 关于该主题的介绍文章的修改示例:

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()将非 Promise/Deferred 处理为已完成的,立即执行链上的任何.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

});
于 2011-02-02T12:57:51.747 回答
79

这是与ehynd 的回答中的 AJAX 缓存略有不同的实现。

fortuneRice 的后续问题所述,如果请求在其中一个返回之前执行,则 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.
});
于 2012-01-22T11:03:39.977 回答
46

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

互斥体

var mutex = 2;

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

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

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

延期

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 提供的便利以及额外的好处是非常值得的,但在实际(基于用户驱动的事件)使用中,性能影响应该不明显。

于 2011-05-23T18:44:25.583 回答
29

这是一个自我推销的答案,但我花了几个月的时间对此进行研究,并在 2012 年旧金山 jQuery 会议上展示了结果。

这是演讲的免费视频:

https://www.youtube.com/watch?v=juRtEEsHI9E

于 2012-10-10T22:18:53.517 回答
20

我一直致力于的另一个用途是从多个来源获取数据。在下面的示例中,我正在获取现有应用程序中使用的多个独立 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);
});     
于 2011-02-04T04:54:04.420 回答
10

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

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);
});

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

于 2012-01-22T14:14:41.590 回答
9

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
});
于 2012-09-14T06:47:31.307 回答
2

您可以使用延迟对象来制作在 webkit 浏览器中运行良好的流畅设计。Webkit 浏览器将为窗口调整大小的每个像素触发调整大小事件,这与 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);
});

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

于 2011-03-01T12:27:06.193 回答
2

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

一个这样的库是 Backbone,它实际上将在他们的下一个版本中支持 Deferred。

于 2011-05-15T07:00:42.430 回答
1

我刚刚在实际代码中使用了 Deferred。在项目jQuery 终端中,我有调用用户定义的命令的函数 exec(就像他正在输入它并按 Enter 键),我已将 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 中,我在用户返回承诺时自动调用它们。所以用户代码可以使用

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 用于恢复函数,该函数使用所有 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();
        }
    }
}
于 2014-06-02T07:34:17.557 回答
1

ehynds 的答案将不起作用,因为它缓存了响应数据。它应该缓存同样是 Promise 的 jqXHR。这是正确的代码:

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. 的答案将是正确的,并且是一个更好的解决方案。

于 2015-01-28T07:44:50.793 回答