如何从异步调用返回响应

问题描述

问题

在中的Ajax代表。这意味着发送请求(或者更确切地说是接收响应)已经脱离了正常的执行流程。在您的示例中,$.AJAX立即返回,并且在return result;您作为success回调传递的函数甚至被调用之前执行下一条语句。

这是一个类比,希望可以更清楚地区分同步流和异步流之间的区别

同步

想象一下,你给朋友打电话,让他帮你查点东西。虽然这可能需要一段时间,但您会等待电话并凝视太空,直到您的朋友给您所需的答案。

当您进行包含“正常”代码函数调用时,也会发生同样的情况:

function findItem() {
    var item;
    while(item_not_found) {
        // search
    }
    return item;
}

var item = findItem();

// Do something with item
doSomethingElse();

尽管findItem可能需要很长时间才能执行,但之后的任何代码var item = findItem();都必须等到函数返回结果。

异步

出于同样的原因,您再次致电您的朋友。但这一次你告诉他你有急事,他应该用你的手机给你回电。你挂断电话,离开家,做你计划做的任何事情。一旦你的朋友给你回电,你就在处理他给你的信息。

这正是您执行 AJAX 请求时发生的情况。

findItem(function(item) {
    // Do something with the item
});
doSomethingElse();

不是等待响应,而是立即继续执行并执行 AJAX 调用之后的语句。为了得到响应,最终,你提供了一次收到答复要调用函数一个回调(注意些什么呢?回电?)。在调用回调之前执行该调用之后的任何语句。

解决方

虽然某些异步操作提供同步对应物(“AJAX”也是如此),但通常不鼓励使用它们,尤其是在浏览器上下文中。

你问为什么不好?

JavaScript浏览器的 UI 线程中运行,任何长时间运行的进程都会锁定 UI,使其无响应。另外,JavaScript 的执行时间有上限,浏览器会询问用户是否继续执行。

所有这些都会导致非常糟糕的用户体验。用户将无法判断是否一切正常。此外,对于连接速度较慢的用户效果会更差。

在下文中,我们将研究三种不同的解决方案,它们都建立在彼此之上:

ES2017+:承诺 `async/await

2017 年发布的 ECMAScript 版本引入了对异步函数语法级支持。的帮助下asyncawait,你可以写在“同步式”异步的。代码仍然是异步的,但更容易阅读/理解。

async/await建立在承诺之上:一个async函数总是返回一个承诺。await“解开”一个promise 并且要么导致promise 被解决的值,要么在promise 被拒绝时抛出一个错误

您只能awaitasync函数内部使用。目前,await不支持顶级,因此您可能需要创建一个异步 IIFE(立即调用函数表达式)来启动async上下文。

你可以阅读更多关于asyncawait的MDN。

这是一个详细说明上述延迟功能的示例findItem()

// Using 'superagent' which will return a promise.
var superagent = require('superagent')

// This is isn't declared as `async` because it already returns a promise
function delay() {
  // `delay` returns a promise
  return new Promise(function(resolve, reject) {
    // Only `delay` is able to resolve or reject the promise
    setTimeout(function() {
      resolve(42); // After 3 seconds, resolve the promise with value 42
    }, 3000);
  });
}

async function getAllBooks() {
  try {
    // GET a List of book IDs of the current user
    var bookIDs = await superagent.get('/user/books');
    // wait for 3 seconds (just for the sake of this example)
    await delay();
    // GET information about each book
    return await superagent.get('/books/IDs='+JsON.stringify(bookIDs));
  } catch(error) {
    // If any of the awaited promises was rejected, this catch block
    // would catch the rejection reason
    return null;
  }
}

// Start an IIFE to use `await` at the top level
(async function(){
  let books = await getAllBooks();
  console.log(books);
})();

当前浏览器节点版本支持async/await. 您还可以通过在regenerator(或使用 regenerator 的工具,例如Babel)的帮助下将代码转换为 ES5 来支持环境

函数接受回调

回调是指将函数 1 传递给函数 2 时。函数 2 可以在准备好时调用函数 1。在异步进程的上下文中,只要异步进程完成,就会调用回调。通常,结果传递给回调。

问题的示例中,您可以foo接受回调并将其用作success回调。所以这

var result = foo();
// Code that depends on 'result'

变成

foo(function(result) {
    // Code that depends on 'result'
});

这里我们定义了“内联”函数,但您可以传递任何函数引用:

function myCallback(result) {
    // Code that depends on 'result'
}

foo(myCallback);

foo 本身定义如下:

function foo(callback) {
    $.AJAX({
        // ...
        success: callback
    });
}

callback将引用foo我们调用时传递给的函数并将其传递给success. 即一旦 AJAX 请求成功,$.AJAX调用callback并将响应传递给回调(可以用 引用result,因为这是我们定义回调的方式)。

您还可以在将响应传递给回调之前对其进行处理:

function foo(callback) {
    $.AJAX({
        // ...
        success: function(response) {
            // For example, filter the response
            callback(filtered_response);
        }
    });
}

使用回调编写代码比看起来更容易。毕竟,浏览器中的 JavaScript 是高度事件驱动的(DOM 事件)。接收 AJAX 响应只不过是一个事件。当您必须使用第三方代码时,可能会出现困难,但大多数问题都可以通过考虑应用程序流程来解决

ES2015+:使用then() 进行

承诺API是ECMAScript的6(ES2015)的新功能,但它有很好的浏览器支持了。还有许多库实现了标准的 Promises API,并提供了额外的方法来简化异步函数使用组合(例如,bluebird)。

承诺是未来价值的容器。当 promise 收到值(已解决)或被取消(拒绝)时,它会通知所有想要访问此值的“侦听器”。

与普通回调相比的优势在于它们允许您解耦您的代码并且它们更容易组合

下面是一个使用 promise 的例子:

function delay() {
  // `delay` returns a promise
  return new Promise(function(resolve, reject) {
    // Only `delay` is able to resolve or reject the promise
    setTimeout(function() {
      resolve(42); // After 3 seconds, resolve the promise with value 42
    }, 3000);
  });
}

delay()
  .then(function(v) { // `delay` returns a promise
    console.log(v); // Log the value once it is resolved
  })
  .catch(function(v) {
    // Or do something else if it is rejected
    // (it would not happen in this example, since `reject` is not called).
  });
.as-console-wrapper { max-height: 100% !important; top: 0; }

运行代码片段

展开片段

应用于我们AJAX 调用我们可以使用这样的承诺:

function AJAX(url) {
  return new Promise(function(resolve, reject) {
    var xhr = new XMLhttpRequest();
    xhr.onload = function() {
      resolve(this.responseText);
    };
    xhr.onerror = reject;
    xhr.open('GET', url);
    xhr.send();
  });
}

AJAX("https://Jsonplaceholder.typicode.com/todos/1")
  .then(function(result) {
    console.log(result); // Code depending on result
  })
  .catch(function() {
    // An error occurred
  });
.as-console-wrapper { max-height: 100% !important; top: 0; }

运行代码片段

展开片段

描述 promise 提供的所有优势超出了本答案的范围,但是如果您编写新代码,则应该认真考虑它们。它们为您的代码提供了很好的抽象和分离

旁注:jquery 的延迟对象

延迟对象是 jquery自定义承诺实现(在 Promise API 标准化之前)。它们的行为几乎与 Promise 类似,但公开的 API 略有不同。

jquery 的每个 AJAX 方法都已经返回一个“延迟对象”(实际上是一个延迟对象的承诺),您可以从您的函数中返回它:

function AJAX() {
    return $.AJAX(...);
}

AJAX().done(function(result) {
    // Code depending on result
}).fail(function() {
    // An error occurred
});

旁注:承诺陷阱

请记住,promise 和 deferred 对象只是未来值的容器,它们不是值本身。例如,假设您有以下内容

function checkPassword() {
    return $.AJAX({
        url: '/password',
        data: {
            username: $('#username').val(),
            password: $('#password').val()
        },
        type: 'POST',
        dataType: 'Json'
    });
}

if (checkPassword()) {
    // Tell the user they're logged in
}

这段代码误解了上述异步问题。具体来说,$.AJAX()在检查服务器上的“/password”页面时不会冻结代码 - 它向服务器发送请求,并在等待时立即返回一个 jquery AJAX Deferred 对象,而不是来自服务器的响应。这意味着该if语句将始终获取此 Deferred 对象,将其视为true,并像用户登录一样继续。不好。

但修复很简单:

checkPassword()
.done(function(r) {
    if (r) {
        // Tell the user they're logged in
    } else {
        // Tell the user their password was bad
    }
})
.fail(function(x) {
    // Tell the user something bad happened
});

不推荐:同步AJAX调用

正如我所提到的,一些(!)异步操作具有同步对应物。我不提倡使用它们,但为了完整起见,以下是执行同步调用的方式:

没有 jquery

如果您直接使用XMLHttpRequest对象,请将其false作为第三个参数传递给.open.

jquery

如果您使用jQuery,则可以将该async选项设置false. 请注意,此选项自 jquery 1.8 起已弃用然后,您仍然可以使用success回调或访问jqXHR 对象responseText属性

function foo() {
    var jqXHR = $.AJAX({
        //...
        async: false
    });
    return jqXHR.responseText;
}

如果使用任何其他的jqueryAJAX方法,例如$.get$.getJsON等等,必须将其改为$.AJAX(因为你只能传递配置参数$.AJAX)。

无法进行同步JsONP请求。JsONP 就其本质而言始终是异步的(甚至不考虑此选项的另一个原因)。

解决方法

我有一个foo发出异步请求的函数。如何从 返回响应/结果foo

我试图从回调中返回值,并将结果分配给函数内部的一个局部变量并返回那个,但是这些方法都没有真正返回响应(它们都返回undefined或变量的初始值result是)。

接受回调的异步函数示例(使用 jQuery 的ajax函数)

function foo() {
    var result;

    $.ajax({
        url: '...',success: function(response) {
            result = response;
            // return response; // <- I tried that one as well
        }
    });

    return result; // It always returns `undefined`
}

使用 Node.js 的示例:

function foo() {
    var result;

    fs.readFile("path/to/file",function(err,data) {
        result = data;
        // return data; // <- I tried that one as well
    });

    return result; // It always returns `undefined`
}

使用then承诺块的示例:

function foo() {
    var result;

    fetch(url).then(function(response) {
        result = response;
        // return response; // <- I tried that one as well
    });

    return result; // It always returns `undefined`
}

支付解锁全部内容

限时5折
¥9.9 ¥19.9

编程问答相关问答

前言:我知道与此主题相关的类似问题,并且尝试了无...
每当我运行基本的deploy命令时,一切都将重新部署到...
在将变量复制到文件时遇到问题。 我运行多个命令和s...