¿Por qué mi variable no se modifica después de modificarla dentro de una función? - Referencia de código asincrónico

Resuelto Maaz Ahmed asked hace 10 años • 0 respuestas

Dados los siguientes ejemplos, ¿por qué outerScopeVarno está definido en todos los casos?

var outerScopeVar;

var img = document.createElement('img');
img.onload = function() {
    outerScopeVar = this.width;
};
img.src = 'lolcat.png';
alert(outerScopeVar);
var outerScopeVar;
setTimeout(function() {
    outerScopeVar = 'Hello Asynchronous World!';
}, 0);
alert(outerScopeVar);
// Example using some jQuery
var outerScopeVar;
$.post('loldog', function(response) {
    outerScopeVar = response;
});
alert(outerScopeVar);
// Node.js example
var outerScopeVar;
fs.readFile('./catdog.html', function(err, data) {
    outerScopeVar = data;
});
console.log(outerScopeVar);
// with promises
var outerScopeVar;
myPromise.then(function (response) {
    outerScopeVar = response;
});
console.log(outerScopeVar);
// with observables
var outerScopeVar;
myObservable.subscribe(function (value) {
    outerScopeVar = value;
});
console.log(outerScopeVar);
// geolocation API
var outerScopeVar;
navigator.geolocation.getCurrentPosition(function (pos) {
    outerScopeVar = pos;
});
console.log(outerScopeVar);

¿Por qué aparece undefineden todos estos ejemplos? No quiero soluciones alternativas, quiero saber por qué sucede esto.


Nota: Esta es una pregunta canónica sobre la asincronicidad de JavaScript . No dude en mejorar esta pregunta y agregar ejemplos más simplificados con los que la comunidad pueda identificarse.

Maaz Ahmed avatar May 15 '14 06:05 Maaz Ahmed
Aceptado

Respuesta de una palabra: asincronicidad .

Prólogos

Este tema se ha repetido al menos un par de miles de veces aquí en Stack Overflow. Por lo tanto, primero que nada me gustaría señalar algunos recursos extremadamente útiles:

  • La respuesta de @Felix Kling a "¿Cómo devuelvo la respuesta de una llamada asincrónica?" . Vea su excelente respuesta que explica los flujos sincrónicos y asincrónicos, así como la sección "Reestructurar código".
    @Benjamin Gruenbaum también se ha esforzado mucho en explicar la asincronicidad en el mismo hilo.

  • La respuesta de @Matt Esch a "Obtener datos de fs.readFile" también explica muy bien la asincronicidad de una manera sencilla.


La respuesta a la pregunta que nos ocupa

Rastreemos primero el comportamiento común. En todos los ejemplos, se outerScopeVarmodifica dentro de una función . Es evidente que esa función no se ejecuta inmediatamente; se asigna o se pasa como argumento. Eso es lo que llamamos devolución de llamada .

Ahora la pregunta es, ¿cuándo se llama esa devolución de llamada?

Depende del caso. Intentemos rastrear algún comportamiento común nuevamente:

  • img.onloadpuede ser llamado en algún momento en el futuro cuando (y si) la imagen se haya cargado correctamente.
  • setTimeoutpuede ser llamado en algún momento en el futuro después de que el retraso haya expirado y el tiempo de espera no haya sido cancelado por clearTimeout. Nota: incluso cuando se usa 0como retraso, todos los navegadores tienen un límite mínimo de tiempo de espera (especificado en 4 ms en la especificación HTML5).
  • La devolución de llamada de jQuery $.postse puede llamar en algún momento en el futuro cuando (y si) la solicitud de Ajax se haya completado con éxito.
  • fs.readFileEs posible que se llame a Node.js en algún momento en el futuro cuando el archivo se haya leído correctamente o se haya producido un error.

En todos los casos, tenemos una devolución de llamada que puede ejecutarse en algún momento en el futuro . Este "en algún momento en el futuro" es lo que llamamos flujo asincrónico .

La ejecución asincrónica se elimina del flujo sincrónico. Es decir, el código asíncrono nunca se ejecutará mientras se esté ejecutando la pila de código síncrono. Este es el significado de que JavaScript sea de un solo subproceso.

Más específicamente, cuando el motor JS está inactivo, sin ejecutar una pila de código (a)sincrónico, sondeará eventos que puedan haber desencadenado devoluciones de llamadas asincrónicas (por ejemplo, tiempo de espera vencido, respuesta de red recibida) y los ejecutará uno tras otro. Esto se considera un bucle de eventos .

Es decir, el código asíncrono resaltado en las formas rojas dibujadas a mano puede ejecutarse solo después de que se haya ejecutado todo el código síncrono restante en sus respectivos bloques de código:

código asíncrono resaltado

En resumen, las funciones de devolución de llamada se crean de forma sincrónica pero se ejecutan de forma asincrónica. No puede confiar en la ejecución de una función asincrónica hasta que sepa que se ha ejecutado, y ¿cómo hacerlo?

Es sencillo, de verdad. La lógica que depende de la ejecución de la función asincrónica debe iniciarse/llamarse desde dentro de esta función asincrónica. Por ejemplo, mover alertsys console.logdentro de la función de devolución de llamada generaría el resultado esperado porque el resultado está disponible en ese punto.

Implementando su propia lógica de devolución de llamada

A menudo es necesario hacer más cosas con el resultado de una función asincrónica o hacer cosas diferentes con el resultado dependiendo de dónde se haya llamado la función asincrónica. Abordemos un ejemplo un poco más complejo:

var outerScopeVar;
helloCatAsync();
alert(outerScopeVar);

function helloCatAsync() {
    setTimeout(function() {
        outerScopeVar = 'Nya';
    }, Math.random() * 2000);
}

Nota: estoy usando setTimeoutun retraso aleatorio como función asincrónica genérica; El mismo ejemplo se aplica a Ajax, readFile, onloady cualquier otro flujo asincrónico.

Este ejemplo claramente sufre el mismo problema que los otros ejemplos; no espera hasta que se ejecute la función asincrónica.

Abordémoslo implementando nuestro propio sistema de devolución de llamadas. En primer lugar, nos deshacemos de ese feo outerScopeVarque es completamente inútil en este caso. Luego agregamos un parámetro que acepta un argumento de función, nuestra devolución de llamada. Cuando finaliza la operación asincrónica, llamamos a esta devolución de llamada y pasamos el resultado. La implementación (lea los comentarios en orden):

// 1. Call helloCatAsync passing a callback function,
//    which will be called receiving the result from the async operation
helloCatAsync(function(result) {
    // 5. Received the result from the async function,
    //    now do whatever you want with it:
    alert(result);
});

// 2. The "callback" parameter is a reference to the function which
//    was passed as an argument from the helloCatAsync call
function helloCatAsync(callback) {
    // 3. Start async operation:
    setTimeout(function() {
        // 4. Finished async operation,
        //    call the callback, passing the result as an argument
        callback('Nya');
    }, Math.random() * 2000);
}

Fragmento de código del ejemplo anterior:

// 1. Call helloCatAsync passing a callback function,
//    which will be called receiving the result from the async operation
console.log("1. function called...")
helloCatAsync(function(result) {
    // 5. Received the result from the async function,
    //    now do whatever you want with it:
    console.log("5. result is: ", result);
});

// 2. The "callback" parameter is a reference to the function which
//    was passed as an argument from the helloCatAsync call
function helloCatAsync(callback) {
    console.log("2. callback here is the function passed as argument above...")
    // 3. Start async operation:
    setTimeout(function() {
    console.log("3. start async operation...")
    console.log("4. finished async operation, calling the callback, passing the result...")
        // 4. Finished async operation,
        //    call the callback passing the result as argument
        callback('Nya');
    }, Math.random() * 2000);
}
Expandir fragmento

Muy a menudo, en casos de uso reales, la API DOM y la mayoría de las bibliotecas ya proporcionan la funcionalidad de devolución de llamada (la helloCatAsyncimplementación en este ejemplo demostrativo). Solo necesita pasar la función de devolución de llamada y comprender que se ejecutará fuera del flujo sincrónico y reestructurará su código para adaptarse a eso.

También notará que debido a la naturaleza asincrónica, es imposible devolver returnun valor de un flujo asincrónico al flujo sincrónico donde se definió la devolución de llamada, ya que las devoluciones de llamada asincrónicas se ejecutan mucho después de que el código sincrónico ya haya terminado de ejecutarse.

En lugar de returnenviar un valor desde una devolución de llamada asincrónica, tendrá que utilizar el patrón de devolución de llamada, o... Promesas.

Promesas

Aunque hay formas de mantener a raya el infierno de las devoluciones de llamadas con Vanilla JS, las promesas están ganando popularidad y actualmente se están estandarizando en ES6 (consulte Promise - MDN ).

Las promesas (también conocidas como Futuros) proporcionan una lectura más lineal y, por lo tanto, agradable del código asincrónico, pero explicar toda su funcionalidad está fuera del alcance de esta pregunta. En lugar de eso, dejaré estos excelentes recursos para los interesados:

  • Promesas de JavaScript: HTML5 es genial
  • Te estás perdiendo el punto de las promesas - domenic.me

Más material de lectura sobre la asincronicidad de JavaScript

  • The Art of Node - Callbacks explica muy bien el código asincrónico y las devoluciones de llamada con ejemplos básicos de JS y código Node.js.

Nota: He marcado esta respuesta como Wiki de la comunidad. ¡Por lo tanto, cualquier persona con al menos 100 reputaciones puede editarlo y mejorarlo! No dude en mejorar esta respuesta o enviar una respuesta completamente nueva si también lo desea.

Quiero convertir esta pregunta en un tema canónico para responder problemas de asincronicidad que no están relacionados con Ajax (hay ¿ Cómo devolver la respuesta de una llamada AJAX? para eso), por lo tanto, este tema necesita su ayuda para ser lo más bueno y útil posible. !

Fabrício Matté avatar May 14 '2014 23:05 Fabrício Matté

La respuesta de Fabricio es acertada; pero quería complementar su respuesta con algo menos técnico, que se centra en una analogía para ayudar a explicar el concepto de asincronicidad .


Una analogía...

Ayer, el trabajo que estaba haciendo requería información de un colega. Lo llamé; así fue como fue la conversación:

Yo : Hola Bob, necesito saber cómo nos comimos el bar la semana pasada. Jim quiere un informe al respecto y tú eres el único que conoce los detalles.

Bob : Claro, pero ¿me llevará unos 30 minutos?

Yo : Eso es genial Bob. ¡Llámame cuando tengas la información!

En ese momento colgué el teléfono. Como necesitaba información de Bob para completar mi informe, lo dejé y fui a tomar un café, luego me puse al día con un correo electrónico. 40 minutos después (Bob es lento), Bob volvió a llamar y me dio la información que necesitaba. En este punto, reanudé mi trabajo con mi informe, ya que tenía toda la información que necesitaba.


Imagínese si la conversación hubiera sido así;

Yo : Hola Bob, necesito saber cómo nos comimos el bar la semana pasada. Jim quiere un informe al respecto y tú eres el único que conoce los detalles.

Bob : Claro, pero ¿me llevará unos 30 minutos?

Yo : Eso es genial Bob. Esperaré.

Y me senté allí y esperé. Y esperó. Y esperó. Durante 40 minutos. Sin hacer nada más que esperar. Finalmente, Bob me dio la información, colgamos y completé mi informe. Pero había perdido 40 minutos de productividad.


Este es un comportamiento asincrónico versus sincrónico.

Esto es exactamente lo que está sucediendo en todos los ejemplos de nuestra pregunta. Cargar una imagen, cargar un archivo del disco y solicitar una página a través de AJAX son operaciones lentas (en el contexto de la informática moderna).

En lugar de esperar a que se completen estas operaciones lentas, JavaScript le permite registrar una función de devolución de llamada que se ejecutará cuando se complete la operación lenta. Mientras tanto, sin embargo, JavaScript seguirá ejecutando otro código. El hecho de que JavaScript ejecute otro código mientras espera que se complete la operación lenta hace que el comportamiento sea asíncrono . Si JavaScript hubiera esperado a que se completara la operación antes de ejecutar cualquier otro código, este habría sido un comportamiento sincrónico .

var outerScopeVar;    
var img = document.createElement('img');

// Here we register the callback function.
img.onload = function() {
    // Code within this function will be executed once the image has loaded.
    outerScopeVar = this.width;
};

// But, while the image is loading, JavaScript continues executing, and
// processes the following lines of JavaScript.
img.src = 'lolcat.png';
alert(outerScopeVar);

En el código anterior, le pedimos a JavaScript que se cargue lolcat.png, lo cual es una operación lenta . La función de devolución de llamada se ejecutará una vez que se complete esta lenta operación, pero mientras tanto, JavaScript seguirá procesando las siguientes líneas de código; es decir alert(outerScopeVar).

Es por eso que vemos que se muestra la alerta undefined; ya que alert()se procesa inmediatamente, en lugar de después de que se haya cargado la imagen.

Para arreglar nuestro código, todo lo que tenemos que hacer es mover el alert(outerScopeVar)código a la función de devolución de llamada. Como consecuencia de esto, ya no necesitamos que la outerScopeVarvariable sea declarada como variable global.

var img = document.createElement('img');

img.onload = function() {
    var localScopeVar = this.width;
    alert(localScopeVar);
};

img.src = 'lolcat.png';

Siempre verás que una devolución de llamada se especifica como una función, porque esa es la única* forma en JavaScript de definir algún código, pero no ejecutarlo hasta más tarde.

Por lo tanto, en todos nuestros ejemplos, function() { /* Do something */ }es la devolución de llamada; Para arreglar todos los ejemplos, todo lo que tenemos que hacer es mover el código que necesita la respuesta de la operación allí.

eval()* Técnicamente también puedes usarlo , pero eval()es malo para este propósito.


¿Cómo hago esperar a la persona que me llama?

Es posible que actualmente tengas algún código similar a este;

function getWidthOfImage(src) {
    var outerScopeVar;

    var img = document.createElement('img');
    img.onload = function() {
        outerScopeVar = this.width;
    };
    img.src = src;
    return outerScopeVar;
}

var width = getWidthOfImage('lolcat.png');
alert(width);

Sin embargo, ahora sabemos que esto return outerScopeVarsucede inmediatamente; antes de que la onloadfunción de devolución de llamada haya actualizado la variable. Esto lleva a getWidthOfImage()regresar undefinedy undefinedser alertado.

Para solucionar esto, debemos permitir que la función que llama getWidthOfImage()registre una devolución de llamada, luego mover la alerta del ancho para que esté dentro de esa devolución de llamada;

function getWidthOfImage(src, cb) {     
    var img = document.createElement('img');
    img.onload = function() {
        cb(this.width);
    };
    img.src = src;
}

getWidthOfImage('lolcat.png', function (width) {
    alert(width);
});

... como antes, tenga en cuenta que hemos podido eliminar las variables globales (en este caso width).

Matt avatar May 29 '2014 09:05 Matt

Aquí hay una respuesta más concisa para las personas que buscan una referencia rápida, así como algunos ejemplos que utilizan promesas y async/await.

Comience con el enfoque ingenuo (que no funciona) para una función que llama a un método asincrónico (en este caso setTimeout) y devuelve un mensaje:

function getMessage() {
  var outerScopeVar;
  setTimeout(function() {
    outerScopeVar = 'Hello asynchronous world!';
  }, 0);
  return outerScopeVar;
}
console.log(getMessage());

undefinedse registra en este caso porque getMessageregresa antes de que setTimeoutse llame a la devolución de llamada y se actualice outerScopeVar.

Las dos formas principales de solucionarlo son mediante devoluciones de llamada y promesas :

Devoluciones de llamada

El cambio aquí es que getMessageacepta un callbackparámetro que se llamará para devolver los resultados al código de llamada una vez que esté disponible.

function getMessage(callback) {
  setTimeout(function() {
    callback('Hello asynchronous world!');
  }, 0);
}
getMessage(function(message) {
  console.log(message);
});

Promesas

Las promesas proporcionan una alternativa que es más flexible que las devoluciones de llamada porque se pueden combinar de forma natural para coordinar múltiples operaciones asíncronas. Una implementación estándar de Promises/A+ se proporciona de forma nativa en node.js (0.12+) y muchos navegadores actuales, pero también se implementa en bibliotecas como Bluebird y Q.

function getMessage() {
  return new Promise(function(resolve, reject) {
    setTimeout(function() {
      resolve('Hello asynchronous world!');
    }, 0);
  });
}

getMessage().then(function(message) {
  console.log(message);  
});

jQuery diferido

jQuery proporciona una funcionalidad similar a las promesas con sus Diferidos.

function getMessage() {
  var deferred = $.Deferred();
  setTimeout(function() {
    deferred.resolve('Hello asynchronous world!');
  }, 0);
  return deferred.promise();
}

getMessage().done(function(message) {
  console.log(message);  
});

asíncrono/espera

Si su entorno JavaScript incluye soporte para asyncy await(como Node.js 7.6+), entonces puede usar promesas sincrónicamente dentro de asynclas funciones:

function getMessage () {
    return new Promise(function(resolve, reject) {
        setTimeout(function() {
            resolve('Hello asynchronous world!');
        }, 0);
    });
}

async function main() {
    let message = await getMessage();
    console.log(message);
}

main();
JohnnyHK avatar Jan 20 '2015 23:01 JohnnyHK

Para decir lo obvio, la copa representa outerScopeVar.

Las funciones asincrónicas serán como...

llamada asincrónica para tomar café

Johannes Fahrenkrug avatar Dec 08 '2015 16:12 Johannes Fahrenkrug