Jak mogę obiecać natywną XHR?

Chcę używać (natywnych) obietnic w mojej aplikacji frontendowej do wykonywania żądania XHR, ale bez całej głupoty ogromnego frameworka.

Chcę wrócić do mojego XHR obietnicę, ale to nie działa (co daje mi: Uncaught TypeError: Promise resolver undefined is not a function)

function makeXHRRequest (method, url, done) {
  var xhr = new XMLHttpRequest();
  xhr.open(method, url);
  xhr.onload = function() { return new Promise().resolve(); };
  xhr.onerror = function() { return new Promise().reject(); };
  xhr.send();
}

makeXHRRequest('GET', 'http://example.com')
.then(function (datums) {
  console.log(datums);
});

Zakładam, że wiesz, jak złożyć natywną prośbę XHR (możesz odświeżyć tutaj i tutaj )

Ponieważ każda przeglądarka, która obsługuje natywne obietnice, będzie również obsługiwać xhr.onload, możemy pominąć wszelkie onReadyStateChangewygłupy. Cofnijmy się i zacznijmy od podstawowej funkcji żądania XHR za pomocą wywołań zwrotnych:

function makeRequest (method, url, done) {
  var xhr = new XMLHttpRequest();
  xhr.open(method, url);
  xhr.onload = function () {
    done(null, xhr.response);
  };
  xhr.onerror = function () {
    done(xhr.response);
  };
  xhr.send();
}

// And we'd call it as such:

makeRequest('GET', 'http://example.com', function (err, datums) {
  if (err) { throw err; }
  console.log(datums);
});

Hurra! Nie wiąże się to z niczym strasznie skomplikowanym (jak niestandardowe nagłówki lub dane POST), ale wystarczy, abyśmy posunęli się naprzód.

Konstruktor obietnicy

Możemy zbudować taką obietnicę:

new Promise(function (resolve, reject) {
  // Do some Async stuff
  // call resolve if it succeeded
  // reject if it failed
});

Konstruktor obietnicy przyjmuje funkcję, która otrzyma dwa argumenty (nazwijmy je resolvei reject). Można je traktować jako oddzwanianie, jeden dla sukcesu, a drugi dla niepowodzenia. Przykłady są niesamowite, zaktualizujmy za makeRequestpomocą tego konstruktora:

function makeRequest (method, url) {
  return new Promise(function (resolve, reject) {
    var xhr = new XMLHttpRequest();
    xhr.open(method, url);
    xhr.onload = function () {
      if (this.status >= 200 && this.status < 300) {
        resolve(xhr.response);
      } else {
        reject({
          status: this.status,
          statusText: xhr.statusText
        });
      }
    };
    xhr.onerror = function () {
      reject({
        status: this.status,
        statusText: xhr.statusText
      });
    };
    xhr.send();
  });
}

// Example:

makeRequest('GET', 'http://example.com')
.then(function (datums) {
  console.log(datums);
})
.catch(function (err) {
  console.error('Augh, there was an error!', err.statusText);
});

Teraz możemy skorzystać z mocy obietnic, łącząc wiele połączeń XHR (i .catchspowoduje to błąd przy każdym połączeniu):

makeRequest('GET', 'http://example.com')
.then(function (datums) {
  return makeRequest('GET', datums.url);
})
.then(function (moreDatums) {
  console.log(moreDatums);
})
.catch(function (err) {
  console.error('Augh, there was an error!', err.statusText);
});

Możemy to jeszcze poprawić, dodając zarówno parametry POST / PUT, jak i niestandardowe nagłówki. Użyjmy obiektu opcji zamiast wielu argumentów z podpisem:

{
  method: String,
  url: String,
  params: String | Object,
  headers: Object
}

makeRequest teraz wygląda mniej więcej tak:

function makeRequest (opts) {
  return new Promise(function (resolve, reject) {
    var xhr = new XMLHttpRequest();
    xhr.open(opts.method, opts.url);
    xhr.onload = function () {
      if (this.status >= 200 && this.status < 300) {
        resolve(xhr.response);
      } else {
        reject({
          status: this.status,
          statusText: xhr.statusText
        });
      }
    };
    xhr.onerror = function () {
      reject({
        status: this.status,
        statusText: xhr.statusText
      });
    };
    if (opts.headers) {
      Object.keys(opts.headers).forEach(function (key) {
        xhr.setRequestHeader(key, opts.headers[key]);
      });
    }
    var params = opts.params;
    // We'll need to stringify if we've been given an object
    // If we have a string, this is skipped.
    if (params && typeof params === 'object') {
      params = Object.keys(params).map(function (key) {
        return encodeURIComponent(key) + '=' + encodeURIComponent(params[key]);
      }).join('&');
    }
    xhr.send(params);
  });
}

// Headers and params are optional
makeRequest({
  method: 'GET',
  url: 'http://example.com'
})
.then(function (datums) {
  return makeRequest({
    method: 'POST',
    url: datums.url,
    params: {
      score: 9001
    },
    headers: {
      'X-Subliminal-Message': 'Upvote-this-answer'
    }
  });
})
.catch(function (err) {
  console.error('Augh, there was an error!', err.statusText);
});

Bardziej kompleksowe podejście można znaleźć w MDN .

Alternatywnie możesz użyć interfejsu API pobierania ( polyfill ).

Może to być tak proste, jak poniższy kod.

Należy pamiętać, że ten kod będzie rejectwyzwalał wywołanie zwrotne tylko wtedy, gdy onerrorzostanie wywołany ( tylko błędy sieciowe ), a nie wtedy, gdy kod stanu HTTP oznacza błąd. Wyklucza to również wszystkie inne wyjątki. Zajmowanie się nimi powinno zależeć od ciebie, IMO.

Ponadto zaleca się wywoływanie rejectwywołania zwrotnego z wystąpieniem Errorzdarzenia, a nie z samym zdarzeniem, ale dla uproszczenia pozostawiłem to, co jest.

function request(method, url) {
    return new Promise(function (resolve, reject) {
        var xhr = new XMLHttpRequest();
        xhr.open(method, url);
        xhr.onload = resolve;
        xhr.onerror = reject;
        xhr.send();
    });
}

Przywoływanie może być następujące:

request('GET', 'http://google.com')
    .then(function (e) {
        console.log(e.target.response);
    }, function (e) {
        // handle errors
    });

Dla każdego, kto szuka tego teraz, możesz użyć funkcji pobierania . Ma całkiem dobre wsparcie .

fetch('http://example.com/movies.json')
  .then(response => response.json())
  .then(data => console.log(data));

Najpierw użyłem odpowiedzi @ SomeKittens, ale potem odkryłem, fetchże robi to dla mnie po wyjęciu z pudełka :)

Myślę, że możemy uczynić najwyższą odpowiedź bardziej elastyczną i wielokrotnego użytku, nie tworząc XMLHttpRequestobiektu. Jedyną korzyścią z tego jest to, że nie musimy sami pisać 2 lub 3 wierszy kodu, a ma to ogromną wadę polegającą na tym, że zabieramy dostęp do wielu funkcji API, takich jak ustawianie nagłówków. Ukrywa także właściwości oryginalnego obiektu przed kodem, który ma obsłużyć odpowiedź (zarówno w przypadku sukcesów, jak i błędów). Możemy więc uczynić bardziej elastyczną, szerzej stosowaną funkcję, akceptując XMLHttpRequestobiekt jako dane wejściowe i przekazując go jako wynik .

Ta funkcja przekształca dowolny XMLHttpRequestobiekt w obietnicę, domyślnie traktując kody stanu inne niż 200 jako błąd:

function promiseResponse(xhr, failNon2xx = true) {
    return new Promise(function (resolve, reject) {
        // Note that when we call reject, we pass an object
        // with the request as a property. This makes it easy for
        // catch blocks to distinguish errors arising here
        // from errors arising elsewhere. Suggestions on a 
        // cleaner way to allow that are welcome.
        xhr.onload = function () {
            if (failNon2xx && (xhr.status < 200 || xhr.status >= 300)) {
                reject({request: xhr});
            } else {
                resolve(xhr);
            }
        };
        xhr.onerror = function () {
            reject({request: xhr});
        };
        xhr.send();
    });
}

Ta funkcja bardzo naturalnie wpasowuje się w łańcuch Promises, bez poświęcania elastyczności XMLHttpRequestinterfejsu API:

Promise.resolve()
.then(function() {
    // We make this a separate function to avoid
    // polluting the calling scope.
    var xhr = new XMLHttpRequest();
    xhr.open('GET', 'https://stackoverflow.com/');
    return xhr;
})
.then(promiseResponse)
.then(function(request) {
    console.log('Success');
    console.log(request.status + ' ' + request.statusText);
});

catchzostał pominięty powyżej, aby uprościć przykładowy kod. Zawsze powinieneś go mieć i oczywiście możemy:

Promise.resolve()
.then(function() {
    var xhr = new XMLHttpRequest();
    xhr.open('GET', 'https://stackoverflow.com/doesnotexist');
    return xhr;
})
.then(promiseResponse)
.catch(function(err) {
    console.log('Error');
    if (err.hasOwnProperty('request')) {
        console.error(err.request.status + ' ' + err.request.statusText);
    }
    else {
        console.error(err);
    }
});

A wyłączenie obsługi kodu statusu HTTP nie wymaga dużych zmian w kodzie:

Promise.resolve()
.then(function() {
    var xhr = new XMLHttpRequest();
    xhr.open('GET', 'https://stackoverflow.com/doesnotexist');
    return xhr;
})
.then(function(xhr) { return promiseResponse(xhr, false); })
.then(function(request) {
    console.log('Done');
    console.log(request.status + ' ' + request.statusText);
});

Nasz kod wywołujący jest dłuższy, ale koncepcyjnie nadal łatwo jest zrozumieć, co się dzieje. I nie musimy odbudowywać całego interfejsu API żądania internetowego, aby obsługiwać jego funkcje.

Możemy dodać kilka wygodnych funkcji, aby uporządkować nasz kod, a także:

function makeSimpleGet(url) {
    var xhr = new XMLHttpRequest();
    xhr.open('GET', url);
    return xhr;
}

function promiseResponseAnyCode(xhr) {
    return promiseResponse(xhr, false);
}

Następnie nasz kod staje się:

Promise.resolve(makeSimpleGet('https://stackoverflow.com/doesnotexist'))
.then(promiseResponseAnyCode)
.then(function(request) {
    console.log('Done');
    console.log(request.status + ' ' + request.statusText);
});

Moim zdaniem odpowiedź jpmc26 jest prawie idealna. Ma jednak pewne wady:

1. Odsłania żądanie xhr tylko do ostatniej chwili. To nie pozwala POST-requests na ustawienie treści żądania.
2. Trudniej jest go odczytać, ponieważ kluczowa sendfunkcja jest ukryta w funkcji.
3. Wprowadza sporo bojlera podczas faktycznego żądania.

Małpa łatająca obiekt xhr rozwiązuje następujące problemy:

function promisify(xhr, failNon2xx=true) {
    const oldSend = xhr.send;
    xhr.send = function() {
        const xhrArguments = arguments;
        return new Promise(function (resolve, reject) {
            // Note that when we call reject, we pass an object
            // with the request as a property. This makes it easy for
            // catch blocks to distinguish errors arising here
            // from errors arising elsewhere. Suggestions on a 
            // cleaner way to allow that are welcome.
            xhr.onload = function () {
                if (failNon2xx && (xhr.status < 200 || xhr.status >= 300)) {
                    reject({request: xhr});
                } else {
                    resolve(xhr);
                }
            };
            xhr.onerror = function () {
                reject({request: xhr});
            };
            oldSend.apply(xhr, xhrArguments);
        });
    }
}

Teraz użycie jest tak proste, jak:

let xhr = new XMLHttpRequest()
promisify(xhr);
xhr.open('POST', 'url')
xhr.setRequestHeader('Some-Header', 'Some-Value')

xhr.send(resource).
    then(() => alert('All done.'),
         () => alert('An error occured.'));

Oczywiście wprowadza to inną wadę: łatanie małp szkodzi wydajności. Nie powinno to jednak stanowić problemu przy założeniu, że użytkownik czeka głównie na wynik xhr, że samo żądanie zajmuje rząd wielkości dłużej niż ustawienie połączenia i żądania xhr nie są często wysyłane.

PS: I oczywiście, jeśli celujesz w nowoczesne przeglądarki, użyj funkcji pobierania!

PPS: W komentarzach zaznaczono, że ta metoda zmienia standardowe API, co może być mylące. Dla większej przejrzystości można wstawić inną metodę na obiekt xhr sendAndGetPromise().