stepify:轻松整合Node.js异步工作流

Node.js中基本都是异步编程,我们回想下为什么初学者很容易写出深度嵌套callback的代码?因为直观啊,一眼即懂。当然实际写的时候肯定不推荐callback套callback,需要一个工具来把一个任务完整的串起来。

我们知道,在项目管理里面有一个很出名的理论,叫番茄工作法(不知道的自行google),它所做的事情是把未来一段时间要做的事情都按照时间段拆分成一个个很小的任务,然后逐个完成。

stepify设计思路和番茄工作法有些类似,都是先定义好了任务最后再执行,不同的是前者以单个异步操作作粒度划分,后者只是以时间划分。

想想现实中我们怎么去做事的:比如做饭这件不大不小的事儿,因为只有一个煤气灶,所以炒菜只能炒完一个炒下一个菜,但是同时我们有个电饭煲,所以可以在炒菜的同时煮饭。这样子下来,做一顿饭的总时间就是max(煮饭的时间, 烧菜的时间)。而在炒菜的过程中,没有规定一定要先西红柿炒蛋完了之后再蛋炒番茄。这个做饭的过程,可以类比成上文所说的工作流,煮饭和烧菜是两个并行的task,每烧一个菜算是完成一个step。

stepify中的每一个异步任务执行的时机是前一个异步操作执行完而且没遇到异常,如果遇到异常,则把异常交给事先定义好的异常处理函数,在异常处理函数里可以决定是否继续执行下一个任务(比如烧菜时发现没了酱油,你可以决定是否还继续炒这道菜还是换下一道)。

抽象了?直接看代码文档吧,代码托管在 github 。

stepify目前已经发布到 npm ,可以使用npm直接安装:

$ npm install stepify
用法:

假设有一个工作(work )需要完成,它分解为 task1  task2  task3 。。。几个任务,每个任务分为好几个步骤( step ),使用 stepify 实现的伪代码如下:

var workflow = Stepify()
.task('t1')
  .step('t1s1', fn)
  // t1s1的执行结果可以通过fn内部的`this.done`方法传给t1s2,下同
  .step('t1s2', fn)
  .step('s', fn)
.task('t2')
  .step('t2s1', fn)
  .step('t2s2', fn)
  .step('s', fn)
  // 定义任务t2的异常处理函数
  .error(fn)
.task('t3')
  .step('t3s1', fn)
  .step('t3s2', fn)
// pend是指结束一个task的定义,接下来定义下一个task或者一些公共方法
// task里边其实会先调用下pend以自动结束上一个task的定义
.pend()
 // 处理work中每一个task的每一个(异步)step异常
.error(fn)
// 处理最终结果,result()是可选的(不需要关注输出的情况)
.result(fn)
.run()

这里可以看到,工作原理很简单,就是**先定义好后执行**。

解释下,pend的作用是分割task的定义,表示这个task要具体怎么做已经定义好了。里边还有两个`error()`的调用,跟在t2后面error调用的表明t2的异常由传入这个error的函数来处理,t1和t3没有显示定义error,所以它们的异常将交给后面一个error定义的函数来处理,这个是不是很像js的时间冒泡?

默认情况下,work的执行是按照task定义的顺序来串行执行的,所以还可以这样简化:

var workflow = Stepify()
    .step('t1s1', fn)
    .step('t1s2', fn)
    .step('s', fn)
    .pend()
    .step('t2s1', fn)
    .step('t2s2', fn)
    .step('s', fn)
    .error(fn)
    .pend()
    .step('t3s1', fn)
    .step('t3s2', fn)
    .pend()
    .error(fn)
    .result(fn)
    .run()

细心的童靴可能已经发现,t1和t2后面的都有一个step——`step(‘s’, fn)`,这里其实还可以把它抽出来:

var workflow = Stepify()
    .step('t1s1', fn)
    .step('t1s2', fn)
    .step('s')
    .pend()
    .step('t2s1', fn)
    .step('t2s2', fn)
    .step('s')
    .error(fn)
    .pend()
    .step('t3s1', fn)
    .step('t3s2', fn)
    .pend()
    .s(fn)
    .error(fn)
    .result(fn)
    .run()

是不是很神奇?s并不是stepify内置的方法而是动态扩展出来的!

那接下来又有个问题,t1和t2都有执行两个`step(‘s’)`,那额外的参数怎么传递呢?奥妙之处在于step函数,它后面还可以跟其他参数,表示在我们定义所有task之前就已经知道的变量(我叫它⎡静态参数⎦),还有任务执行过程中,如果上一个step的输出怎么传递给下一个step呢?答案是 next 或者 done ,具体可以参考api,`s(fn)`只是定义一个函数体,通过静态参数和动态参数结合,可以实现不同的操作。

这还没完,我们都听过一句话,叫做“条条大路通罗马(All roads lead to Rome)”,解决问题的方式往往有多种。上面这个例子,假如外部条件变了,task1和task2它们的执行互不影响,task3的执行需要依赖task1和task2的结果,即task1和task2可以并行,这样子怎么实现呢?

很简单,奥妙在run方法:

run(['t1', 't2'], 't3');

把t1和t2放到数组中,它们便是并行执行!同理,可以变出很多种组合来。

至于很多人问的和async的区别和优势,这不是一两句话解释的清楚的,设计理念不同,二者并不冲突,async在并发控制上面很优秀,而stepify则重在流程控制,里面也有简单的 parallel 支持。

可以看到,一个复杂的工作流,通过stepify定制,每一步都是那么清晰可读!

Stepify(node-stepify) 是一个简单易扩展的Node.js流程控制引擎,采用方法链(methods chain)的方式定制异步任务,使得Node.js工作流易于理解和维护。 目标是将复杂的任务进行拆分成多步完成,使得每一步的执行过程更加透明,化繁为简。 stepify特点 最基本的API的就3个:step(),done(),run(),简单容易理解。 精细的粒度划分(同时支持单/多任务),执行顺序可定制化。 每一个异步操作都经过特殊的封装,内部只需要关心这个异步的执行过程。 链式(chain)调用,代码逻辑看起来比较清晰。 灵活的回调函数定制和参数传递。 统一处理单个异步操作的异常,也可根据需要单独处理某个任务的异常。 最简单的用法 简单实现基于oauth2授权获取用户基本资料的例子: // Authorizing based on oauth2 workflowStepify()     .step('getCode', function(appId, rUri) {         var root = this;         request.get('[authorize_uri]', function(err, res, body) {             root.done(err, JSON.parse(body).code);         });     }, [appId], [redirectUri])     .step('getToken', function(code) {         var root = this;         request.post('[token_uri]', function(err, res, body) {             root.done(err, JSON.parse(body).access_token);         });     })     .step('getInfo', function(token) {         request.get('[info_uri]?token='\u00a0 \u00a0token,\u00a0function(err,\u00a0res,\u00a0body)\u00a0{\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0//\u00a0got\u00a0user\u00a0info,\u00a0pass\u00a0it\u00a0to\u00a0client\u00a0via\u00a0http\u00a0response\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0});\n\u00a0\u00a0\u00a0\u00a0})\n\u00a0\u00a0\u00a0\u00a0.run();\n\u591a\u4e2astep\u5171\u7528\u4e00\u4e2ahandle\u3001\u9759\u6001\u53c2\u6570\u3001\u52a8\u6001\u53c2\u6570\u4f20\u9012\u7684\u4f8b\u5b50\uff1a\nStepify()\n\u00a0\u00a0\u00a0\u00a0.step('read', __filename)     .step(function(buf) {         // buf is the buffer content of __filename         var root = this;         var writed = 'test.js';         // do more stuff with buf         // this demo just replace all spaces simply         buf = buf.toString().replace(/\s /g, '');         fs.writeFile(writed, buf, function(err) {             // writed is the name of target file,             // it will be passed into next step as the first argument             root.done(err, writed);         });     })     .
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值