Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / JavaScript

Padrão de cancelamento com um identificador de geração

Um identificador de geração permite que só a última operação iniciada atualize o estado, se ainda estiver em vigor. Uma operação anterior pode terminar sem sobrescrever esse estado.

Versão: ECMAScript 2024 and the current web platform; runtime support varies

Sintaxe

let current = null;

async function run(load, commit) {
  const ticket = {};
  current = ticket;
  const result = await load();
  if (ticket !== current) return;
  commit(result);
}

function invalidate() {
  current = null;
}

Numa caixa de pesquisa, a resposta a uma pesquisa anterior pode chegar depois da resposta a uma mais recente. Este padrão determina que operação pode alterar o estado. É um padrão de conceção, não uma sintaxe especial nem uma API incorporada no JavaScript.

Em cada arranque, cria um novo objeto ticket e guarda-o em current. O teste ticket === current compara a identidade dos objetos, não o seu conteúdo. Um novo arranque substitui o identificador atual; current = null invalida-o sem iniciar outra operação, por exemplo, ao fechar uma vista. Mantém um current separado para cada recurso atualizado de forma independente.

Depois de await, verifica o identificador imediatamente antes de alterar o estado. Se houver outro await pelo meio, verifica-o novamente antes de escrever. A rejeição de uma promessa lança uma exceção em await; verifica também o identificador antes de mostrar erros ou alterar um indicador de carregamento em finally. Trata ou propaga os erros da operação atual; não deixes que uma operação desatualizada altere a interface.

É um cancelamento lógico: não interrompe o trabalho nem reverte efeitos já produzidos. Se a API aceitar um sinal, cria uma nova instância de AbortController para cada operação e passa à API o valor da propriedade signal dessa instância. Depois de invalidares o identificador da operação, chama abort() na mesma instância. Mantém a verificação, porque nem todas as operações têm em conta o sinal. AbortController é uma API da plataforma Web e não faz parte do ECMAScript; confirma o suporte no ambiente de execução de destino.

Exemplos

(async () => {
  let current = null;
  let visible = '(empty)';

  async function show(pending) {
    const ticket = {};
    current = ticket;
    const result = await pending;
    if (ticket !== current) {
      console.log(`skip: ${result}`);
      return;
    }
    visible = result;
    console.log(`commit: ${visible}`);
  }

  let finishOld;
  const oldResult = new Promise((resolve) => { finishOld = resolve; });
  const oldRun = show(oldResult);
  await show(Promise.resolve('new'));
  finishOld('old');
  await oldRun;
  console.log(`visible: ${visible}`);
})();

Resultado

commit: new
skip: old
visible: new

`finishOld('old')` só é chamada depois de `new` ser guardado. `skip: old` é uma mensagem de diagnóstico, não uma alteração de `visible`.

Lições relacionadas

  • JavaScript · Lição 14 · Avançado · Versão: 4

Fontes