Fronteers — vakvereniging voor front-end developers

Deferred en promise in jQuery

Deferred en promise? Gaan we het hebben over uitstellingen en beloftes in jQuery? Nee, gelukkig niet. Deferred en promise zitten sinds versie 1.5 in jQuery en daarmee kan je asynchrone functies zoals Ajax beter afhandelen.

Even een stapje terug in de tijd, toen we nog met guldens en franken betaalden. Als je een muisklik wilde afvangen, deed je dat met element.onclick = someFunction; Dat werd een probleem als een ander stukje code ook naar de klik wilde luisteren. Dat kon niet, want aan onclick kan je maar één functie toekennen. Dit is destijds opgelost met de DOM-functie addEventListener. Daarmee kan je zoveel functies die luisteren toevoegen als je wilt. En sindsdien weten we niet beter.

Nu hebben we een vergelijkbaar probleem met Ajax-aanroepen. Nu niet met events, maar met het gegeven dat Ajax maar één callback-functie accepteert. Niet alleen bij de jQuery $.ajax()-aanroep, maar ook bij het onderliggende XMLHttpRequest-object.

Promise

Tot jQuery 1.5 zag een typische $.ajax()-aanroep er als volgt uit:

$.ajax({
url: "/myServerScript",
success: mySuccessFunction,
error: myErrorFunction
});

De $.ajax()-functie retourneert een jQuery XMLHttpRequest-object.

Tot zover niets nieuws. Vanaf versie 1.5 implementeert het teruggegeven object ook de CommonJS Promises/A-interface. Dat is een hele mond vol. CommonJS is een initiatief om gemeenschappelijke en onafhankelijke interfaces (API's) vast te leggen. Promises/A is zo'n interface. Het voordeel is dat deze niet jQuery-specifiek is. Als je bijvoorbeeld met Node.js werkt, dan is de kans groot dat je met dezelfde interface te maken krijgt. Handig.

De manier van callbacks toewijzen is met Promises heel anders:

var promise = $.ajax({
url: "/myServerScript"
});

promise.done(mySuccessFunction);
promise.fail(myErrorFunction);

"Oke, de interface is nu veranderd, maar wat heb ik daaraan?", zul je je vast afvragen.

De voordelen van promises zijn:

1) Je kunt de done()- en fail()-functies meerdere keren aanroepen, met verschillende callbacks. Misschien heb je wel een callbackfunctie die een animatie stopt, een die een nieuwe Ajax-aanroep doet en een andere functie die de ontvangen gegevens aan de bezoeker toont.

var promise = $.ajax({
url: "/myServerScript"
});

promise.done(myStopAnimationFunction);
promise.done(myOtherAjaxFunction);
promise.done(myShowInfoFunction);
promise.fail(myErrorFunction);

2) Ook als de Ajax-aanroep al geweest is, kan je nog steeds de done()- en fail()-functies aanroepen en de callbacks worden dan gelijk uitgevoerd. Dus geen gedoe meer met variabelen die de verschillende staten moeten onthouden. Als een Ajax-aanroep afgelopen is, dan komt deze of in de succes-staat of in de fout-staat en deze zal niet meer veranderen.

3) Je kunt promises combineren. Soms is het nodig om gelijktijdig twee Ajax-aanroepen te doen en wil je een functie pas aanroepen als beide succesvol zijn verlopen. Hiervoor gebruik je de nieuwe $.when()-functie:

var promise1 = $.ajax("/myServerScript1");
var promise2 = $.ajax("/myServerScript2");

$.when(promise1, promise2).done(function(response1, response2){
// Handle both responses
});

Deferred

Wat is dan een deferred en wat is het verschil met een promise? Zoals je hierboven hebt gezien is een promise een object dat je terugkrijgt van een asynchrone functie. Een deferred heb je nodig als je zelf zo'n functie schrijft.

Een deferred object kan hetzelfde als een promise object, maar heeft twee extra functies om de .done()- en .fail()-functies te laten afgaan.

Een deferred-object heeft een .resolve()-functie om een succesvolle uitkomst aan te geven en de met .done() geregistreerde functies uit te voeren. De .reject()-functie geeft een gefaalde uitkomst aan en voert de met .fail() geregistreerde functies uit.

Aan de .resolve()- en .reject()-functies kunnen parameters worden meegegeven die de met .done() en .fail() geregistreerde functies als argument meekrijgen.

Het promise-object heeft geen .resolve()- en .reject()-functie. Het promise object geef je immers weg aan andere scripts waarvan je niet wilt dat zij de promise kunnen laten resolven of rejecten.

Hieronder een eenvoudig script dat de werking illustreert. De html bestaat uit een leeg divje met als id "result".

$('#result').html('waiting...');

var promise = wait();
promise.done(result);

function result() {
$('#result').html('done');
}

function wait() {
var deferred = $.Deferred();

setTimeout(function() {
deferred.resolve();
}, 2000);

return deferred.promise();
}

Het script is ook te vinden op jsFiddle, zodat je er zelf mee kunt experimenteren.

De wait()-functie is de functie die een promise teruggeeft. Deze wordt resolved via een setTimeout van twee seconden. In plaats van de setTimeout kan alles gebruikt worden wat asynchroon is, zoals Ajax, animaties, Web workers, enzovoorts. Duidelijk is dat binnen de wait()-functie een deferred-object wordt gebruikt, maar dat we het beperkte promise-object teruggeven.

jQuery-ondersteuning

Op het jQuery-blog is te lezen dat jQuery helemaal voor promises gaat en dat de oude API, met de .error()-, .success()- en .complete()-functies, uiteindelijk zal verdwijnen. Als je deze functies gebruikt, dan kan je alvast beginnen je code te herschrijven en over te stappen op de promise-interface.

Meer mogelijk

Dit artikel is slechts een introductie in de werking van het deferred-object. jQuery ondersteunt nog veel meer functies. Bekijk de jQuery deferred documentatie voor alle mogelijkheden. Zo is het bijvoorbeeld ook mogelijk om met promises de voortgang van een proces bij te houden.

Reacties

1 Edwin Martin op 25-01-2012 om 22:04 uur:
I translated this article to English:

http://www.bitstorm.org/weblog/2012-1/Deferred_en_promise_in_jQuery.html
2 Roel N op 27-01-2012 om 13:40 uur:
Beetje late reactie misschien, maar thanks voor het artikel! Klinkt inderdaad een stuk flexibeler dan alles in de "success" van de $.ajax te gooien.
3 elwatanya op 19-05-2022 om 16:48 uur:
Nous sommes toujours en besoin d’impression de produits de communication dans notre vie professionnelle malgré l’évolution et la digitalisation du marché. Les materiels de publicité imprimer sont incontournable de nos jours, ils ont une grande valeur sur le marché, par exemple, si vous https://www.elwatanya.com/cartevisite Imprimer carte visite Marrakech ce sera plus pratique et plus efficace pour laisser une bonne impression sur l’image de la marque dans l’esprit des clients que d’autre outils de digitalisation.

Vous souhaitez imprimer des flyers avec un désigne spéciale et personnalisé. Notre societe est spécialiste en https://www.elwatanya.com/flyer-marrakech-maroc/ impression flyers Maroc et https://www.elwatanya.com/flyer-marrakech-maroc/ impression prospectus il suffit de nous contacter pour nous transmetre les détails de votre projet, evenement ou bien votre produits et votre logo pour que notre infographiste pourait vous proposez un designe de flyers souhaitable.

L’imprimerie c’est un ensemble de techniques d'impression permettant la reproduction, à un nombre quelconque d'exemplaires, de signes ou d'images (généralement de textes) sur un support de papier (ou une matière assimilable au papier) sous forme de feuilles simples, de livres, brochures et journaux. L'art de l'imprimerie, la découverte de l'imprimerie. Visitez-nous si vous êtes en besoin d’impression quel que soit les produits que vous voulez imprimer. Nous sommes https://www.elwatanya.com/imprimrie-papetrie-elwatanya imprimerie Marrakech .

Énormément d’objets du quotidien font appel à l’https://www.elwatanya.com/imprimrie-papetrie-elwatanya impression Voici une liste des supports d’impression les plus populaires : Magazines, manuels, livres et journaux, Dépliants et affiches, Pancartes, Papier transparent et glacé, boîtes et emballage carton et https://www.elwatanya.com/imprimer-adhesif-marrakech-maroc adhesif .
Plaats een reactie