Promise的作用在于
- 给异步算法的编写者和使用者之间提供一种统一的交流手段
- 给异步算法的使用者提供一种组织代码的手段,以便于将一层又一层嵌套的业务主流程变成一次一次的对then的调用
我们来一起看一下两个程序员之间的故事。
以下示例代码是用Scala写的,不过本文所讲的话题并不仅限于Scala,任何有Future/Promise支持的语言都是适用的。
下面这个wiki页面罗列了各个有Future/Promise支持的语言,已经涵盖了大多数的常用语言。
https://zh.wikipedia.org/wiki/Future与promise#实现列表
我是异步函数的编写者
我写了两个异步函数,来提供给其他程序员同事使用。
代码语言:javascript复制type CallBack = Try[String] => Unit
def pretendCallAPI(callBack: CallBack, okMsg: String, failedMsg: String) = {
val task = new TimerTask {
override def run() = {
val percentage = Random.between(1, 100)
if (percentage >= 50)
callBack(Success(okMsg))
else if (percentage <= 30)
callBack(Failure(new Exception(failedMsg)))
else
callBack(Failure(new Exception("network problem")))
}
}
new Timer().schedule(task, Random.between(200, 500))
}
val searchTB = pretendCallAPI(_, "product price found", "product not listed")
val buyFromTB = pretendCallAPI(_, "product bought", "can not buy, no money left")
这两个异步函数:searchTB
用来从淘宝搜索物品,另一个buyFromTB
用来购买搜到的物品。
由于仅仅是为了演示而写的,他们两个都是基于一个叫做pretendCallAPI
的函数实现的。
顾名思义,pretendCallAPI
并不会真的去调用淘宝的API,而只是模拟API的行为。
这个pretendCallAPI
函数有几个行为特征:
- 每次耗时200到500毫秒之间
- 每次执行有50%的几率成功
- 20%的几率遇到网络故障
- 另外30%的几率虽然网络没问题但是服务器会给你一个非正常的结果
当然,由于我写的是异步算法,需要避免block caller thread。
所以当你调用pretendCallAPI
的时候,这个函数是瞬间立即返回的。
那么当然我就无法在函数返回的时候return什么有用的东西给你了。
如果你想知道执行的结果到底是啥,你需要传给我一个CallBack,
在我执行完后,通过CallBack
来告知你执行的结果。
这个CallBack
的完整签名表达式展开是Try[String] => Unit
大家看searchTB
和buyFromTB
可能觉得他们长的有点奇怪,这是Scala里柯里化的写法。
也就是通过把pretendCallAPI
包一层来构造新的函数,锁死两个参数,剩下的一个参数(也就是CallBack
)就变成了新构造出来的函数的唯一参数了。
也就是说searchTB
和 buyFromTB
的签名是:(Try[String] => Unit) => Unit
。
关于柯里化这个语言特性的更多信息:
https://cuipengfei.me/blog/2013/12/25/desugar-scala-6/
好了,现在这两个函数可以提供给大家使用了。
我是异步函数的调用者
听说异步函数已经写好了,我终于可以用他们来实现剁手业务了。
听函数作者讲了一下,用起来应该不会很难,那我来实现一下吧。
代码语言:javascript复制def searchPriceThenBuy() = {
searchTB {
case Success(searchMsg) =>
println(searchMsg)
buyFromTB {
case Success(buyMsg) => println(buyMsg)
case Failure(err) => println(err.getMessage)
}
case Failure(err) => println(err.getMessage)
}
}
使用searchTB
和buyFromTB
并不难,他们两个都是接受CallBack
作为参数的函数。
CallBack
本身是个函数,它的签名是是Try[String] => Unit
。
而Try
有两种形式,分别是Success
和Failure
。
所以在调用searchTB
和buyFromTB
的时候,必须把两个分支都给到(以免pattern match不到)。
这样在异步函数有结果的时候(无论成败)才能call back过来到我的代码,以便我能够在合适的时机做后续的处理(无论是基于成功做后续业务,还是做error handling)。
关于pattern match,可以参考这里:
https://cuipengfei.me/blog/2013/12/29/desugar-scala-8/
https://cuipengfei.me/blog/2015/06/16/visitor-pattern-pattern-match/
这段代码跑一下的话,会有这么几种结果:
- 搜到了,也买到了
- 搜到了,购买时遇到了网络故障
- 搜到了,由于支付宝钱不够而没买到
- 没搜到,购买行为未触发
- 搜索遇到网络故障,购买行为未触发
一共就这么几种可能,因为pretendCallAPI
是跑概率的,多跑几次这些情况都能遇到。
虽然实现出来不难,执行结果也没问题,但是总有点隐忧。
这里只有searchTB
和buyFromTB
两个函数,如果其他场景下我需要把更多的异步函数组合起来使用呢?岂不是要缩进很多层?
当然,缩进只是个视觉审美问题,是个表象,不是特别要紧。关键是我的业务逻辑很容易被这样的代码给割裂的鸡零狗碎,那就不好了。
我要给上游编写异步函数的同事反馈一下,看是否有办法解决这个问题。
镜头切回到异步函数编写者
之前写的两个函数反馈不太好,主要是因为同事们认为使用CallBack
不是最优的方式。
这个反馈确实很中肯,如果只有一个异步函数单独使用,用CallBack
也没什么太大的问题,如果是很多个异步函数组合使用确实会形成多层嵌套的问题。
我作为上游程序员,确实需要更多地为下游调用者考虑。
既然如此,那我改版一下,免除掉让下游使用CallBack
的必要性。
type CallBackBasedFunction = (CallBack) => Unit
def futurize(f: CallBackBasedFunction) = () => {
val promise = Promise[String]()
f {
case Success(msg) => promise.success(msg)
case Failure(err) => promise.failure(err)
}
promise.future
}
val searchTBFutureVersion = futurize(searchTB)
val buyFromTBFutureVersion = futurize(buyFromTB)
先定义一个CallBackBasedFunction
,它代表一个接受CallBack
为参数的函数的签名。
表达式展开后就是:是(Try[String] => Unit) => Unit
这就符合了searchTB
和buyFromTB
两个函数的签名。
futurize
算是个higher order function,它接受一个CallBackBasedFunction
作为参数,返回一个() => Future[String]
。
( Future
是Scala标准库的内容,可以认为和JS Promises/A 是类似的概念)
也就是说futurize
可以把searchTB
和buyFromTB
改造成返回Future
的函数。上面代码最后两行就是改造的结果。
这样,原本接受CallBack
做为参数且没有返回值的函数,就变成了不接受参数且返回Future
的函数。
再看futurize
的具体实现,它使用了Scala的Promise
,让返回的Future
在原版函数成功时成功,在原版函数失败时失败。
这样,我就得到了searchTBFutureVersion
和buyFromTBFutureVersion
这两个仍然是立即瞬间返回,不会block caller thread的函数。
关于Scala中Promise和Future的更多信息:
https://docs.scala-lang.org/overviews/core/futures.html
镜头再切到异步函数调用者
现在有了searchTBFutureVersion
和buyFromTBFutureVersion
,我来试着重新实现一次:
def searchPriceThenBuyFutureVersion() = {
val eventualResult = for {
searchResult <- searchTBFutureVersion().map(msg => println(msg))
buyResult <- buyFromTBFutureVersion().map(msg => println(msg))
} yield (searchResult, buyResult)
eventualResult.onComplete {
case Failure(err) => println(err.getMessage)
case _ =>
}
}
这里用到了Scala的for comprehension,编译后会变成map,flatMap等等monadic operator。
而map,flatMap等操作符正是Scala中Future拿来做组合用的。
这样,用for把两个返回Future的异步函数组织起来,形成一个新的Future,然后在新的Future complete时统一处理异常。
关于for的更多信息:
https://cuipengfei.me/blog/2014/08/30/options-for/
这次实现的代码与上次的行为是一致的,没什么两样。
不过我的业务代码从鸡零狗碎变成了平铺直叙平易近人。
(这种效果在这里表现的并不是特别突出,不过很容易想象如果需要组合使用的异步函数更多一些的话,这种效果的好处就显露出来了)
当然了,让业务代码易读易懂主要还是要靠个人奋斗,而有了Promise和Future这种历史进程的推力,则更有增益作用。
小结
1. 给异步算法的编写者和使用者之间提供一种统一的交流手段
所谓统一的交流手段,其实就是异步函数的签名问题。
由于需要处理的业务五花八门,异步函数接受的参数列表没法统一,但是返回值是可以统一的。
一个异步函数,接受了外界给的参数,立即瞬间返回一个Js的Promise或者Scala的Future(或者是任何语言中类似概念的叫法)。
然后在异步任务执行完的时候把Promise resolve/reject掉(让Future success或者failure),借此来让调用方的代码知道该到了它跑后续处理的时候了。
这样我们就获得了一个sensible default,无需在每次设计异步函数的时候都去商议该返回什么东西,该怎么获得异步执行的结果。
2. 给异步算法的使用者提供一种组织代码的手段,以便于将一层又一层嵌套的业务主流程变成一次一次的对then的调用
所谓组织代码的手段,就是关于异步函数调用者的那两个镜头的内容了。
一开始CallBack
套着CallBack
,异步的味道很重,这体现出了代码的组织方式在向代码的技术实现低头。或者说是代码的技术实现干扰了我行文的风格。
后来变成了看起来很像是消费同步函数结果的写法,从而让我惯常的文风得以保持。