J'ai besoin de faire une requête HTTP GET en JavaScript. Quelle est la meilleure façon de procéder?
Je dois le faire dans un widget de code de tableau de bord Mac OS X.
J'ai besoin de faire une requête HTTP GET en JavaScript. Quelle est la meilleure façon de procéder?
Je dois le faire dans un widget de code de tableau de bord Mac OS X.
Réponses:
Les navigateurs (et Dashcode) fournissent un objet XMLHttpRequest qui peut être utilisé pour effectuer des requêtes HTTP à partir de JavaScript:
function httpGet(theUrl)
{
var xmlHttp = new XMLHttpRequest();
xmlHttp.open( "GET", theUrl, false ); // false for synchronous request
xmlHttp.send( null );
return xmlHttp.responseText;
}
Cependant, les demandes synchrones sont déconseillées et généreront un avertissement du type:
Remarque: À partir de Gecko 30.0 (Firefox 30.0 / Thunderbird 30.0 / SeaMonkey 2.27), les requêtes synchrones sur le thread principal ont été dépréciées en raison des effets négatifs sur l'expérience utilisateur.
Vous devez effectuer une demande asynchrone et gérer la réponse dans un gestionnaire d'événements.
function httpGetAsync(theUrl, callback)
{
var xmlHttp = new XMLHttpRequest();
xmlHttp.onreadystatechange = function() {
if (xmlHttp.readyState == 4 && xmlHttp.status == 200)
callback(xmlHttp.responseText);
}
xmlHttp.open("GET", theUrl, true); // true for asynchronous
xmlHttp.send(null);
}
$.get(
"somepage.php",
{paramOne : 1, paramX : 'abc'},
function(data) {
alert('page content: ' + data);
}
);
Beaucoup de bons conseils ci-dessus, mais pas très réutilisables, et trop souvent remplis de bêtises DOM et d'autres peluches qui cachent le code facile.
Voici une classe Javascript que nous avons créée, réutilisable et facile à utiliser. Actuellement, il n'a qu'une méthode GET, mais cela fonctionne pour nous. L'ajout d'un POST ne devrait pas taxer les compétences de quiconque.
var HttpClient = function() {
this.get = function(aUrl, aCallback) {
var anHttpRequest = new XMLHttpRequest();
anHttpRequest.onreadystatechange = function() {
if (anHttpRequest.readyState == 4 && anHttpRequest.status == 200)
aCallback(anHttpRequest.responseText);
}
anHttpRequest.open( "GET", aUrl, true );
anHttpRequest.send( null );
}
}
Son utilisation est aussi simple que:
var client = new HttpClient();
client.get('http://some/thing?with=arguments', function(response) {
// do something with response
});
ReferenceError: XMLHttpRequest is not defined
La nouvelle window.fetch
API est un remplacement plus propre XMLHttpRequest
qui utilise les promesses ES6. Il y a une belle explication ici , mais cela se résume à (de l'article):
fetch(url).then(function(response) {
return response.json();
}).then(function(data) {
console.log(data);
}).catch(function() {
console.log("Booo");
});
La prise en charge du navigateur est désormais bonne dans les dernières versions (fonctionne dans Chrome, Firefox, Edge (v14), Safari (v10.1), Opera, Safari iOS (v10.3), navigateur Android et Chrome pour Android), mais IE le fera n'obtiendra probablement pas de soutien officiel. GitHub a un polyfill disponible qui est recommandé pour prendre en charge les navigateurs plus anciens encore largement utilisés (en particulier les versions de Safari avant mars 2017 et les navigateurs mobiles de la même période).
Je suppose que cela est plus pratique que jQuery ou XMLHttpRequest ou non dépend de la nature du projet.
Voici un lien vers la spécification https://fetch.spec.whatwg.org/
Modifier :
En utilisant async / wait ES7, cela devient simplement (basé sur cet Gist ):
async function fetchAsync (url) {
let response = await fetch(url);
let data = await response.json();
return data;
}
fetch(url, { credentials:"include" })
window.fetch
n'est pas fourni avec un analyseur XML, mais vous pouvez analyser la réponse vous-même si vous la gérez comme du texte (pas json comme dans l'exemple ci-dessus). Voir stackoverflow.com/a/37702056/66349 pour un exemple
Une version sans rappel
var i = document.createElement("img");
i.src = "/your/GET/url?params=here";
setInterval
appel.
Voici le code pour le faire directement avec JavaScript. Mais, comme mentionné précédemment, vous seriez beaucoup mieux avec une bibliothèque JavaScript. Mon préféré est jQuery.
Dans le cas ci-dessous, une page ASPX (qui sert de service REST pour un pauvre) est appelée pour renvoyer un objet JSON JavaScript.
var xmlHttp = null;
function GetCustomerInfo()
{
var CustomerNumber = document.getElementById( "TextBoxCustomerNumber" ).value;
var Url = "GetCustomerInfoAsJson.aspx?number=" + CustomerNumber;
xmlHttp = new XMLHttpRequest();
xmlHttp.onreadystatechange = ProcessRequest;
xmlHttp.open( "GET", Url, true );
xmlHttp.send( null );
}
function ProcessRequest()
{
if ( xmlHttp.readyState == 4 && xmlHttp.status == 200 )
{
if ( xmlHttp.responseText == "Not found" )
{
document.getElementById( "TextBoxCustomerName" ).value = "Not found";
document.getElementById( "TextBoxCustomerAddress" ).value = "";
}
else
{
var info = eval ( "(" + xmlHttp.responseText + ")" );
// No parsing necessary with JSON!
document.getElementById( "TextBoxCustomerName" ).value = info.jsonData[ 0 ].cmname;
document.getElementById( "TextBoxCustomerAddress" ).value = info.jsonData[ 0 ].cmaddr1;
}
}
}
Une version moderne copier-coller (en utilisant la fonction fetch et flèche ) :
//Option with catch
fetch( textURL )
.then(async r=> console.log(await r.text()))
.catch(e=>console.error('Boo...' + e));
//No fear...
(async () =>
console.log(
(await (await fetch( jsonURL )).json())
)
)();
Une version classique copier-coller:
let request = new XMLHttpRequest();
request.onreadystatechange = function () {
if (this.readyState === 4) {
if (this.status === 200) {
document.body.className = 'ok';
console.log(this.responseText);
} else if (this.response == null && this.status === 0) {
document.body.className = 'error offline';
console.log("The computer appears to be offline.");
} else {
document.body.className = 'error';
}
}
};
request.open("GET", url, true);
request.send(null);
Court et propre:
const http = new XMLHttpRequest()
http.open("GET", "https://api.lyrics.ovh/v1/toto/africa")
http.send()
http.onload = () => console.log(http.responseText)
IE mettra en cache les URL afin d'accélérer le chargement, mais si, par exemple, vous interrogez un serveur à intervalles réguliers pour essayer d'obtenir de nouvelles informations, IE mettra en cache cette URL et renverra probablement le même ensemble de données que vous avez toujours eu.
Quelle que soit la façon dont vous finissez par faire votre demande GET - vanilla JavaScript, Prototype, jQuery, etc. - assurez-vous de mettre en place un mécanisme pour lutter contre la mise en cache. Afin de lutter contre cela, ajoutez un jeton unique à la fin de l'URL que vous allez frapper. Cela peut être fait par:
var sURL = '/your/url.html?' + (new Date()).getTime();
Cela ajoutera un horodatage unique à la fin de l'URL et empêchera toute mise en cache.
Un prototype simplifie la vie
new Ajax.Request( '/myurl', {
method: 'get',
parameters: { 'param1': 'value1'},
onSuccess: function(response){
alert(response.responseText);
},
onFailure: function(){
alert('ERROR');
}
});
Une solution prenant en charge les anciens navigateurs:
function httpRequest() {
var ajax = null,
response = null,
self = this;
this.method = null;
this.url = null;
this.async = true;
this.data = null;
this.send = function() {
ajax.open(this.method, this.url, this.asnyc);
ajax.send(this.data);
};
if(window.XMLHttpRequest) {
ajax = new XMLHttpRequest();
}
else if(window.ActiveXObject) {
try {
ajax = new ActiveXObject("Msxml2.XMLHTTP.6.0");
}
catch(e) {
try {
ajax = new ActiveXObject("Msxml2.XMLHTTP.3.0");
}
catch(error) {
self.fail("not supported");
}
}
}
if(ajax == null) {
return false;
}
ajax.onreadystatechange = function() {
if(this.readyState == 4) {
if(this.status == 200) {
self.success(this.responseText);
}
else {
self.fail(this.status + " - " + this.statusText);
}
}
};
}
Peut-être un peu exagéré, mais vous allez certainement en sécurité avec ce code.
Usage:
//create request with its porperties
var request = new httpRequest();
request.method = "GET";
request.url = "https://example.com/api?parameter=value";
//create callback for success containing the response
request.success = function(response) {
console.log(response);
};
//and a fail callback containing the error
request.fail = function(error) {
console.log(error);
};
//and finally send it away
request.send();
Je ne connais pas les widgets Dashcode de Mac OS, mais s'ils vous permettent d'utiliser des bibliothèques JavaScript et de prendre en charge XMLHttpRequests , j'utiliserais jQuery et ferais quelque chose comme ceci:
var page_content;
$.get( "somepage.php", function(data){
page_content = data;
});
Dans le fichier Info.plist de votre widget, n'oubliez pas de définir votre AllowNetworkAccess
clé sur true.
La meilleure façon est d'utiliser AJAX (vous pouvez trouver un tutoriel simple sur cette page Tizag ). La raison en est que toute autre technique que vous pouvez utiliser nécessite plus de code, il n'est pas garanti de fonctionner sur plusieurs navigateurs sans retravailler et vous oblige à utiliser plus de mémoire client en ouvrant des pages cachées à l'intérieur des cadres en passant des URL en analysant leurs données et en les fermant. AJAX est la voie à suivre dans cette situation. Que mes deux années de développement lourd en javascript parlent.
Pour ceux qui utilisent AngularJs , c'est $http.get
:
$http.get('/someUrl').
success(function(data, status, headers, config) {
// this callback will be called asynchronously
// when the response is available
}).
error(function(data, status, headers, config) {
// called asynchronously if an error occurs
// or server returns response with an error status.
});
Vous pouvez obtenir une demande HTTP GET de deux manières:
Cette approche basée sur le format xml. Vous devez transmettre l'URL de la demande.
xmlhttp.open("GET","URL",true);
xmlhttp.send();
Celui-ci est basé sur jQuery. Vous devez spécifier l'URL et le nom de fonction que vous souhaitez appeler.
$("btn").click(function() {
$.ajax({url: "demo_test.txt", success: function_name(result) {
$("#innerdiv").html(result);
}});
});
Pour ce faire, l'API Fetch est l'approche recommandée, à l'aide de promesses JavaScript. XMLHttpRequest (XHR), objet IFrame ou balises dynamiques sont des approches plus anciennes (et plus maladroites).
<script type=“text/javascript”>
// Create request object
var request = new Request('https://example.com/api/...',
{ method: 'POST',
body: {'name': 'Klaus'},
headers: new Headers({ 'Content-Type': 'application/json' })
});
// Now use it!
fetch(request)
.then(resp => {
// handle response })
.catch(err => {
// handle errors
}); </script>
Voici une excellente démonstration de récupération et des documents MDN
function get(path) {
var form = document.createElement("form");
form.setAttribute("method", "get");
form.setAttribute("action", path);
document.body.appendChild(form);
form.submit();
}
get('/my/url/')
La même chose peut être faite pour la demande de poste également.
Jetez un oeil à ce lien Demande de publication JavaScript comme un formulaire envoyer
Demande d'async simple:
function get(url, callback) {
var getRequest = new XMLHttpRequest();
getRequest.open("get", url, true);
getRequest.addEventListener("readystatechange", function() {
if (getRequest.readyState === 4 && getRequest.status === 200) {
callback(getRequest.responseText);
}
});
getRequest.send();
}
// Create a request variable and assign a new XMLHttpRequest object to it.
var request = new XMLHttpRequest()
// Open a new connection, using the GET request on the URL endpoint
request.open('GET', 'restUrl', true)
request.onload = function () {
// Begin accessing JSON data here
}
// Send request
request.send()
Si vous souhaitez utiliser le code d'un widget Dashboard et que vous ne souhaitez pas inclure une bibliothèque JavaScript dans chaque widget que vous avez créé, vous pouvez utiliser l'objet XMLHttpRequest pris en charge nativement par Safari.
Comme indiqué par Andrew Hedges, un widget n'a pas accès à un réseau, par défaut; vous devez modifier ce paramètre dans le fichier info.plist associé au widget.
Pour rafraîchir la meilleure réponse de joann avec promesse, voici mon code:
let httpRequestAsync = (method, url) => {
return new Promise(function (resolve, reject) {
var xhr = new XMLHttpRequest();
xhr.open(method, url);
xhr.onload = function () {
if (xhr.status == 200) {
resolve(xhr.responseText);
}
else {
reject(new Error(xhr.responseText));
}
};
xhr.send();
});
}
Moderne, propre et le plus court
fetch('https://www.randomtext.me/api/lorem')
Vous pouvez aussi le faire avec du JS pur:
// Create the XHR object.
function createCORSRequest(method, url) {
var xhr = new XMLHttpRequest();
if ("withCredentials" in xhr) {
// XHR for Chrome/Firefox/Opera/Safari.
xhr.open(method, url, true);
} else if (typeof XDomainRequest != "undefined") {
// XDomainRequest for IE.
xhr = new XDomainRequest();
xhr.open(method, url);
} else {
// CORS not supported.
xhr = null;
}
return xhr;
}
// Make the actual CORS request.
function makeCorsRequest() {
// This is a sample server that supports CORS.
var url = 'http://html5rocks-cors.s3-website-us-east-1.amazonaws.com/index.html';
var xhr = createCORSRequest('GET', url);
if (!xhr) {
alert('CORS not supported');
return;
}
// Response handlers.
xhr.onload = function() {
var text = xhr.responseText;
alert('Response from CORS request to ' + url + ': ' + text);
};
xhr.onerror = function() {
alert('Woops, there was an error making the request.');
};
xhr.send();
}
Voir: pour plus de détails: tutoriel html5rocks
<button type="button" onclick="loadXMLDoc()"> GET CONTENT</button>
<script>
function loadXMLDoc() {
var xmlhttp = new XMLHttpRequest();
var url = "<Enter URL>";``
xmlhttp.onload = function () {
if (xmlhttp.readyState == 4 && xmlhttp.status == "200") {
document.getElementById("demo").innerHTML = this.responseText;
}
}
xmlhttp.open("GET", url, true);
xmlhttp.send();
}
</script>
Voici une alternative aux fichiers xml pour charger vos fichiers en tant qu'objet et accéder aux propriétés en tant qu'objet de manière très rapide.
XML fonctionne comme un arbre ok? au lieu d'écrire
<property> value <property>
écrire un fichier simple comme celui-ci:
Property1: value
Property2: value
etc.
Enregistrez votre fichier .. Appelez maintenant la fonction ....
var objectfile = {};
function getfilecontent(url){
var cli = new XMLHttpRequest();
cli.onload = function(){
if((this.status == 200 || this.status == 0) && this.responseText != null) {
var r = this.responseText;
var b=(r.indexOf('\n')?'\n':r.indexOf('\r')?'\r':'');
if(b.length){
if(b=='\n'){var j=r.toString().replace(/\r/gi,'');}else{var j=r.toString().replace(/\n/gi,'');}
r=j.split(b);
r=r.filter(function(val){if( val == '' || val == NaN || val == undefined || val == null ){return false;}return true;});
r = r.map(f => f.trim());
}
if(r.length > 0){
for(var i=0; i<r.length; i++){
var m = r[i].split(':');
if(m.length>1){
var mname = m[0];
var n = m.shift();
var ivalue = m.join(':');
objectfile[mname]=ivalue;
}
}
}
}
}
cli.open("GET", url);
cli.send();
}
vous pouvez maintenant obtenir vos valeurs efficacement.
getfilecontent('mesite.com/mefile.txt');
window.onload = function(){
if(objectfile !== null){
alert (objectfile.property1.value);
}
}
C'est juste un petit cadeau à contribuer au groupe. Merci de votre amour :)
Si vous souhaitez tester la fonction sur votre PC localement, redémarrez votre navigateur avec la commande suivante (prise en charge par tous les navigateurs sauf safari):
yournavigator.exe '' --allow-file-access-from-files