Promise 的含义

Promise 是异步编程的一种解决方案，比传统的解决方案——回调函数和事件——更合理和更强大。它由社区最早提出和实现，ES6 将其写进了语言标准，统一了用法，原生提供了Promise对象。

所谓Promise，简单说就是一个容器，里面保存着某个未来才会结束的事件（通常是一个异步操作）的结果。从语法上说，Promise 是一个对象，从它可以获取异步操作的消息。Promise 提供统一的 API，各种异步操作都可以用同样的方法进行处理。

Promise对象有以下两个特点。

（1）对象的状态不受外界影响。Promise对象代表一个异步操作，有三种状态：pending（进行中）、fulfilled（已成功）和rejected（已失败）。只有异步操作的结果，可以决定当前是哪一种状态，任何其他操作都无法改变这个状态。这也是Promise这个名字的由来，它的英语意思就是“承诺”，表示其他手段无法改变。

（2）一旦状态改变，就不会再变，任何时候都可以得到这个结果。Promise对象的状态改变，只有两种可能：从pending变为fulfilled和从pending变为rejected。只要这两种情况发生，状态就凝固了，不会再变了，会一直保持这个结果，这时就称为 resolved（已定型）。如果改变已经发生了，你再对Promise对象添加回调函数，也会立即得到这个结果。这与事件（Event）完全不同，事件的特点是，如果你错过了它，再去监听，是得不到结果的。

注意，为了行文方便，本章后面的resolved统一只指fulfilled状态，不包含rejected状态。

有了Promise对象，就可以将异步操作以同步操作的流程表达出来，避免了层层嵌套的回调函数。此外，Promise对象提供统一的接口，使得控制异步操作更加容易。

Promise也有一些缺点。首先，无法取消Promise，一旦新建它就会立即执行，无法中途取消。其次，如果不设置回调函数，Promise内部抛出的错误，不会反应到外部。第三，当处于pending状态时，无法得知目前进展到哪一个阶段（刚刚开始还是即将完成）。

如果某些事件不断地反复发生，一般来说，使用 Stream 模式是比部署Promise更好的选择。

基本用法

ES6 规定，Promise对象是一个构造函数，用来生成Promise实例。

下面代码创造了一个Promise实例。

const promise = new Promise(function(resolve, reject) {
  // ... some code

  if (/* 异步操作成功 */){
    resolve(value);
  } else {
    reject(error);
  }
});

Promise构造函数接受一个函数作为参数，该函数的两个参数分别是resolve和reject。它们是两个函数，由 JavaScript 引擎提供，不用自己部署。

resolve函数的作用是，将Promise对象的状态从“未完成”变为“成功”（即从 pending 变为 resolved），在异步操作成功时调用，并将异步操作的结果，作为参数传递出去；reject函数的作用是，将Promise对象的状态从“未完成”变为“失败”（即从 pending 变为 rejected），在异步操作失败时调用，并将异步操作报出的错误，作为参数传递出去。

Promise实例生成以后，可以用then方法分别指定resolved状态和rejected状态的回调函数。

promise.then(function(value) {
  // success
}, function(error) {
  // failure
});

then方法可以接受两个回调函数作为参数。第一个回调函数是Promise对象的状态变为resolved时调用，第二个回调函数是Promise对象的状态变为rejected时调用。这两个函数都是可选的，不一定要提供。它们都接受Promise对象传出的值作为参数。

下面是一个Promise对象的简单例子。

function timeout(ms) {
  return new Promise((resolve, reject) => {
    setTimeout(resolve, ms, 'done');
  });
}

timeout(100).then((value) => {
  console.log(value);
});

上面代码中，timeout方法返回一个Promise实例，表示一段时间以后才会发生的结果。过了指定的时间（ms参数）以后，Promise实例的状态变为resolved，就会触发then方法绑定的回调函数。

Promise 新建后就会立即执行。

let promise = new Promise(function(resolve, reject) {
  console.log('Promise');
  resolve();
});

promise.then(function() {
  console.log('resolved.');
});

console.log('Hi!');

// Promise
// Hi!
// resolved

上面代码中，Promise 新建后立即执行，所以首先输出的是Promise。然后，then方法指定的回调函数，将在当前脚本所有同步任务执行完才会执行，所以resolved最后输出。

下面是异步加载图片的例子。

function loadImageAsync(url) {
  return new Promise(function(resolve, reject) {
    const image = new Image();

    image.onload = function() {
      resolve(image);
    };

    image.onerror = function() {
      reject(new Error('Could not load image at ' + url));
    };

    image.src = url;
  });
}

上面代码中，使用Promise包装了一个图片加载的异步操作。如果加载成功，就调用resolve方法，否则就调用reject方法。

下面是一个用Promise对象实现的 Ajax 操作的例子。

const getJSON = function(url) {
  const promise = new Promise(function(resolve, reject){
    const handler = function() {
      if (this.readyState !== 4) {
        return;
      }
      if (this.status === 200) {
        resolve(this.response);
      } else {
        reject(new Error(this.statusText));
      }
    };
    const client = new XMLHttpRequest();
    client.open("GET", url);
    client.onreadystatechange = handler;
    client.responseType = "json";
    client.setRequestHeader("Accept", "application/json");
    client.send();

  });

  return promise;
};

getJSON("/posts.json").then(function(json) {
  console.log('Contents: ' + json);
}, function(error) {
  console.error('出错了', error);
});

上面代码中，getJSON是对 XMLHttpRequest 对象的封装，用于发出一个针对 JSON 数据的 HTTP 请求，并且返回一个Promise对象。需要注意的是，在getJSON内部，resolve函数和reject函数调用时，都带有参数。

如果调用resolve函数和reject函数时带有参数，那么它们的参数会被传递给回调函数。reject函数的参数通常是Error对象的实例，表示抛出的错误；resolve函数的参数除了正常的值以外，还可能是另一个 Promise 实例，比如像下面这样。

const p1 = new Promise(function (resolve, reject) {
  // ...
});

const p2 = new Promise(function (resolve, reject) {
  // ...
  resolve(p1);
})

上面代码中，p1和p2都是 Promise 的实例，但是p2的resolve方法将p1作为参数，即一个异步操作的结果是返回另一个异步操作。

注意，这时p1的状态就会传递给p2，也就是说，p1的状态决定了p2的状态。如果p1的状态是pending，那么p2的回调函数就会等待p1的状态改变；如果p1的状态已经是resolved或者rejected，那么p2的回调函数将会立刻执行。

const p1 = new Promise(function (resolve, reject) {
  setTimeout(() => reject(new Error('fail')), 3000)
})

const p2 = new Promise(function (resolve, reject) {
  setTimeout(() => resolve(p1), 1000)
})

p2
  .then(result => console.log(result))
  .catch(error => console.log(error))
// Error: fail

上面代码中，p1是一个 Promise，3 秒之后变为rejected。p2的状态在 1 秒之后改变，resolve方法返回的是p1。由于p2返回的是另一个 Promise，导致p2自己的状态无效了，由p1的状态决定p2的状态。所以，后面的then语句都变成针对后者（p1）。又过了 2 秒，p1变为rejected，导致触发catch方法指定的回调函数。

注意，调用resolve或reject并不会终结 Promise 的参数函数的执行。

new Promise((resolve, reject) => {
  resolve(1);
  console.log(2);
}).then(r => {
  console.log(r);
});
// 2
// 1

上面代码中，调用resolve(1)以后，后面的console.log(2)还是会执行，并且会首先打印出来。这是因为立即 resolved 的 Promise 是在本轮事件循环的末尾执行，总是晚于本轮循环的同步任务。

一般来说，调用resolve或reject以后，Promise 的使命就完成了，后继操作应该放到then方法里面，而不应该直接写在resolve或reject的后面。所以，最好在它们前面加上return语句，这样就不会有意外。

new Promise((resolve, reject) => {
  return resolve(1);
  // 后面的语句不会执行
  console.log(2);
})

实现Promise的基本用法

import 'dart:async';

class Promise {
  Future future;

  Promise(dynamic excutor(dynamic resolve(val), dynamic reject(val))) {
    if (!(excutor is Function)) {
      throw new AssertionError('Promise resolver $excutor is not a function');
    }
    final completer = Completer();
    try {
      excutor(completer.complete, completer.completeError);
    } catch (e) {
      completer.completeError(e);
    }
    this.future = completer.future;
  }

  /// Promise链式回调，对应Dart [.then]
  Future then(Future Function(dynamic) onValue, {Function onError}) {
    return this.future?.then(onValue, onError: onError);
  }

  /// Promise链式回调，对应Dart [.catchError]
  Future catch_(Function onError, {bool Function(Object) test}) {
    return this.future?.catchError(onError, test: test);
  }

  /// Promise链式回调，对应Dart [.whenComplete]
  Future finally_(Future<dynamic> Function() action) {
    return this.future?.whenComplete(action);
  }
}

使用示例

Promise promise = Promise((resolve,reject){
  // ... some code

  if (/* 异步操作成功 */){
    resolve(value);
  } else {
    reject(error);
  }
})

// 链式回调
promise
   .then((value) => null)
   .catch_((error) => null)
   .finally_((action) => null);

// 如果要使用dart的 async/await 需要先获取到 Promise 实例内的 Future
dynamic result = await promise.future;

Futrue中有对应实现的方法

Promise.all`, `Promise.race`, `Promise.resolve`, `Promise.reject
class Promise{
  /// 用于将多个 Future 实例，包装成一个新的 Future 实例。
  /// 等待[futures]完成并收集其结果。
  static Future all(Iterable<Future> futures) => Future.wait(futures);

  /// 对应Dart [Future.any]
  /// 返回[futures]中成功完成的第一个future的结果。
  /// 任意失败都会导致抛出异常
  static Future race(Iterable<Future> futures) => Future.any(futures);

  /// 对应Dart [Future.value]
  static Future resolve(dynamic value) => Future.value(value);

  /// 对应Dart [Future.error]
  static Future reject(dynamic value) => Future.error(value);
}

Futrue中有无对应实现的方法

Promise.allSettled方法接受一组 Promise 实例作为参数，包装成一个新的 Promise 实例。只有等到所有这些参数实例都返回结果，不管是fulfilled还是rejected，包装实例才会结束。该方法由 ES2020 引入

class Promise{
  static final String FULFILLED = 'fulfilled';
  static final String REJECTED = 'rejected';

  /// 用于将多个 Future 实例，包装成一个新的 Future 实例。
  /// 不论成功失败，都返回结果
  static Future allSettled(Iterable<Future> futures) {
    List<dynamic> result = List.generate(futures.length, (index) => null);
    final completer = Completer();

    for (int i = 0; i < futures.length; i++) {
      futures.elementAt(i).then((value) {
        result[i] = {'status': FULFILLED, 'value': value};
      }).catchError((error) {
        result[i] = {'status': REJECTED, 'reason': error};
      }).whenComplete(() {
        if (result.every((element) => element != null)) {
          return completer.complete(result);
        }
      });
    }

    return completer.future;
  }
}

Promise.any()方法接受一组 Promise 实例作为参数，包装成一个新的 Promise 实例。只要参数实例有一个变成fulfilled状态，包装实例就会变成fulfilled状态；如果所有参数实例都变成rejected状态，包装实例就会变成rejected状态。该方法目前是一个第三阶段的提案 。

Promise.any()跟Promise.race()方法很像，只有一点不同，就是不会因为某个 Promise 变成rejected状态而结束。

class Promise{
  /// 返回[futures]中成功完成的第一个future的结果;
  /// 全部失败才会抛出异常
  /// ```
  /// @param futures {Iterable<Future>} Future 实例组
  /// @param onlyError {bool} 是否只抛出最后一个异常结果，否则抛出一个异常 List ，默认 false
  /// ```
  static Future any(Iterable<Future> futures, {bool onlyError = false}) async {
    List<dynamic> errors = [];
    final completer = Completer();

    for (int i = 0; i < futures.length; i++) {
      futures.elementAt(i).then((value) {
        completer.complete(value);
      }).catchError((error) {
        errors[i] = error;
        if (futures.length == errors.length) {
          completer.completeError(onlyError ? error : errors);
        }
      });
    }

    return completer.future;
  }
}

顺便把延迟函数也封装一下，毕竟毫秒延迟的使用频率是最高的。

class Promise{
  static Future sleep(int ms) => Future.delayed(Duration(milliseconds: ms));
}

以上就是flutter中的利用Future封装出js中的Promise方法；更多flutter学习可以参考《混合实战Flutter3.0手册》里面内容从最基础的dart语法开始学起，到实战演练！需要可以点击获取方式。

结语

前端的同学对Promise肯定都很熟悉，而Future便是dart中Promise，但方法名称和使用方式还是有些许的差异的。

Flutter可以方便的加入现有的工程中。在全世界，Flutter 正在被越来越多的开发者和组织使用，并且 Flutter是完全免费、开源的。它也是构建未来的 Google Fuchsia 应用的主要方式。

Flutter是Google开源的构建用户界面（UI）工具包，帮助开发者通过一套代码库高效构建多平台精美应用，支持移动、Web、桌面和嵌入式平台。 [5] Flutter 开源、免费，拥有宽松的开源协议，适合商业项目。Flutter已推出稳定的2.0版本。