Stage

Stage是流程实现类，非常核心的一个功能类。它负责执行一些流程定义，coc默认流程如下：

[
  "pageInfo",
  "matchRouter",
  "upload",
  "initHttpRequest",
  "handleInterceptor",
  "handleRouter",
  "requestProxy",
  "runTask",
  "getViewPath",
  "render",
  "response"
]

上面是各流程的stageName。stage提供的过滤器方法即是针对这些stageName使用，默认流程的stageName数组可以使用stage.stageNames获取。

具体流程的说明请看子章节。coc(app)执行之后返回一个stage实例，可使用以下api方法。

Stage提供的api如下：

stage.before(stageName, (req, res, nextStage) => {}): 前置过滤器方法。往默认流程插入自定义流程。

stage.after(stageName, (req, res, nextStage) => {}): 后置过滤器方法。往默认流程插入自定义流程。

stage.set(name, value): 设置一个属性。

stage.get(name): 获取一个属性。

stage.handle(req, res, next): 流程处理方法，核心方法。本质是一个express middleware。

before|after方法应该是调用者经常使用的方法。每个stage流程会有一些结果产出，可以用after对结果加工处理。

nextStage()是需要被执行的，否则无法流向下一个流程。除非在nextStage()前做了响应(res.send等)。

方法中的req, res是express req, res引用。

方法中的nextStage不是express next引用，而是express next的一个封装。通过nextStage.origin来获取express next引用。

所有流程方法的context this指向该stage实例引用（自定义流程若是箭头函数则例外）。

例子1、记录耗时日志：

const stage = coc(app);
stage.before('pageInfo', (req, res, next) => {
  req.startTime = Date.now();
  next();
});
stage.before('response', (req, res, next) => {
  const endTime = Date.now();
  const consume = endTime - req.startTime;
  console.log('consume times: ', consume, 'ms');
  next();
});

例子2、得到某些流程处理结果：

const stage = coc(app);
stage.after('handleRouter', (req, res, next) => {
  // 是否匹配到route
  console.log(req.router);
  next();
});
stage.after('getViewPath', (req, res, next) => {
  // 模板路径，后缀等信息
  console.log(res.viewPath, res.viewExt, res.viewFile);
  next();
});

例子3、接口统计信息：

const log = require('t-log');
const stage = coc(app);
stage.before('response', (req, res, next) => {
  // runTask或requestProxy流程产生apiInfo统计信息
  const apiInfo = res.apiInfo;

  Object.keys(apiInfo).map(name => {
    const info = apiInfo[name];
    return log.info(info.method, info.api, info.consumeTime, 'ms');
  });
  log.warn('cost time: ', req.reqCircle.end());

  next();
});