web:js:ajax

Javascript - ajax

Auparavant utilisées via l'objet XmlHttpRequest des navigateurs, les requêtes partielles se font maintenant en utilisant l'api fetch.

Les promesses permettent d'écrire du code asynchrone, pour les méthodes qui nécessitent un temps d'exécution et ne peuvent retourner immédiatement un résultat.

Exemple : Chargement d'un script

function loadScript(src) {
  return new Promise(function(resolve, reject) {
    let script = document.createElement('script');
    script.src = src;

    script.onload = () => resolve(script);
    script.onerror = () => reject(new Error(`Script load error for ${src}`));

    document.head.append(script);
  });
}

  • resolve permet d'indiquer que la promesse est résolue
  • reject qu'elle n'a pas abouti

Utilisation

let promise = loadScript("https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.11/lodash.js");

promise.then(
  script => alert(`${script.src} is loaded!`),
  error => alert(`Error: ${error.message}`)
);

L'utilisation de async et await permet d'utiliser les fonctions asynchrones sans obligation de chaîner les promesses (pas besoin de mettre le code dans le retour then).

function resolveAfter2Seconds() {
  return new Promise(resolve => {
    setTimeout(() => {
      resolve('resolved');
    }, 2000);
  });
}

async function asyncCall() {
  console.log('calling');
  const result = await resolveAfter2Seconds();
  console.log(result);
  // Expected output: "resolved"
}

asyncCall();

L'api fetch permet en javascript d'effectuer des requêtes partielles vers le serveur, sans changer de page, selon le mode AJAX (Asynchronous Javascript And XML).

fetch fonctionne selon la syntaxe suivante :

let promise = fetch(url, [options])

  • Requête vers une url cible
  • en passant un tableau d'options (méthode, headers…)

Sans options, fetch effectue un simple GET téléchargeant le contenu.

Lors de l'utilisation de fetch, la requête est envoyée vers le serveur et renvoie une promise qui pourra être utilisée via un objet Response.

La réponse peut être analysée (via ses membres status ou ok, et on obtient son corps fourni sous la forme d'une seconde promesse :

let response = await fetch(url);

if (response.ok) { // Statut dans les 200
  // obtenir le corps de réponse au format JSON
  let json = await response.json();
} else {
  alert("HTTP-Error: " + response.status);
}

Méthode Action
response.headers() Retourne les en-têtes de la réponse
response.text() Retourne la réponse sous forme de texte
response.json() Retourne la réponse au format JSON
response.formData() Retourne un objet FormData
response.blob() Retourne la réponse sous forme de blob (données binaires typées)

Requête vers l'api Github pour obtenir la liste des messages de commits d'un repo :

Version await :

let url = 'https://api.github.com/repos/cnam-dist/nfa085-2023/commits';
let response = await fetch(url);

let commits = await response.json();

alert(commits[0].message);

Version then

fetch('https://api.github.com/repos/cnam-dist/nfa085-2023/commits')
  .then(response => response.json())
  .then(commits => alert(commits[0].message));

Chargement d'image :

let response = await fetch('/lib/tpl/bootstrap3/images/logo.png');

let blob = await response.blob(); // téléchargement en tant qu'objet Blob

// Création d img
let img = document.createElement('img');
img.style = 'position:fixed;top:10px;left:10px;width:100px';
document.body.append(img);

// Affichage
img.src = URL.createObjectURL(blob);

setTimeout(() => { // Effacement après 3 secondes
  img.remove();
  URL.revokeObjectURL(img.src);
}, 3000);

Response

L'objet response renvoyé contient un membre headers grace auquel il est possible dé récupérer les en-têtes :

let response = await fetch('https://api.github.com/repos/cnam-dist/nfa085-2023/commits');

// récupération d'un header
alert(response.headers.get('Content-Type')); // application/json; charset=utf-8

// itération sur tous les headers
for (let [key, value] of response.headers) {
  alert(`${key} = ${value}`);
}

Request

Les headers de la requête sont envoyées au travers des options du fetch :

let response = fetch(protectedUrl, {
  headers: {
    Authentication: 'secret'
  }
});

POST

La méthode HTTP utilisée peut également être spécifiée au travers des options, comme les données envoyées dans le body :

let user = {
  name: 'John',
  surname: 'DOE'
};

let response = await fetch('/post/user', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json;charset=utf-8'
  },
  body: JSON.stringify(user)
});

  • web/js/ajax.txt
  • Dernière modification : il y a 7 mois
  • de jcheron