Promise

“Promises” (有时也称之为deferred)代表着在javascript程序里一种巧妙的编程范式,它代表了一种可能会长时间运行而且不一定必须完整的操作的结果。这种模式不会阻塞和等待长时间的操作完成,而是返回一个代表了承诺的(promised)结果的对象。因此它的核心就是一个promise,代表一个任务结果,这个任务有可能完成有可能没完成。Promise模式唯一需要的一个接口是调用then方法,它可以用来注册当promise完成或者失败时调用的回调函数阅读,详情请CommonJS Promises/A proposal

Promise 作了什么事情

Promise 适用于有异步逻辑的场景

代码第一形态

实现一个单体,可以传入回调参数,在某个事件发生时触发这个回调,通常我们这样做:

var A = {
    a:1,
    b:2,
    complete:function(){
        // 某个时机触发这个回调
    },
    error:function(){
        // 运行出错时的回调
    }
};

A.init();

这很容易理解,但这段代码忽略了两个信息

  1. complete 回调有可能不是在初始化的时候绑定,我们允许在任意位置指定他的回调
  2. 如果指定多个回调时,这些回调之间的先后顺序如何控制

代码第二形态

这个单体暴露事件,由开发者去绑定事件,事件可以任意绑定

// 让 A 可暴露自定义事件
var AFactory = new Function;
augment(AFactory,CustomEvent);
var A = new AFactory();

// 给 A 绑定自定义事件回调
A.on('complete',function(){
    // 某个时机触发这个回调
});

A.on('error',function(){
    // 运行出错时的回调
});

A.run();

这也很容易理解,这是编程模式中最常见的桥接模式,用来完成核心代码和功能代码之间的耦合和桥接。核心代码和功能代码之间就可以分别来维护了。但当 A 的功能很具体而且很内聚时,可以将这种模式简化为回调:

A.complete(function(){
    // 某个时机触发这个回调
}).error(function(){
    // 运行出错时的回调
});

A.run();

这是一种最常见的简写

代码第三形态

异步操作过程可能耗时很久,但通过写状态可以处理外接逻辑的触发时机先后顺序。这样,回调逻辑从“当xx时触发yy回调”,变为“当xx状态改变为yy时,触发zz回调”。即回调在等待状态改变,这种很语义话的表达方式被抽象出来,即形成了Promise的雏形:

A.run().then(function(){
    // 回调1    
}).then(function(){
    // 回调2    
});

独立出Promise对象:

var A = {};/* A 的定义 */
var p1 = new Promise(A);
p1.when(/*条件*/).then(/*行为*/);

KISSY Promise 的用法

可以直接通过KISSY.Promise调用:

var d = new KISSY.Promise.Defer();
d.do_something();// d 执行相关的方法

也可以通过沙箱来调用

KISSY.use('promise',function(S,Promise){
    var d = new Promise.Defer(); // 使用 Promise
});

首先看这个Demo

APIs

注意,Promise()不允许在外部被初始化。通过实例化KISSY.Promise.Defer()来使用Promise的功能。Promise 实例方法有:

then() <Promise 实例方法>

then ( fulfilled [, rejected] ) => void

监听当前实例的成功和失败并返回新的 promise 实例

parameter

return

一个新的 promise(Promise类型). 当前 promise 成功时新的 promise 也成功. 当前 promise 失败时新的 promise 也失败.

example

参照首Demo。 这里为链式调用写法。

KISSY.use('node',function(S,Node){
    K.all("button").on("click", function () {
        // 生成一个Promise实例d
        var d = new S.Promise.Defer();
        var promise = d.promise;
        promise.then(function (v) {
            return v + 1;
        }).then(function (v) {
            alert(v); // => 2
        });
        d.resolve(1); // 该位置也可以放在 then 前面
    });
});

fail() <Promise 实例方法>

fail ( rejected ) => void

监听当前实例的失败并返回新的 promise 实例.相当于调用 this.then(null,rejected);

parameter

rejected (Function) – 该 promise 失败时的回调,参数为 defer reject 时的 reason.

return

一个新的 promise((Promise类型). 当前 promise 成功时新的 promise 也成功. 当前 promise 失败时新的 promise 也失败.

fin() <Promise 实例方法>

fin ( callback ) => void

监听当前实例的成功和失败并返回新的 promise 实例

parameter

callback (Function) – 该 promise 成功或失败时的回调, 成功时参数为 defer resolve 时的 value 和 true. 失败时参数为 defer reject 时的 reason 和 false.

return

一个新的 promise. 当前 promise 成功时新的 promise 也成功. 当前 promise 失败时新的 promise 也失败.

isResolved() <Promise 实例方法>

isResolved () => Boolean

返回当前 promise 是否成功了

isResolved() <static>

isResolved () => Boolean

全局静态方法,作用同上

KISSY.Promise.isResolved(promise)

isRejected() <Promise 实例方法>

isRejected () => Boolean

返回当前 promise 是否失败了

isRejected() <static>

isRejected () => Boolean

全局静态方法,作用同上

KISSY.Promise.isRejected(promise)

isPromise() <static>

isPromise() => Boolean

全局静态方法,判断一个对象是否是Promise实例

KISSY.Promise.isPromise(promise)

when() <static>

when(obj, fulfilled, rejected) => Promise

返回一个新的 promise。如果 obj 为 promise 类型,相当于 obj.then(fulfilled, rejected)

否则直接调用 fulfilled(obj),并返回一个成功的 promise

parameter

obj – 监听的对象.

all() <static>

all(objects) => Promise

返回一个新的 promise.当 objects 全部成功后新的 promise 成功,否以第一个 promise 的失败值为失败

parameter

objects – promise或普通对象数组