Esta página foi traduzida pela API Cloud Translation.

Introdução a fetch()

Matt Gaunt

O fetch() permite fazer solicitações de rede semelhantes a XMLHttpRequest (XHR). A principal diferença é que a API Fetch usa promessas, que têm uma API mais simples para ajudar a evitar os callbacks complicados na API XMLHttpRequest.

Compatibilidade com navegadores

Origem

Se você nunca usou Promessas confira a Introdução às promessas do JavaScript (em inglês).

Solicitação de busca básica

Confira um exemplo implementado com um XMLHttpRequest e depois com fetch. Queremos solicitar um URL, receber uma resposta e analisar como JSON.

XMLHttpRequest

Um XMLHttpRequest precisa de dois listeners para processar os casos de sucesso e de erro, além de uma chamada para open() e send(). Exemplo das documentações do MDN.

function reqListener () {
  const data = JSON.parse(this.responseText);
  console.log(data);
}

function reqError (err) {
  console.log('Fetch Error :-S', err);
}

const oReq = new XMLHttpRequest();
oReq.onload = reqListener;
oReq.onerror = reqError;
oReq.open('get', './api/some.json', true);
oReq.send();

Buscar

A solicitação de busca tem esta aparência:

fetch('./api/some.json')
  .then(response => {
    if (response.status !== 200) {
      console.log(`Looks like there was a problem. Status Code: ${response.status}`);

      return;
    }

    // Examine the text in the response
    response.json().then(function(data) {
      console.log(data);
    });
  })
  .catch(err => {
    console.log('Fetch Error :-S', err);
  });

A solicitação fetch() precisa de apenas uma chamada para fazer o mesmo trabalho que o XHR exemplo. Para processar a resposta, primeiro verificamos se o status dela é 200 e, em seguida, analisamos a resposta como JSON. A resposta a uma solicitação fetch() é uma Stream, o que significa que após chamamos o método json(), uma promessa é retornada. O stream ocorre de forma assíncrona.

Metadados de resposta

O exemplo anterior mostrou o status do objeto Response e como analisar a resposta como JSON. Veja como lidar com outros metadados que você pode querer acessar, como cabeçalhos:

fetch('users.json').then(response => {
  console.log(response.headers.get('Content-Type'));
  console.log(response.headers.get('Date'));

  console.log(response.status);
  console.log(response.statusText);
  console.log(response.type);
  console.log(response.url);
});

Tipos de resposta

Quando fazemos uma solicitação de busca, a resposta recebe um response.type de "basic", "cors" ou "opaque". Esses types mostram de onde o recurso veio, e você pode usá-los para determinar como tratar o objeto de resposta.

Quando o navegador solicita um recurso na mesma origem, a resposta tem um tipo basic com restrições sobre o que você pode visualizar na resposta.

Se for feita uma solicitação para um recurso em outra origem e essa origem retornar cabeçalhos CORs, o tipo será cors. cors as respostas são semelhantes às respostas basic, mas restringem os cabeçalhos que você pode visualizar até Cache-Control, Content-Language, Content-Type, Expires, Last-Modified e Pragma.

As respostas opaque vêm de uma origem diferente que não retorna cabeçalhos CORS. Com uma resposta opaca, não será possível ler os dados retornados nem conferir o status da solicitação. Isso significa que você não pode verificar se a solicitação foi bem-sucedida.

É possível definir um modo para uma solicitação de busca para que apenas determinados tipos de solicitação sejam resolvidos. Os modos que podem ser definidos são:

O same-origin só é bem-sucedido para solicitações de recursos na mesma origem e rejeita todas as outras.
cors permite solicitações de recursos na mesma origem e em outras origens que retornam os cabeçalhos CORS apropriados.
O cors-with-forced-preflight executa uma verificação pré-voo antes de fazer qualquer solicitação.
O no-cors tem como objetivo fazer solicitações para outras origens que não têm cabeçalhos CORS e resultar em uma resposta opaque, mas, conforme declarado, isso não é possível no escopo global da janela no momento.

Para definir o modo, adicione um objeto de opções como o segundo parâmetro na fetch e defina o modo nesse objeto:

fetch('http://some-site.com/cors-enabled/some.json', {mode: 'cors'})
  .then(response => response.text())
  .then(text => {
    console.log('Request successful', text);
  })
  .catch(error => {
    log('Request failed', error)
  });

Encadeamento de promessas

Um dos melhores recursos das promessas é a capacidade de encadeá-las. Para fetch(), que permite compartilhar a lógica entre solicitações de busca.

Se você estiver trabalhando com uma API JSON, será necessário verificar o status e analisar o JSON para cada resposta. É possível simplificar seu código definindo o status e A análise JSON em funções separadas que retornam promessas e usa o método para manipular apenas os dados finais e o caso de erro.

function status (response) {
  if (response.status >= 200 && response.status < 300) {
    return Promise.resolve(response)
  } else {
    return Promise.reject(new Error(response.statusText))
  }
}

function json (response) {
  return response.json()
}

fetch('users.json')
  .then(status)
  .then(json)
  .then(data => {
    console.log('Request succeeded with JSON response', data);
  }).catch(error => {
    console.log('Request failed', error);
  });

Este exemplo define uma função status que verifica a response.status e retorna uma promessa resolvida como Promise.resolve() ou uma promessa rejeitada como Promise.reject(). Esse é o primeiro método chamado na cadeia fetch().

Se a promessa for resolvida, o script chamará o método json(), que retorna uma segunda promessa da chamada response.json() e cria uma que contém o JSON analisado. Se a análise falhar, a promessa será será rejeitada e a declaração de captura será executada.

Essa estrutura permite compartilhar a lógica em todas as suas solicitações de busca, facilitando a manutenção, a leitura e o teste do código.

Solicitação POST

Às vezes, um app da Web precisa chamar uma API com um método POST e incluir alguns parâmetros no corpo da solicitação. Para fazer isso, defina os parâmetros method e body nas opções fetch():

fetch(url, {
    method: 'post',
    headers: {
      "Content-type": "application/x-www-form-urlencoded; charset=UTF-8"
    },
    body: 'foo=bar&lorem=ipsum'
  })
  .then(json)
  .then(data => {
    console.log('Request succeeded with JSON response', data);
  })
  .catch(error => {
    console.log('Request failed', error);
  });

Enviar credenciais com uma solicitação de busca

Para fazer uma solicitação de busca com credenciais como cookies, defina o método Valor de credentials para "include":

fetch(url, {
  credentials: 'include'
})