Как можно использовать jQuery для отсрочки?
JQuery 1.5 приносит новый отсроченного объект и приложенные методы .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();
};
};
Я ищу для демонстраций и возможных применений .Deferred
и .when
.
Также было бы ._Deferred
увидеть примеры ._Deferred
.
jQuery.ajax
на новый источник jQuery.ajax
для примеров - обман.
Мне особенно интересно, какие методы доступны, когда мы абстрагируемся, выполняется ли операция синхронно или асинхронно.
Ответы
Ответ 1
Лучший пример использования, о котором я могу думать, - это кеширование ответов 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()
обрабатывает не-обещание/отложенное как завершенное, сразу же выполняя любые .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
});
Ответ 2
Вот немного другая реализация кеша AJAX, как в ehynd answer.
Как отмечено в вопросе о продолжении fortuneRice, реализация ehynd фактически не предотвратила несколько идентичных запросов, если запросы были выполнены до того, как один из них вернулся. То есть
for (var i=0; i<3; i++) {
getData("xxx");
}
скорее всего, приведет к 3 запросам AJAX, если результат для "xxx" еще не был кэширован раньше.
Это можно решить путем кэширования запроса Отложенные вместо результата:
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.
});
Ответ 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
});
При использовании Отложенного как только мьютекса, следите за последствиями производительности (http://jsperf.com/deferred-vs-mutex/2). Хотя удобство, а также дополнительные преимущества, предоставляемые Deferred, стоят того, чего стоит, и в фактическом (основанном на пользовательских событиях) использовании влияние производительности не должно быть заметно.
Ответ 4
Это саморекламный ответ, но я потратил несколько месяцев на его изучение и представил результаты на jQuery Conference San Francisco 2012.
Вот бесплатное видео разговора:
https://www.youtube.com/watch?v=juRtEEsHI9E
Ответ 5
Другое использование, которое я поставил перед собой, - это выборка данных из нескольких источников. В приведенном ниже примере я собираю несколько независимых объектов схемы JSON, используемых в существующем приложении для проверки между клиентом и сервером REST. В этом случае я не хочу, чтобы приложение на стороне браузера запускало загрузку данных до того, как все загруженные схемы были загружены. $.when.apply(). then() идеально подходит для этого. Спасибо Raynos за указатели на использование тогда (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);
});
Ответ 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);
});
Вы можете играть с приведенным выше кодом в этом jsFiddle.
Ответ 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
});
Ответ 8
Вы можете использовать отложенный объект, чтобы сделать жидкостный дизайн, который хорошо работает в браузерах 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);
});
Это будет сериализовать выполнение вашего кода, чтобы он выполнялся по своему усмотрению. Остерегайтесь ловушек при передаче меток объектов в качестве обратных вызовов отложенной. Когда такой метод выполняется как обратный вызов для отложенного, ссылка 'this' будет перезаписана ссылкой на отложенный объект и больше не будет ссылаться на объект, к которому принадлежит метод.
Ответ 9
Вы также можете интегрировать его с любыми сторонними библиотеками, использующими JQuery.
Одной из таких библиотек является Backbone, которая фактически будет поддерживать Deferred в следующей версии.
Ответ 10
Я только что использовал Deferred в реальном коде. В проекте jQuery Terminal У меня есть функция exec, которая вызывает команды, определенные пользователем (например, он вводил ее и нажимал enter), я добавил Отложенные API и call 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 используется в функции возобновления, которая вызывает exec снова со всеми dalyed_commands.
и часть функции команд (я разделил не связанные части)
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();
}
}
}
Ответ 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.
});
Ответ Джулиана Д. будет работать правильно и является лучшим решением.